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 |
|---|---|---|---|---|---|---|---|---|
euroargodev/VirtualFleet | ef6cf5b8b206bf77f1641ccb6d3be5ce92e82654 | 2024-03-07T13:41:30 | schemas/VF-ArgoFloat-Configuration.json | 6 | 2024-05-28T04:35:12.470537Z | {
"$defs": {
"parameter": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A set of data documenting one parameter for a virtual Argo Float configuration",
"properties": {
"description": {
"type": "string"
},
"meta": {
"$ref": "#/$defs/parameter_metadata"
},
"name": {
"enum": [
"cycle_duration",
"life_expectancy",
"parking_depth",
"profile_depth",
"vertical_speed",
"area_cycle_duration",
"area_parking_depth",
"area_xmax",
"area_xmin",
"area_ymax",
"area_ymin"
],
"type": "string"
},
"value": {
"type": [
"string",
"number"
]
}
},
"required": [
"name",
"value"
],
"title": "VirtualFleet Argo Float configuration required parameter",
"type": "object"
},
"parameter_metadata": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"dtype": {
"enum": [
"float",
"int"
],
"type": "string"
},
"teckkey": {
"type": "string"
},
"unit": {
"type": "string"
}
},
"required": [],
"title": "Set of meta-data documenting one parameter for a virtual Argo Float configuration",
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/euroargodev/VirtualFleet/json-schemas-FloatConfiguration/schemas/VF-ArgoFloat-Configuration.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A set of data documenting a virtual Argo Float configuration to be used in a VirtualFleet simulation",
"format_version": {
"const": "2.0"
},
"properties": {
"created": {
"description": "UTC creation datetime of the configuration file",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Internal shortname of the configuration parameter set. Used to load a configuration JSON file with the 'FloatConfiguration' class.",
"type": "string"
},
"parameters": {
"allOf": [
{
"items": {
"$ref": "#/$defs/parameter"
}
}
],
"description": "List of virtual Argo floats configuration parameters",
"type": "array"
},
"version": {
"description": "Version name of the configuration parameter set",
"type": "string"
}
},
"required": [
"created",
"version",
"name",
"parameters"
],
"title": "VirtualFleet Argo Float configuration",
"type": "object"
} | Apache-2.0 | en |
ACCESS-NRI/ACCESS-OM2 | dd014705ee6e1b2e2866842e2bd4bc0f6c93106a | 2023-12-05T22:34:57 | config/versions.schema.json | 5 | 2024-05-27T06:10:50.308986Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A list of deployment targets that are supported",
"properties": {
"$schema": {
"type": "string"
},
"spack-config": {
"type": "string"
},
"spack-packages": {
"type": "string"
}
},
"required": [
"$schema",
"spack-packages",
"spack-config"
],
"title": "Deployment Environments",
"type": "object"
} | Apache-2.0 | en |
rxliuli/joplin-utils | 2600c518b87dbe6eb5bad8552f6bb51bd18852fe | 2023-01-07T11:47:26 | archives/joplin-blog/docs/joplinBlogSchema.json | 216 | 2024-05-28T03:18:38.831412Z | {
"$id": "https://raw.githubusercontent.com/rxliuli/joplin-utils/master/apps/joplin-blog/docs/joplinBlogSchema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Configuration file format of joplin-blog",
"properties": {
"joplinProfilePath": {
"description": "joplin personal folder",
"type": "string"
},
"language": {
"default": "en",
"description": "Local language",
"enum": [
"en",
"zhCN"
],
"type": "string"
},
"port": {
"default": 41184,
"description": "the port of the joplin web clipper, usually `41184`",
"type": "integer"
},
"rootPath": {
"default": ".",
"description": "hexo/vuepress directory, which should normally be `.`",
"type": "string"
},
"tag": {
"default": "blog",
"description": "joplin's blog tag",
"type": "string"
},
"token": {
"description": "joplin web clipper's token",
"type": "string"
},
"type": {
"description": "type of integrated blog",
"enum": [
"hexo",
"vuepress",
"docsify"
],
"type": "string"
}
},
"required": [
"type",
"token",
"tag",
"joplinProfilePath"
],
"title": "joplin-blog",
"type": "object"
} | MIT | en |
openstack/kayobe | 0c074431d032a04e7faf8e2f0758dc1321f49d32 | 2022-12-07T14:23:18 | ansible/roles/swap/files/schema.json | 65 | 2024-05-27T04:20:10.677954Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "List of swap files or devices",
"items": {
"oneOf": [
{
"description": "Swap file",
"properties": {
"path": {
"type": "string"
},
"size_mb": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"path",
"size_mb"
],
"type": "object"
},
{
"description": "Swap device",
"properties": {
"device": {
"type": "string"
}
},
"required": [
"device"
],
"type": "object"
}
]
},
"type": "array"
} | Apache-2.0 | en |
openstack/kayobe | db3f22d42d455bf669e63b1f89523eb036af840e | 2024-02-11T11:49:16 | ansible/roles/apt/files/auth_schema.json | 65 | 2024-05-27T04:20:10.677954Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "List of Apt auth configurations",
"items": {
"description": "Apt auth configuration",
"properties": {
"filename": {
"minLength": 1,
"type": "string"
},
"login": {
"minLength": 1,
"type": "string"
},
"machine": {
"minLength": 1,
"type": "string"
},
"password": {
"minLength": 1,
"type": "string"
}
},
"required": [
"machine",
"login",
"password",
"filename"
],
"type": "object"
},
"type": "array"
} | Apache-2.0 | en |
zchee/schema | 80f457d0283242275691fc7ef387fc3219615aa4 | 2020-08-29T06:37:58 | open-rpc.schema.json | 6 | 2024-05-29T08:59:17.166556Z | {
"$id": "https://raw.githubusercontent.com/open-rpc/meta-schema/master/schema.json",
"$schema": "https://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"contactObject": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"contentDescriptorObject": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"description": {
"type": "string"
},
"name": {
"minLength": 1,
"type": "string"
},
"required": {
"type": "boolean"
},
"schema": {
"$ref": "#/definitions/schema"
},
"summary": {
"type": "string"
}
},
"required": [
"name",
"schema"
],
"type": "object"
},
"errorObject": {
"additionalProperties": false,
"description": "Defines an application level error.",
"properties": {
"code": {
"description": "A Number that indicates the error type that occurred. This MUST be an integer. The error codes from and including -32768 to -32000 are reserved for pre-defined errors. These pre-defined errors SHOULD be assumed to be returned from any JSON-RPC api.",
"type": "integer"
},
"data": {
"description": "A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.)."
},
"message": {
"description": "A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.",
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"exampleObject": {
"patternProperties": {
"^x-": {}
},
"properties": {
"description": {
"type": "string"
},
"name": {
"minLength": 1,
"type": "string"
},
"summary": {
"type": "string"
},
"value": {}
},
"required": [
"name",
"value"
],
"type": "object"
},
"examplePairingObject": {
"properties": {
"description": {
"type": "string"
},
"name": {
"minLength": 1,
"type": "string"
},
"params": {
"items": {
"oneOf": [
{
"$ref": "#/definitions/exampleObject"
},
{
"$ref": "#/definitions/referenceObject"
}
]
},
"type": "array"
},
"result": {
"oneOf": [
{
"$ref": "#/definitions/exampleObject"
},
{
"$ref": "#/definitions/referenceObject"
}
]
}
},
"required": [
"name",
"params",
"result"
],
"type": "object"
},
"externalDocumentationObject": {
"additionalProperties": false,
"description": "information about external documentation",
"patternProperties": {
"^x-": {}
},
"properties": {
"description": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"infoObject": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"contact": {
"$ref": "#/definitions/contactObject"
},
"description": {
"type": "string"
},
"license": {
"$ref": "#/definitions/licenseObject"
},
"termsOfService": {
"format": "uri",
"type": "string"
},
"title": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"title",
"version"
],
"type": "object"
},
"licenseObject": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"linkObject": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"description": {
"type": "string"
},
"method": {
"type": "string"
},
"name": {
"minLength": 1,
"type": "string"
},
"params": {},
"server": {
"$ref": "#/definitions/serverObject"
},
"summary": {
"type": "string"
}
},
"type": "object"
},
"methodObject": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"description": {
"description": "A verbose explanation of the method behavior. GitHub Flavored Markdown syntax MAY be used for rich text representation.",
"type": "string"
},
"errors": {
"description": "Defines an application level error.",
"items": {
"oneOf": [
{
"$ref": "#/definitions/errorObject"
},
{
"$ref": "#/definitions/referenceObject"
}
]
},
"type": "array"
},
"examples": {
"items": {
"oneOf": [
{
"$ref": "#/definitions/examplePairingObject"
},
{
"$ref": "#/definitions/referenceObject"
}
]
},
"type": "array"
},
"links": {
"items": {
"oneOf": [
{
"$ref": "#/definitions/linkObject"
},
{
"$ref": "#/definitions/referenceObject"
}
]
},
"type": "array"
},
"name": {
"description": "The cannonical name for the method. The name MUST be unique within the methods array.",
"minLength": 1,
"type": "string"
},
"paramStructure": {
"default": "by-position",
"description": "Format the server expects the params. Defaults to 'by-positon'.",
"enum": [
"by-position",
"by-name"
],
"type": "string"
},
"params": {
"items": {
"oneOf": [
{
"$ref": "#/definitions/contentDescriptorObject"
},
{
"$ref": "#/definitions/referenceObject"
}
]
},
"type": "array"
},
"result": {
"oneOf": [
{
"$ref": "#/definitions/contentDescriptorObject"
},
{
"$ref": "#/definitions/referenceObject"
}
]
},
"summary": {
"description": "A short summary of what the method does.",
"type": "string"
},
"tags": {
"items": {
"oneOf": [
{
"$ref": "#/definitions/tagObject"
},
{
"$ref": "#/definitions/referenceObject"
}
]
},
"type": "array"
}
},
"required": [
"name",
"result",
"params"
],
"type": "object"
},
"referenceObject": {
"additionalProperties": false,
"properties": {
"$ref": {
"format": "uri-reference",
"type": "string"
}
},
"required": [
"$ref"
],
"type": "object"
},
"schema": {
"$ref": "https://json-schema.org/draft-07/schema#",
"default": {}
},
"serverObject": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"summary": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
},
"variables": {
"patternProperties": {
"[0-z]+": {
"properties": {
"default": {
"type": "string"
},
"description": {
"type": "string"
},
"enum": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"default"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"url"
],
"type": "object"
},
"tagObject": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"description": {
"type": "string"
},
"externalDocs": {
"$ref": "#/definitions/externalDocumentationObject"
},
"name": {
"minLength": 1,
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
},
"properties": {
"components": {
"properties": {
"contentDescriptors": {
"patternProperties": {
"[0-z]+": {
"oneOf": [
{
"$ref": "#/definitions/contentDescriptorObject"
},
{
"$ref": "#/definitions/referenceObject"
}
]
}
},
"type": "object"
},
"examplePairings": {
"patternProperties": {
"[0-z]+": {
"$ref": "#/definitions/examplePairingObject"
}
},
"type": "object"
},
"examples": {
"patternProperties": {
"[0-z]+": {
"$ref": "#/definitions/exampleObject"
}
},
"type": "object"
},
"links": {
"patternProperties": {
"[0-z]+": {
"$ref": "#/definitions/linkObject"
}
},
"type": "object"
},
"schemas": {
"patternProperties": {
"[0-z]+": {
"$ref": "#/definitions/schema"
}
},
"type": "object"
},
"tags": {
"patternProperties": {
"[0-z]+": {
"$ref": "#/definitions/tagObject"
}
},
"type": "object"
}
},
"type": "object"
},
"info": {
"$ref": "#/definitions/infoObject"
},
"methods": {
"additionalItems": false,
"items": {
"$ref": "#/definitions/methodObject"
},
"type": "array"
},
"openrpc": {
"enum": [
"GENERATED FIELD: Do Not Edit"
],
"type": "string"
},
"servers": {
"additionalItems": false,
"items": {
"$ref": "#/definitions/serverObject"
},
"type": "array"
}
},
"required": [
"info",
"methods",
"openrpc"
],
"type": "object"
} | BSD-3-Clause | en |
nano-byte/helm-charts | dc4a7dd8bbbc514794a500dc72a4e6165a04b0ab | 2024-01-10T16:27:53 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"createLokiRule": {
"default": true,
"description": "Whether to create a LokiRule CR for log alerting or not.",
"type": "boolean"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
},
"lokiConfigMap": {
"additionalProperties": false,
"properties": {
"label": {
"default": "loki_rule",
"description": "The label attached to the ConfigMap holding the Loki Rules.",
"type": "string"
},
"labelValue": {
"default": "",
"description": "The value of the label attached to the Loki Rule ConfigMap.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | abfb3092e58ca03932a18d91ca83417fa76a74cb | 2024-05-04T09:02:00 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"createLokiRule": {
"default": false,
"description": "Whether to create a LokiRule CR for log alerting or not.",
"type": "boolean"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
},
"lokiConfigMap": {
"additionalProperties": false,
"properties": {
"label": {
"default": "loki_rule",
"description": "The label attached to the ConfigMap holding the Loki Rules.",
"type": "string"
},
"labelValue": {
"default": "",
"description": "The value of the label attached to the Loki Rule ConfigMap.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
},
"restarts": {
"properties": {
"enabled": {
"default": true,
"description": "Deploys Prometheus alert rule for unexpected container restarts",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alertLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"queryVariables": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional variables to be used in the to parametrize the service's Grafana dashboard",
"type": "object"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress or VirtualService resource",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
},
"secretNamespace": {
"description": "The Kubernetes namespace containing the Secret (only applicable if class is contour)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
},
"secretNamespace": {
"description": "The Kubernetes namespace containing the Secret (only applicable if ingress.class is contour)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"initContainerTemplates": {
"description": "Strings to be templated providing additional init containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"initContainers": {
"description": "Additional init containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"revisionHistoryLimit": {
"description": "Number of old ReplicaSets to retain (rollout.controller must be Deployment or ArgoRollout)",
"type": [
"integer",
"null"
]
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | 7673d2110644951b0e88c9b6142ef41c95c38aff | 2023-07-10T09:55:13 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port (e.g., http or grpc)",
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if `ingress.istio.enabled`)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"grpc",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service",
"items": {
"type": "string"
},
"type": "array"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"enforceReplicaSpread": {
"default": false,
"description": "Make even spread of replicas across nodes mandatory",
"type": "boolean"
},
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | 5faac4c331d99d6c3d8a61dad6360e9bf0a58fc1 | 2024-03-27T09:41:09 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"createLokiRule": {
"default": false,
"description": "Whether to create a LokiRule CR for log alerting or not.",
"type": "boolean"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
},
"lokiConfigMap": {
"additionalProperties": false,
"properties": {
"label": {
"default": "loki_rule",
"description": "The label attached to the ConfigMap holding the Loki Rules.",
"type": "string"
},
"labelValue": {
"default": "",
"description": "The value of the label attached to the Loki Rule ConfigMap.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
},
"restarts": {
"properties": {
"enabled": {
"default": true,
"description": "Deploys Prometheus alert rule for unexpected container restarts",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"queryVariables": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional variables to be used in the to parametrize the service's Grafana dashboard",
"type": "object"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"initContainerTemplates": {
"description": "Strings to be templated providing additional init containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"initContainers": {
"description": "Additional init containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | 216cbd58a061ff22e7a942ff4d9b10ba9c7fa100 | 2023-07-03T09:36:30 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port (e.g., http or grpc)",
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if `ingress.istio.enabled`)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"grpc",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service",
"items": {
"type": "string"
},
"type": "array"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"enforceReplicaSpread": {
"default": false,
"description": "Make even spread of replicas across nodes mandatory",
"type": "boolean"
},
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | fdb583b518164c548e62f778120dcbb0dd504e92 | 2024-03-27T09:42:53 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"createLokiRule": {
"default": false,
"description": "Whether to create a LokiRule CR for log alerting or not.",
"type": "boolean"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
},
"lokiConfigMap": {
"additionalProperties": false,
"properties": {
"label": {
"default": "loki_rule",
"description": "The label attached to the ConfigMap holding the Loki Rules.",
"type": "string"
},
"labelValue": {
"default": "",
"description": "The value of the label attached to the Loki Rule ConfigMap.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
},
"restarts": {
"properties": {
"enabled": {
"default": true,
"description": "Deploys Prometheus alert rule for unexpected container restarts",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"queryVariables": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional variables to be used in the to parametrize the service's Grafana dashboard",
"type": "object"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
},
"secretNamespace": {
"description": "The Kubernetes namespace containing the Secret (only applicable if class is contour)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
},
"secretNamespace": {
"description": "The Kubernetes namespace containing the Secret (only applicable if ingress.class is contour)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"initContainerTemplates": {
"description": "Strings to be templated providing additional init containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"initContainers": {
"description": "Additional init containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | b34805928868f9574d4efe871f844fbd0209c824 | 2023-07-04T14:25:29 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port (e.g., http or grpc)",
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if `ingress.istio.enabled`)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"grpc",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service",
"items": {
"type": "string"
},
"type": "array"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"enforceReplicaSpread": {
"default": false,
"description": "Make even spread of replicas across nodes mandatory",
"type": "boolean"
},
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | 993acc6a8fda782563357804e9535cb2e47ab365 | 2024-04-16T16:05:36 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"createLokiRule": {
"default": false,
"description": "Whether to create a LokiRule CR for log alerting or not.",
"type": "boolean"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
},
"lokiConfigMap": {
"additionalProperties": false,
"properties": {
"label": {
"default": "loki_rule",
"description": "The label attached to the ConfigMap holding the Loki Rules.",
"type": "string"
},
"labelValue": {
"default": "",
"description": "The value of the label attached to the Loki Rule ConfigMap.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
},
"restarts": {
"properties": {
"enabled": {
"default": true,
"description": "Deploys Prometheus alert rule for unexpected container restarts",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"queryVariables": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional variables to be used in the to parametrize the service's Grafana dashboard",
"type": "object"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress or VirtualService resource",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
},
"secretNamespace": {
"description": "The Kubernetes namespace containing the Secret (only applicable if class is contour)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
},
"secretNamespace": {
"description": "The Kubernetes namespace containing the Secret (only applicable if ingress.class is contour)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"initContainerTemplates": {
"description": "Strings to be templated providing additional init containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"initContainers": {
"description": "Additional init containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"revisionHistoryLimit": {
"description": "Number of old ReplicaSets to retain (rollout.controller must be Deployment or ArgoRollout)",
"type": [
"integer",
"null"
]
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | cc5bf40d4ef6ac9c68cba07f7c511cceef595998 | 2024-03-26T08:41:56 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"createLokiRule": {
"default": false,
"description": "Whether to create a LokiRule CR for log alerting or not.",
"type": "boolean"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
},
"lokiConfigMap": {
"additionalProperties": false,
"properties": {
"label": {
"default": "loki_rule",
"description": "The label attached to the ConfigMap holding the Loki Rules.",
"type": "string"
},
"labelValue": {
"default": "",
"description": "The value of the label attached to the Loki Rule ConfigMap.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
},
"restarts": {
"properties": {
"enabled": {
"default": true,
"description": "Deploys Prometheus alert rule for unexpected container restarts",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"queryVariables": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional variables to be used in the to parametrize the service's Grafana dashboard",
"type": "object"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"initContainerTemplates": {
"description": "Strings to be templated providing additional init containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"initContainers": {
"description": "Additional init containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | fcc54bad87dd8c5b8e681918973fb117bb01cb92 | 2023-08-29T08:42:59 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port (e.g., http or grpc)",
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if `ingress.istio.enabled`)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"grpc",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service",
"items": {
"type": "string"
},
"type": "array"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | ac8a927dd80c257ecca37e60e490ed81b2a87599 | 2023-11-27T10:17:42 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port (e.g., http or grpc)",
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if `ingress.istio.enabled`)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"grpc",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | 5a38a837541c32605fbb30df2deaf3bea48d5506 | 2024-04-25T11:31:46 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"createLokiRule": {
"default": false,
"description": "Whether to create a LokiRule CR for log alerting or not.",
"type": "boolean"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
},
"lokiConfigMap": {
"additionalProperties": false,
"properties": {
"label": {
"default": "loki_rule",
"description": "The label attached to the ConfigMap holding the Loki Rules.",
"type": "string"
},
"labelValue": {
"default": "",
"description": "The value of the label attached to the Loki Rule ConfigMap.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
},
"restarts": {
"properties": {
"enabled": {
"default": true,
"description": "Deploys Prometheus alert rule for unexpected container restarts",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alertLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"queryVariables": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional variables to be used in the to parametrize the service's Grafana dashboard",
"type": "object"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress or VirtualService resource",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
},
"secretNamespace": {
"description": "The Kubernetes namespace containing the Secret (only applicable if class is contour)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
},
"secretNamespace": {
"description": "The Kubernetes namespace containing the Secret (only applicable if ingress.class is contour)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"initContainerTemplates": {
"description": "Strings to be templated providing additional init containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"initContainers": {
"description": "Additional init containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"revisionHistoryLimit": {
"description": "Number of old ReplicaSets to retain (rollout.controller must be Deployment or ArgoRollout)",
"type": [
"integer",
"null"
]
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | d7aa745662805bb4921235317b49f8cd982dcaa0 | 2024-01-17T11:00:53 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"createLokiRule": {
"default": false,
"description": "Whether to create a LokiRule CR for log alerting or not.",
"type": "boolean"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
},
"lokiConfigMap": {
"additionalProperties": false,
"properties": {
"label": {
"default": "loki_rule",
"description": "The label attached to the ConfigMap holding the Loki Rules.",
"type": "string"
},
"labelValue": {
"default": "",
"description": "The value of the label attached to the Loki Rule ConfigMap.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
},
"restarts": {
"properties": {
"enabled": {
"default": true,
"description": "Deploys Prometheus alert rule for unexpected container restarts",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"queryVariables": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional variables to be used in the to parametrize the service's Grafana dashboard",
"type": "object"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | 8b92ee91e4e36d1ad22e4afcd71d86aa2a489600 | 2024-01-03T10:07:17 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"grpc",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"grpc",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | 82a9dce129106ded5f3c7c31c3cbba140cbe8dab | 2024-03-26T08:41:56 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"createLokiRule": {
"default": false,
"description": "Whether to create a LokiRule CR for log alerting or not.",
"type": "boolean"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
},
"lokiConfigMap": {
"additionalProperties": false,
"properties": {
"label": {
"default": "loki_rule",
"description": "The label attached to the ConfigMap holding the Loki Rules.",
"type": "string"
},
"labelValue": {
"default": "",
"description": "The value of the label attached to the Loki Rule ConfigMap.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
},
"restarts": {
"properties": {
"enabled": {
"default": true,
"description": "Deploys Prometheus alert rule for unexpected container restarts",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"queryVariables": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional variables to be used in the to parametrize the service's Grafana dashboard",
"type": "object"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"initContainerTemplates": {
"description": "Strings to be templated providing additional init containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"initContainers": {
"description": "Additional init containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | 46838caf3aa5ecf97623fb212db95665e1c80e30 | 2023-07-07T14:48:35 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"metricLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to use for filtering the metric",
"type": "object"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port (e.g., http or grpc)",
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if `ingress.istio.enabled`)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"grpc",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service",
"items": {
"type": "string"
},
"type": "array"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"enforceReplicaSpread": {
"default": false,
"description": "Make even spread of replicas across nodes mandatory",
"type": "boolean"
},
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | 8969118963ec3213b109894ce8fb7f5beac0da74 | 2024-04-29T14:53:18 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"createLokiRule": {
"default": false,
"description": "Whether to create a LokiRule CR for log alerting or not.",
"type": "boolean"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
},
"lokiConfigMap": {
"additionalProperties": false,
"properties": {
"label": {
"default": "loki_rule",
"description": "The label attached to the ConfigMap holding the Loki Rules.",
"type": "string"
},
"labelValue": {
"default": "",
"description": "The value of the label attached to the Loki Rule ConfigMap.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
},
"restarts": {
"properties": {
"enabled": {
"default": true,
"description": "Deploys Prometheus alert rule for unexpected container restarts",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alertLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"queryVariables": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional variables to be used in the to parametrize the service's Grafana dashboard",
"type": "object"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress or VirtualService resource",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"number",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
},
"secretNamespace": {
"description": "The Kubernetes namespace containing the Secret (only applicable if class is contour)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"number",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
},
"secretNamespace": {
"description": "The Kubernetes namespace containing the Secret (only applicable if ingress.class is contour)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"initContainerTemplates": {
"description": "Strings to be templated providing additional init containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"initContainers": {
"description": "Additional init containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"revisionHistoryLimit": {
"description": "Number of old ReplicaSets to retain (rollout.controller must be Deployment or ArgoRollout)",
"type": [
"integer",
"null"
]
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | e2e430e401ef6926dc3a9d3862d3e84faefdd22e | 2024-05-10T10:14:35 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"createLokiRule": {
"default": false,
"description": "Whether to create a LokiRule CR for log alerting or not.",
"type": "boolean"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
},
"lokiConfigMap": {
"additionalProperties": false,
"properties": {
"label": {
"default": "loki_rule",
"description": "The label attached to the ConfigMap holding the Loki Rules.",
"type": "string"
},
"labelValue": {
"default": "",
"description": "The value of the label attached to the Loki Rule ConfigMap.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
},
"restarts": {
"properties": {
"enabled": {
"default": true,
"description": "Deploys Prometheus alert rule for unexpected container restarts",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alertLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"queryVariables": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional variables to be used in the to parametrize the service's Grafana dashboard",
"type": "object"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress or VirtualService resource",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"portRef": {
"description": "Reference to the name of another extra ingress to share its container port",
"type": "string"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
},
"secretNamespace": {
"description": "The Kubernetes namespace containing the Secret (only applicable if class is contour)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
},
"secretNamespace": {
"description": "The Kubernetes namespace containing the Secret (only applicable if ingress.class is contour)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"initContainerTemplates": {
"description": "Strings to be templated providing additional init containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"initContainers": {
"description": "Additional init containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"revisionHistoryLimit": {
"description": "Number of old ReplicaSets to retain (rollout.controller must be Deployment or ArgoRollout)",
"type": [
"integer",
"null"
]
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | cf703b419fe2406352e7c8a51c57a4217a555b60 | 2024-01-15T16:35:17 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"createLokiRule": {
"default": false,
"description": "Whether to create a LokiRule CR for log alerting or not.",
"type": "boolean"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
},
"lokiConfigMap": {
"additionalProperties": false,
"properties": {
"label": {
"default": "loki_rule",
"description": "The label attached to the ConfigMap holding the Loki Rules.",
"type": "string"
},
"labelValue": {
"default": "",
"description": "The value of the label attached to the Loki Rule ConfigMap.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | 03ad242a4619f4a1818ad7638f3fcdb74951cfa4 | 2024-04-16T15:51:22 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"createLokiRule": {
"default": false,
"description": "Whether to create a LokiRule CR for log alerting or not.",
"type": "boolean"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
},
"lokiConfigMap": {
"additionalProperties": false,
"properties": {
"label": {
"default": "loki_rule",
"description": "The label attached to the ConfigMap holding the Loki Rules.",
"type": "string"
},
"labelValue": {
"default": "",
"description": "The value of the label attached to the Loki Rule ConfigMap.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
},
"restarts": {
"properties": {
"enabled": {
"default": true,
"description": "Deploys Prometheus alert rule for unexpected container restarts",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"queryVariables": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional variables to be used in the to parametrize the service's Grafana dashboard",
"type": "object"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
},
"secretNamespace": {
"description": "The Kubernetes namespace containing the Secret (only applicable if class is contour)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
},
"secretNamespace": {
"description": "The Kubernetes namespace containing the Secret (only applicable if ingress.class is contour)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"initContainerTemplates": {
"description": "Strings to be templated providing additional init containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"initContainers": {
"description": "Additional init containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"revisionHistoryLimit": {
"description": "Number of old ReplicaSets to retain (rollout.controller must be Deployment or ArgoRollout)",
"type": [
"integer",
"null"
]
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | ee06bc91e5d2bb449eb8da8d631f5b14466fd48a | 2023-08-29T08:42:59 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port (e.g., http or grpc)",
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if `ingress.istio.enabled`)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"grpc",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service",
"items": {
"type": "string"
},
"type": "array"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | 5c333a5a320ce464962e1ab4d609e756094cc395 | 2023-11-21T20:42:51 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port (e.g., http or grpc)",
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if `ingress.istio.enabled`)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"grpc",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | 5c76c8fb62d77cc0e3a5bbaf951c760f5c19c6ae | 2023-07-03T09:36:45 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port (e.g., http or grpc)",
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if `ingress.istio.enabled`)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"grpc",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service",
"items": {
"type": "string"
},
"type": "array"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"enforceReplicaSpread": {
"default": false,
"description": "Make even spread of replicas across nodes mandatory",
"type": "boolean"
},
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | 812bf0c39c44b59f61da018f4865691113b19ee1 | 2024-02-02T11:07:53 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"createLokiRule": {
"default": false,
"description": "Whether to create a LokiRule CR for log alerting or not.",
"type": "boolean"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
},
"lokiConfigMap": {
"additionalProperties": false,
"properties": {
"label": {
"default": "loki_rule",
"description": "The label attached to the ConfigMap holding the Loki Rules.",
"type": "string"
},
"labelValue": {
"default": "",
"description": "The value of the label attached to the Loki Rule ConfigMap.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
},
"restarts": {
"properties": {
"enabled": {
"default": true,
"description": "Deploys Prometheus alert rule for unexpected container restarts",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"queryVariables": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional variables to be used in the to parametrize the service's Grafana dashboard",
"type": "object"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"initContainerTemplates": {
"description": "Strings to be templated providing additional init containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"initContainers": {
"description": "Additional init containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | 99024e455e4e6e3fad4d122396670cfbc39c83a7 | 2023-11-13T13:13:35 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port (e.g., http or grpc)",
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if `ingress.istio.enabled`)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"grpc",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | bd4c8269000b35701549fcaf38690cba5a518f10 | 2023-08-29T08:33:47 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port (e.g., http or grpc)",
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if `ingress.istio.enabled`)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"grpc",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service",
"items": {
"type": "string"
},
"type": "array"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | 03660d132d247f210ff2fb30e320cee84a173e1f | 2024-01-03T10:21:29 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | 9d8a9b78de6e6f9d9afabf1b7b894cfbf6f9eafa | 2024-01-17T11:00:53 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"createLokiRule": {
"default": false,
"description": "Whether to create a LokiRule CR for log alerting or not.",
"type": "boolean"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
},
"lokiConfigMap": {
"additionalProperties": false,
"properties": {
"label": {
"default": "loki_rule",
"description": "The label attached to the ConfigMap holding the Loki Rules.",
"type": "string"
},
"labelValue": {
"default": "",
"description": "The value of the label attached to the Loki Rule ConfigMap.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"queryVariables": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional variables to be used in the to parametrize the service's Grafana dashboard",
"type": "object"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | 4243248b3c74097fdb563f28e9e329b460254e09 | 2024-05-13T08:36:52 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"errorDuration": {
"default": "",
"description": "The duration for which the gRPC error rate has to remain elevated before triggering an alert",
"type": "string"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"logs": {
"additionalProperties": false,
"properties": {
"countInterval": {
"default": "5m",
"description": "The time interval in which to count the number of messages per log level",
"type": "string"
},
"createLokiRule": {
"default": false,
"description": "Whether to create a LokiRule CR for log alerting or not.",
"type": "boolean"
},
"levelLabel": {
"default": "level",
"description": "The Loki label containing the log level",
"type": "string"
},
"levels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"maxCount": {
"default": 0,
"description": "The maximum number of messages in the interval to allow before alerting",
"type": "integer"
},
"severity": {
"default": "warning",
"description": "The severity of the alert when the maximum count of a messages is exceeded",
"type": "string"
}
},
"type": "object"
},
"description": "Alerts for messages of specific log levels",
"type": "object"
},
"lokiConfigMap": {
"additionalProperties": false,
"properties": {
"label": {
"default": "loki_rule",
"description": "The label attached to the ConfigMap holding the Loki Rules.",
"type": "string"
},
"labelValue": {
"default": "",
"description": "The value of the label attached to the Loki Rule ConfigMap.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
},
"restarts": {
"properties": {
"enabled": {
"default": true,
"description": "Deploys Prometheus alert rule for unexpected container restarts",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"dnsConfig": {
"description": "DNS config for the pod (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/",
"properties": {
"nameservers": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"searches": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"env": {
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alertLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"queryVariables": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional variables to be used in the to parametrize the service's Grafana dashboard",
"type": "object"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress or VirtualService resource",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"portRef": {
"description": "Reference to the name of another extra ingress to share its container port",
"type": "string"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
},
"secretNamespace": {
"description": "The Kubernetes namespace containing the Secret (only applicable if class is contour)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if ingress.istio.enabled)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"h2c",
"grpc",
"http2",
"h2",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service; -1 for infinite",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
},
"secretNamespace": {
"description": "The Kubernetes namespace containing the Secret (only applicable if ingress.class is contour)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"initContainerTemplates": {
"description": "Strings to be templated providing additional init containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"initContainers": {
"description": "Additional init containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"revisionHistoryLimit": {
"description": "Number of old ReplicaSets to retain (rollout.controller must be Deployment or ArgoRollout)",
"type": [
"integer",
"null"
]
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"insecure": {
"default": true,
"description": "By default if tracing is enabled, a sidecar is injected without TLS. Set this to false, if the sidecar serves the tracing endpoints via TLS.",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
nano-byte/helm-charts | b8844b17fbbe3a3510b602a075778d7262382228 | 2023-08-29T10:24:49 | charts/generic-service/values.schema.json | 11 | 2024-05-28T04:06:34.420819Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"additionalConfigs": {
"description": "Additional ConfigMaps with key named data.yaml to be mounted (paths appended to $CONFIG_FILE)",
"items": {
"type": "string"
},
"type": "array"
},
"additionalMounts": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the volume",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"description": "A map of mount paths inside the container to volumes",
"type": "object"
},
"alerting": {
"properties": {
"additionalProperties": false,
"cpu": {
"additionalProperties": false,
"properties": {
"maxThrottleFactor": {
"default": 0.01,
"description": "The maximum fraction of the container's execution time during which it experiences CPU throttling",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.cpu to determine minimum allowed unused CPU quota in namespace",
"minimum": 0,
"type": "number"
},
"sampleInterval": {
"default": "1m",
"description": "The time interval in which to measure CPU usage",
"type": "string"
}
},
"type": "object"
},
"custom": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "The aggregate function to use to combine metric values from multiple replicas (e.g., max or sum)",
"type": "string"
},
"averageOver": {
"description": "A sliding window in which to calculate the average value of the metric (e.g., 10m)",
"type": "string"
},
"description": {
"description": "A longer description of the alert; can include metric labels via templating",
"type": "string"
},
"increaseOver": {
"description": "A sliding window in which to calculate the increase of the metric (e.g., 10m)",
"type": "string"
},
"labelMatchers": {
"description": "Prometheus label matchers to use for filtering the metric (e.g., some_key=\"some_value\")",
"type": "string"
},
"metric": {
"description": "The name of the Prometheus metric exposed by the service",
"type": "string"
},
"predicate": {
"description": "An expression that triggers the alert when the metric fulfills it",
"type": "string"
},
"round": {
"default": false,
"description": "Round the result before evaluating the predicate",
"type": "boolean"
},
"severity": {
"default": "warning",
"description": "The severity of the alert",
"type": "string"
},
"summary": {
"description": "A short summary of the alert",
"type": "string"
},
"topic": {
"description": "An optional topic label for the alert",
"type": "string"
}
},
"required": [
"metric",
"aggregate",
"predicate",
"summary",
"description"
],
"type": "object"
},
"description": "Additional alerts based on Prometheus metrics exposed by the service",
"type": "object"
},
"enabled": {
"default": false,
"description": "Deploys Prometheus alert rule for issues like like unavailable pods or high memory use",
"type": "boolean"
},
"grpc": {
"additionalProperties": false,
"properties": {
"criticalCodes": {
"default": [
"Internal",
"Unimplemented"
],
"description": "Which gRPC status codes are considered critical errors",
"items": {
"type": "string"
},
"type": "array"
},
"maxCriticalErrors": {
"default": 0,
"description": "The maximum number of critical gRPC errors responses in the sample interval",
"type": "integer"
},
"maxErrorRatio": {
"default": 2.5,
"description": "The maximum gRPC error ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"requestsMetric": {
"default": "grpc_server_handled_total",
"description": "The name of the Prometheus metric counting gRPC requests",
"type": "string"
},
"sampleInterval": {
"default": "15m",
"description": "The time interval in which to measure gRPC responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"http": {
"additionalProperties": false,
"properties": {
"max4xxRatio": {
"default": 2.5,
"description": "The maximum HTTP 4xx ratio increase in the sample interval compared to the reference interval",
"type": "number"
},
"max5xxCount": {
"default": 0,
"description": "The maximum number of HTTP 5xx responses in the sample interval",
"type": "number"
},
"maxSlowdown": {
"default": 2.5,
"description": "The maximum HTTP response slowdown in the sample interval compared to the reference interval",
"type": "number"
},
"referenceInterval": {
"default": "1w",
"description": "The time interval to to compare with the sample interval to detect changes",
"type": "string"
},
"sampleInterval": {
"default": "20m",
"description": "The time interval in which to measure HTTP responses for triggering alerts",
"type": "string"
}
},
"type": "object"
},
"memory": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"description": "Enables alerts relating to memory usage",
"type": "boolean"
},
"maxUsageFactor": {
"default": 0.9,
"description": "The maximum usage factor of the memory limit",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"quotaBufferFactor": {
"default": 1,
"description": "Multiplied with resources.*.memory to determine minimum allowed unused memory quota in namespace",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pod": {
"additionalProperties": false,
"properties": {
"maxAgeSeconds": {
"description": "The maximum allowed age of a Pod in seconds (useful to ensure regular deployments)",
"type": [
"integer",
"null"
]
},
"maxStartupSeconds": {
"default": 120,
"description": "The maximum amount of time a Pod is allowed to take for startup",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to set on the Pod controller and Pods",
"type": "object"
},
"args": {
"description": "The command-line arguments passed to the service",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"description": "Scaling behavior configuration (see HorizontalPodAutoscalerBehavior)",
"type": "object"
},
"enabled": {
"default": false,
"description": "Enables automatic starting of additional instances",
"type": "boolean"
},
"maxReplicas": {
"default": 3,
"description": "The maximum number of instances to run (must be larger than replicas)",
"type": "integer"
},
"metric": {
"properties": {
"name": {
"default": "cpu",
"description": "The name of the metric to use for scaling",
"type": "string"
},
"object": {
"description": "Reference to the Kubernetes object the metric describes (required if type = Object)",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name"
],
"type": [
"object",
"null"
]
},
"selector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for selecting the metric",
"type": "object"
},
"type": {
"default": "Resource",
"description": "The type of metric to use for scaling",
"enum": [
"Resource",
"Pods",
"Object",
"External"
],
"type": "string"
}
},
"type": "object"
},
"targetValue": {
"default": 80,
"description": "The desired value of the metric to achieve through scaling (e.g., CPU utilization in percent)",
"type": "integer"
}
},
"type": "object"
},
"command": {
"description": "Overrides the command to launch in the image",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "YAML/JSON configuration to be mounted as a file in the container",
"type": "object"
},
"configMountPath": {
"default": "/config/config.yaml",
"description": "The file path in the container to mount the data from config into (exposed via $CONFIG_FILE)",
"type": "string"
},
"env": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables passed to the service as a key-value map",
"type": "object"
},
"envFrom": {
"additionalProperties": {
"properties": {
"configMapKeyRef": {
"type": "object"
},
"fieldRef": {
"type": "object"
},
"resourceFieldRef": {
"type": "object"
},
"secretKeyRef": {
"type": "object"
}
},
"type": "object"
},
"description": "Environment variables passed to the service from other sources (e.g., secretKeyRef)",
"type": "object"
},
"fullname": {
"description": "The name of the service instance (used for resource names and app.kubernetes.io/instance label)",
"type": "string"
},
"global": {
"properties": {
"alerting": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to apply to alert rules",
"type": "object"
}
},
"type": "object"
},
"grafana": {
"properties": {
"dashboard": {
"default": "qqsCbY5Zz",
"description": "The UID of the Grafana dashboard visualizing the service's metrics",
"type": "string"
},
"url": {
"description": "The URL of a Grafana instance with access to the service's metrics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "IfNotPresent",
"description": "Set to Always to try to pull new versions of the image",
"enum": [
"Never",
"IfNotPresent",
"Always"
],
"type": "string"
},
"pullSecret": {
"description": "Name of the Kubernetes Secret providing credentials for pulling the image",
"type": "string"
},
"registry": {
"default": "docker.io",
"description": "The Registry containing the image to run",
"type": "string"
},
"repository": {
"description": "The name of the image image to run (without the Registry)",
"type": "string"
},
"tag": {
"description": "The tag of the image to run; start with @ for digest instead of tag (e.g., @sha256:abc...)",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"additionalSelectors": {
"additionalProperties": {
"type": "string"
},
"description": "Additional label selectors used to restrict the Pods selected by the Service.",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations for Ingress resource (not applicable if ingress.istio.enabled)",
"type": "object"
},
"class": {
"description": "The ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"cors": {
"additionalProperties": false,
"properties": {
"allowCredentials": {
"default": true,
"description": "Indicates whether the caller is allowed to send the actual request (not the preflight) using credentials",
"type": "boolean"
},
"allowHeaders": {
"default": [
"Content-Type"
],
"description": "List of HTTP headers that can be used when requesting the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"default": [
"GET"
],
"description": "List of HTTP methods allowed to access the ingress via CORS",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigin": {
"description": "List of origins allowed to access the ingress via CORS; leave empty to allow any",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables CORS (only applicable if ingress.class is 'nginx' or ingress.istio.enabled is true)",
"type": "boolean"
},
"exposeHeaders": {
"description": "List of HTTP headers that the browsers are allowed to access",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"domains": {
"description": "The public domain names under which the service is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables ingress into the service (either cluster-internal or public)",
"type": "boolean"
},
"extra": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations, merged with ingress.annotations (use string 'nil' to unset existing values)",
"type": "object"
},
"class": {
"description": "Additional ingress controller to use (not applicable if ingress.istio.enabled)",
"type": "string"
},
"domains": {
"description": "The public domain names under which the port is exposed (leave empty for cluster-internal only)",
"items": {
"type": "string"
},
"type": "array"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "The container port ingress traffic is routed to; defaults to value of ingress.port if not set",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The protocol used for the port (e.g., http or grpc)",
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress",
"type": "boolean"
},
"secret": {
"description": "The name of the Secret holding the TLS private key",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Additional container ports ingress traffic is routed to (not applicable if `ingress.istio.enabled`)",
"type": "object"
},
"headless": {
"default": false,
"description": "Creates an additional Service with the suffix '-headless' that directly exposes Pod IPs",
"type": "boolean"
},
"headlessExposesAll": {
"default": false,
"description": "Exposes all replicas, including unready ones, via the '-headless' Service",
"type": "boolean"
},
"istio": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Istio VirtualService instead of Kubernetes Ingress resource",
"type": "boolean"
},
"gateways": {
"description": "The names of the Istio Gateways to use",
"items": {
"type": "string"
},
"type": "array"
},
"httpHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Custom HTTP response headers",
"type": "object"
},
"retries": {
"description": "Istio retry policy (see https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRetry)",
"type": "object"
}
},
"type": "object"
},
"nodeLocal": {
"default": false,
"description": "Creates an additional Service with the suffix '-local' that only routes to pods on the same node",
"type": "boolean"
},
"paths": {
"description": "HTTP path prefixes to accept ingress traffic for (leave empty to accept traffic for any path)",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 80,
"description": "The container port ingress traffic is routed to",
"type": "integer"
},
"protocol": {
"default": "http",
"description": "The internal protocol used for ingress",
"enum": [
"http",
"https",
"grpc",
"grpcs"
],
"type": "string"
},
"timeoutSeconds": {
"description": "Number of seconds after which to timeout waiting for response from service",
"type": [
"integer",
"null"
]
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Enables TLS termination at the ingress (not applicable if ingress.istio.enabled)",
"type": "boolean"
},
"secret": {
"default": "{{ .Release.Name }}-tls",
"description": "The name of the Secret holding the TLS private key (not applicable if ingress.istio.enabled)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to set on all generated resources",
"type": "object"
},
"livenessProbe": {
"additionalProperties": true,
"description": "Probe that causes the service to be restarted when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"maxShutdownSeconds": {
"default": 30,
"description": "The number of seconds the pod has to shutdown before it is terminated",
"type": "integer"
},
"monitoring": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Use Prometheus for monitoring / metrics scraping",
"type": "boolean"
},
"interval": {
"default": "1m",
"description": "The interval at which monitoring data is scraped",
"type": "string"
},
"path": {
"default": "/metrics",
"description": "The path to be scraped for monitoring data",
"type": "string"
},
"port": {
"default": 9100,
"description": "The port to be scraped for monitoring data",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the service (used for app.kubernetes.io/name label)",
"type": "string"
},
"netpol": {
"additionalProperties": false,
"properties": {
"egress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Apply network policies for the Pods",
"type": "boolean"
},
"ingress": {
"description": "Ingress network policy rules to apply",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"additionalProperties": false,
"properties": {
"accessModes": {
"default": [
"ReadWriteOnce"
],
"description": "The support access modes the volume can be mounted with",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"default": false,
"description": "Enables persistent storage for the service",
"type": "boolean"
},
"mountPath": {
"description": "The mount path for the storage inside the container",
"type": "string"
},
"size": {
"default": "1G",
"description": "The size of the persistent volume to create for the service",
"type": "string"
},
"storageClass": {
"description": "The type of disk to use for storage instead of the cluster default",
"type": "string"
}
},
"type": "object"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoles": {
"description": "Cluster-wide Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
},
"existingServiceAccount": {
"description": "The name of an existing service account to use (instead of automatically creating one for the service)",
"type": "string"
},
"roles": {
"description": "Namespace-specific Kubernetes RBAC Roles to assign to the service (supports templating)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": true,
"description": "Probe that prevents the service from receiving traffic when failing",
"properties": {
"exec": {
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"replicas": {
"default": 1,
"description": "The number of instances of the service to run (set at least 2 for Pod Disruption Budget)",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"properties": {
"limits": {
"properties": {
"cpu": {
"default": "2000m",
"description": "The maximum number of CPU cores the service may use",
"type": "string"
},
"memory": {
"default": "96Mi",
"description": "The maximum amount of memory the service may use (recommendation: slightly higher than worst-case usage)",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"default": "10m",
"description": "The number of CPU cores requested for the service",
"type": "string"
},
"memory": {
"default": "64M",
"description": "The amount of memory requested for the service (recommendation: slightly higher than average usage)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"rollout": {
"additionalProperties": false,
"properties": {
"analysis": {
"description": "Flagger or Argo Rollouts analysis for automatic Canary or BlueGreen promotion"
},
"autoPromotion": {
"default": true,
"description": "Automatically promote successful rollouts (only applicable if rollout.strategy is BlueGreen)",
"type": "boolean"
},
"controller": {
"default": "Deployment",
"description": "The type of Pod controller to create",
"enum": [
"Deployment",
"StatefulSet",
"DaemonSet",
"ArgoRollout"
],
"type": "string"
},
"flagger": {
"default": false,
"description": "Use Flagger to control rollouts (rollout.controller must be Deployment or StatefulSet)",
"type": "boolean"
},
"strategy": {
"default": "RollingUpdate",
"description": "The rollout strategy",
"enum": [
"RollingUpdate",
"Recreate",
"OnDelete",
"Canary",
"BlueGreen"
],
"type": "string"
}
},
"type": "object"
},
"scheduling": {
"additionalProperties": false,
"properties": {
"nodeExclusions": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service must not run on",
"type": "object"
},
"nodePreferences": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Sets of label values to select nodes this service should be run on if possible",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select nodes this service may be run on",
"type": "object"
},
"podAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service should share nodes with if possible",
"type": "object"
},
"podAntiAffinity": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to select other pods this service must not share nodes with",
"type": "object"
},
"priority": {
"description": "The name of the PriorityClass to use for scheduling this service",
"type": "string"
},
"replicaSpread": {
"default": "BestEffort",
"description": "How to spread replicas across nodes",
"enum": [
"BestEffort",
"Strict",
"None"
],
"type": "string"
},
"tolerations": {
"description": "Taints on nodes this service can tolerate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "Map of file names to base64-encoded content; leave empty to reference existing Secret",
"type": "object"
},
"mountPath": {
"description": "The mount path for the Secret inside the container",
"type": "string"
},
"subPath": {
"description": "The path of a single file in the Secret to mount; leave empty to mount all files",
"type": "string"
}
},
"required": [
"mountPath"
],
"type": "object"
},
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"description": "Security context",
"properties": {
"container": {
"description": "Security context to use for running containers",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"readOnlyRootFilesystem": {
"type": "boolean"
}
},
"type": "object"
},
"pod": {
"description": "Security context to use for the pod",
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"description": "Additional sidecar containers to be added to the Pod",
"items": {
"type": "object"
},
"type": "array"
},
"sidecarsTemplates": {
"description": "Strings to be templated providing additional sidecar containers to be added to the Pod",
"items": {
"type": "string"
},
"type": "array"
},
"startupProbe": {
"description": "Probe that waits for the service to initially start",
"properties": {
"additionalProperties": true,
"exec": {
"properties": {
"additionalProperties": true,
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"grpc": {
"additionalProperties": true,
"properties": {
"port": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"httpGet": {
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"port": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
}
},
"type": "object"
},
"tracing": {
"additionalProperties": false,
"properties": {
"class": {
"default": "true",
"description": "Custom value to set for tracing sidecar injection annotations",
"type": "string"
},
"enabled": {
"default": false,
"description": "Enables tracing with Jaeger agent (injected as sidecar)",
"type": "boolean"
},
"probability": {
"default": 1,
"description": "Probability of any single trace being sampled; can be overridden for incoming requests e.g. via Istio",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"version": {
"description": "The version of the service (used for app.kubernetes.io/version label)",
"type": "string"
}
},
"required": [
"image"
],
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | bbf8e7c1951a29dd421d9a8e09bb33e2df6f3fa5 | 2020-09-22T09:19:09 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"oneOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"git-bitbucket",
"hg",
"hg-bitbucket",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"name": "Package",
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed) and can be \"full\" (compatible with both Windows and Unix-based systems).",
"enum": [
"auto",
"full"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-read-only": {
"description": "Whether to use the Composer cache in read-only mode.",
"type": [
"boolean"
]
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-token": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "A hash of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"type": "object"
},
"platform-check": {
"description": "Defaults to true. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": "boolean"
},
"preferred-install": {
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or a hash of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"pattern": "^dev|alpha|beta|rc|RC|stable$",
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]?|-{0,2})[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(((\\.\\d+)?\\.\\d+)?\\.\\d+)?|^dev-",
"type": "string"
}
},
"required": [],
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | e4ec6a2a8468e4585aab71affde64e1e4da23e01 | 2022-06-02T09:44:25 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"anyOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"bitbucket",
"git-bitbucket",
"hg",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"allow-plugins": {
"additionalProperties": {
"type": [
"boolean"
]
},
"description": "This is an object of {\"pattern\": true|false} with packages which are allowed to be loaded as plugins, or true to allow all, false to allow none. Defaults to {} which prompts when an unknown plugin is added.",
"type": [
"object",
"boolean"
]
},
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed), can be \"full\" (compatible with both Windows and Unix-based systems) and \"proxy\" (only bash-style proxy).",
"enum": [
"auto",
"full",
"proxy",
"symlink"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"bitbucket-oauth": {
"additionalProperties": {
"properties": {
"access-token": {
"description": "The OAuth token retrieved from Bitbucket's API, this is written by Composer and you should not set it nor modify it.",
"type": "string"
},
"access-token-expiration": {
"description": "The generated token's expiration timestamp, this is written by Composer and you should not set it nor modify it.",
"type": "integer"
},
"consumer-key": {
"description": "The consumer-key used for OAuth authentication",
"type": "string"
},
"consumer-secret": {
"description": "The consumer-secret used for OAuth authentication",
"type": "string"
}
},
"required": [
"consumer-key",
"consumer-secret"
],
"type": "object"
},
"description": "An object of domain name => {\"consumer-key\": \"...\", \"consumer-secret\": \"...\"}.",
"type": "object"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-read-only": {
"description": "Whether to use the Composer cache in read-only mode.",
"type": [
"boolean"
]
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"https\", \"ssh\", \"git\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-protocol": {
"description": "A protocol to force use of when creating a repository URL for the `source` value of the package metadata. One of `git` or `http`. By default, Composer will generate a git URL for private repositories and http one for public repos.",
"enum": [
"git",
"http",
"https"
]
},
"gitlab-token": {
"additionalProperties": {
"properties": {
"token": {
"description": "The token used for GitLab authentication",
"type": "string"
},
"username": {
"description": "The username used for GitLab authentication",
"type": "string"
}
},
"required": [
"username",
"token"
],
"type": [
"string",
"object"
]
},
"description": "An object of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}, or an object with username and token keys.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "An object of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": [
"string",
"boolean"
]
},
"description": "This is an object of package name (keys) and version (values) that will be used to mock the platform packages on this machine, the version can be set to false to make it appear like the package is not present.",
"type": "object"
},
"platform-check": {
"description": "Defaults to \"php-only\" which checks only the PHP version. Setting to true will also check the presence of required PHP extensions. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": [
"boolean",
"string"
]
},
"preferred-install": {
"additionalProperties": {
"type": [
"string"
]
},
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or an object of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"secure-svn-domains": {
"description": "A list of domains which should be trusted/marked as using a secure Subversion/SVN transport. By default svn:// protocol is seen as insecure and will throw. This is a better/safer alternative to disabling `secure-http` altogether.",
"items": {
"type": "string"
},
"type": "array"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"use-parent-dir": {
"description": "When running Composer in a directory where there is no composer.json, if there is one present in a directory above Composer will by default ask you whether you want to use that directory's composer.json instead. One of: true (always use parent if needed), false (never ask or use it) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"enum": [
"dev",
"alpha",
"beta",
"rc",
"RC",
"stable"
],
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]|-{1,2})?[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(\\.\\d+){0,3}|^dev-",
"type": "string"
}
},
"required": [],
"title": "Package",
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | a826bbe369f5aae1d36f4a78cc31cd7a22cd4fb2 | 2020-08-26T09:16:37 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of directories that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"oneOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"git-bitbucket",
"hg",
"hg-bitbucket",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"name": "Package",
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of directories that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed) and can be \"full\" (compatible with both Windows and Unix-based systems).",
"enum": [
"auto",
"full"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-read-only": {
"description": "Whether to use the Composer cache in read-only mode.",
"type": [
"boolean"
]
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-token": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "A hash of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"type": "object"
},
"platform-check": {
"description": "Defaults to true. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": "boolean"
},
"preferred-install": {
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or a hash of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"pattern": "^dev|alpha|beta|rc|RC|stable$",
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]?|-{0,2})[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(((\\.\\d+)?\\.\\d+)?\\.\\d+)?|^dev-",
"type": "string"
}
},
"required": [],
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | d85433e643f4d510af99d705c24283edf970dfde | 2020-01-19T09:24:07 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"artifact-repository": {
"properties": {
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of directories that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"force-lazy-providers": {
"type": "boolean"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"oneOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"depot": {
"type": "string"
},
"no-api": {
"type": "boolean"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"git-bitbucket",
"hg",
"hg-bitbucket",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"name": "Package",
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of directories that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed) and can be \"full\" (compatible with both Windows and Unix-based systems).",
"enum": [
"auto",
"full"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-token": {
"additionalProperties": true,
"description": "A hash of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "A hash of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"type": "object"
},
"preferred-install": {
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or a hash of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"description": {
"description": "Short package description.",
"type": "string"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"pattern": "^dev|alpha|beta|rc|RC|stable$",
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(((\\.\\d+)?\\.\\d+)?\\.\\d+)?|^dev-",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | e619a86b3106680345b85533936f6bd0a0bc4449 | 2020-01-14T12:26:35 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"artifact-repository": {
"properties": {
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of directories that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"force-lazy-providers": {
"type": "boolean"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"oneOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"depot": {
"type": "string"
},
"no-api": {
"type": "boolean"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"git-bitbucket",
"hg",
"hg-bitbucket",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"name": "Package",
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of directories that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed) and can be \"full\" (compatible with both Windows and Unix-based systems).",
"enum": [
"auto",
"full"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-token": {
"additionalProperties": true,
"description": "A hash of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "A hash of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"type": "object"
},
"preferred-install": {
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or a hash of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"description": {
"description": "Short package description.",
"type": "string"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"pattern": "^dev|alpha|beta|rc|RC|stable$",
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(((\\.\\d+)?\\.\\d+)?\\.\\d+)?|^dev-",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | eeb19ba21a978c3c77eaafb87bbd0248b1518301 | 2020-02-15T09:04:04 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"artifact-repository": {
"properties": {
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of directories that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"force-lazy-providers": {
"type": "boolean"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"oneOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"depot": {
"type": "string"
},
"no-api": {
"type": "boolean"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"git-bitbucket",
"hg",
"hg-bitbucket",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"name": "Package",
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of directories that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed) and can be \"full\" (compatible with both Windows and Unix-based systems).",
"enum": [
"auto",
"full"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-token": {
"additionalProperties": true,
"description": "A hash of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "A hash of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"type": "object"
},
"preferred-install": {
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or a hash of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"description": {
"description": "Short package description.",
"type": "string"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"pattern": "^dev|alpha|beta|rc|RC|stable$",
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(((\\.\\d+)?\\.\\d+)?\\.\\d+)?|^dev-",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | 5542fc7881d3b4a4c1eac7b211ae87d1657e26ef | 2021-12-05T11:12:24 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"anyOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"bitbucket",
"git-bitbucket",
"hg",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed), can be \"full\" (compatible with both Windows and Unix-based systems) and \"proxy\" (only bash-style proxy).",
"enum": [
"auto",
"full",
"proxy",
"symlink"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-read-only": {
"description": "Whether to use the Composer cache in read-only mode.",
"type": [
"boolean"
]
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-protocol": {
"description": "A protocol to force use of when creating a repository URL for the `source` value of the package metadata. One of `git` or `http`. By default, Composer will generate a git URL for private repositories and http one for public repos.",
"enum": [
"git",
"http",
"https"
]
},
"gitlab-token": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "A hash of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": [
"string",
"boolean"
]
},
"description": "This is a hash of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"type": "object"
},
"platform-check": {
"description": "Defaults to \"php-only\" which checks only the PHP version. Setting to true will also check the presence of required PHP extensions. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": [
"boolean",
"string"
]
},
"preferred-install": {
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or a hash of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"secure-svn-domains": {
"description": "A list of domains which should be trusted/marked as using a secure Subversion/SVN transport. By default svn:// protocol is seen as insecure and will throw. This is a better/safer alternative to disabling `secure-http` altogether.",
"items": {
"type": "string"
},
"type": "array"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"use-parent-dir": {
"description": "When running Composer in a directory where there is no composer.json, if there is one present in a directory above Composer will by default ask you whether you want to use that directory's composer.json instead. One of: true (always use parent if needed), false (never ask or use it) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"enum": [
"dev",
"alpha",
"beta",
"rc",
"RC",
"stable"
],
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]?|-{0,2})[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(\\.\\d+){0,3}|^dev-",
"type": "string"
}
},
"required": [],
"title": "Package",
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | f80eaa3d7359287c1a827084b3da6fa3aa389b99 | 2022-04-20T07:41:27 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"anyOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"bitbucket",
"git-bitbucket",
"hg",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"allow-plugins": {
"additionalProperties": {
"type": [
"boolean"
]
},
"description": "This is an object of {\"pattern\": true|false} with packages which are allowed to be loaded as plugins, or true to allow all, false to allow none. Defaults to {} which prompts when an unknown plugin is added.",
"type": [
"object",
"boolean"
]
},
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed), can be \"full\" (compatible with both Windows and Unix-based systems) and \"proxy\" (only bash-style proxy).",
"enum": [
"auto",
"full",
"proxy",
"symlink"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"bitbucket-oauth": {
"additionalProperties": {
"properties": {
"consumer-key": {
"description": "The consumer-key used for OAuth authentication",
"type": "string"
},
"consumer-secret": {
"description": "The consumer-secret used for OAuth authentication",
"type": "string"
}
},
"required": [
"consumer-key",
"consumer-secret"
],
"type": "object"
},
"description": "An object of domain name => {\"consumer-key\": \"...\", \"consumer-secret\": \"...\"}.",
"type": "object"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-read-only": {
"description": "Whether to use the Composer cache in read-only mode.",
"type": [
"boolean"
]
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-protocol": {
"description": "A protocol to force use of when creating a repository URL for the `source` value of the package metadata. One of `git` or `http`. By default, Composer will generate a git URL for private repositories and http one for public repos.",
"enum": [
"git",
"http",
"https"
]
},
"gitlab-token": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "An object of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": [
"string",
"boolean"
]
},
"description": "This is an object of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"type": "object"
},
"platform-check": {
"description": "Defaults to \"php-only\" which checks only the PHP version. Setting to true will also check the presence of required PHP extensions. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": [
"boolean",
"string"
]
},
"preferred-install": {
"additionalProperties": {
"type": [
"string"
]
},
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or an object of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"secure-svn-domains": {
"description": "A list of domains which should be trusted/marked as using a secure Subversion/SVN transport. By default svn:// protocol is seen as insecure and will throw. This is a better/safer alternative to disabling `secure-http` altogether.",
"items": {
"type": "string"
},
"type": "array"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"use-parent-dir": {
"description": "When running Composer in a directory where there is no composer.json, if there is one present in a directory above Composer will by default ask you whether you want to use that directory's composer.json instead. One of: true (always use parent if needed), false (never ask or use it) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"enum": [
"dev",
"alpha",
"beta",
"rc",
"RC",
"stable"
],
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]?|-{0,2})[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(\\.\\d+){0,3}|^dev-",
"type": "string"
}
},
"required": [],
"title": "Package",
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | 331adb0aad06e4a4c8e79b88e9e0f7a9d8d00685 | 2021-06-02T09:39:56 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"anyOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"git-bitbucket",
"hg",
"hg-bitbucket",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed) and can be \"full\" (compatible with both Windows and Unix-based systems).",
"enum": [
"auto",
"full"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-read-only": {
"description": "Whether to use the Composer cache in read-only mode.",
"type": [
"boolean"
]
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-protocol": {
"description": "A protocol to force use of when creating a repository URL for the `source` value of the package metadata. One of `git` or `http`. By default, Composer will generate a git URL for private repositories and http one for public repos.",
"enum": [
"git",
"http",
"https"
]
},
"gitlab-token": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "A hash of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"type": "object"
},
"platform-check": {
"description": "Defaults to \"php-only\" which checks only the PHP version. Setting to true will also check the presence of required PHP extensions. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": [
"boolean",
"string"
]
},
"preferred-install": {
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or a hash of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"secure-svn-domains": {
"description": "A list of domains which should be trusted/marked as using a secure Subversion/SVN transport. By default svn:// protocol is seen as insecure and will throw. This is a better/safer alternative to disabling `secure-http` altogether.",
"items": {
"type": "string"
},
"type": "array"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"enum": [
"dev",
"alpha",
"beta",
"rc",
"RC",
"stable"
],
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]?|-{0,2})[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(\\.\\d+){0,3}|^dev-",
"type": "string"
}
},
"required": [],
"title": "Package",
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | be2c89536a2fd390552f8f91a3adcea7c62b8aed | 2022-03-30T09:10:31 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"anyOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"bitbucket",
"git-bitbucket",
"hg",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"allow-plugins": {
"additionalProperties": {
"type": [
"boolean"
]
},
"description": "This is an object of {\"pattern\": true|false} with packages which are allowed to be loaded as plugins, or true to allow all, false to allow none. Defaults to {} which prompts when an unknown plugin is added.",
"type": [
"object",
"boolean"
]
},
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed), can be \"full\" (compatible with both Windows and Unix-based systems) and \"proxy\" (only bash-style proxy).",
"enum": [
"auto",
"full",
"proxy",
"symlink"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-read-only": {
"description": "Whether to use the Composer cache in read-only mode.",
"type": [
"boolean"
]
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-protocol": {
"description": "A protocol to force use of when creating a repository URL for the `source` value of the package metadata. One of `git` or `http`. By default, Composer will generate a git URL for private repositories and http one for public repos.",
"enum": [
"git",
"http",
"https"
]
},
"gitlab-token": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "An object of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": [
"string",
"boolean"
]
},
"description": "This is an object of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"type": "object"
},
"platform-check": {
"description": "Defaults to \"php-only\" which checks only the PHP version. Setting to true will also check the presence of required PHP extensions. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": [
"boolean",
"string"
]
},
"preferred-install": {
"additionalProperties": {
"type": [
"string"
]
},
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or an object of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"secure-svn-domains": {
"description": "A list of domains which should be trusted/marked as using a secure Subversion/SVN transport. By default svn:// protocol is seen as insecure and will throw. This is a better/safer alternative to disabling `secure-http` altogether.",
"items": {
"type": "string"
},
"type": "array"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"use-parent-dir": {
"description": "When running Composer in a directory where there is no composer.json, if there is one present in a directory above Composer will by default ask you whether you want to use that directory's composer.json instead. One of: true (always use parent if needed), false (never ask or use it) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"enum": [
"dev",
"alpha",
"beta",
"rc",
"RC",
"stable"
],
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]?|-{0,2})[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(\\.\\d+){0,3}|^dev-",
"type": "string"
}
},
"required": [],
"title": "Package",
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | 42dc7a0bddb90c488da09008e952590be2e59dfe | 2020-11-05T09:16:17 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"anyOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"git-bitbucket",
"hg",
"hg-bitbucket",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"name": "Package",
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed) and can be \"full\" (compatible with both Windows and Unix-based systems).",
"enum": [
"auto",
"full"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-read-only": {
"description": "Whether to use the Composer cache in read-only mode.",
"type": [
"boolean"
]
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-token": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "A hash of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"type": "object"
},
"platform-check": {
"description": "Defaults to \"php-only\" which checks only the PHP version. Setting to true will also check the presence of required PHP extensions. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": [
"boolean",
"string"
]
},
"preferred-install": {
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or a hash of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"pattern": "^dev|alpha|beta|rc|RC|stable$",
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]?|-{0,2})[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(((\\.\\d+)?\\.\\d+)?\\.\\d+)?|^dev-",
"type": "string"
}
},
"required": [],
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | 21a5cb180da4843394892cc5c1cbcc89926755b7 | 2020-10-17T09:22:28 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"anyOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"git-bitbucket",
"hg",
"hg-bitbucket",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"name": "Package",
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed) and can be \"full\" (compatible with both Windows and Unix-based systems).",
"enum": [
"auto",
"full"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-read-only": {
"description": "Whether to use the Composer cache in read-only mode.",
"type": [
"boolean"
]
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-token": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "A hash of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"type": "object"
},
"platform-check": {
"description": "Defaults to true. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": "boolean"
},
"preferred-install": {
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or a hash of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"pattern": "^dev|alpha|beta|rc|RC|stable$",
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]?|-{0,2})[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(((\\.\\d+)?\\.\\d+)?\\.\\d+)?|^dev-",
"type": "string"
}
},
"required": [],
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | 9fe4f760df42207bc38e5711b466c47b99ee8432 | 2021-06-10T09:05:57 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"anyOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"git-bitbucket",
"hg",
"hg-bitbucket",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed), can be \"full\" (compatible with both Windows and Unix-based systems) and \"symlink\" (symlink also for WSL).",
"enum": [
"auto",
"full",
"symlink"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-read-only": {
"description": "Whether to use the Composer cache in read-only mode.",
"type": [
"boolean"
]
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-protocol": {
"description": "A protocol to force use of when creating a repository URL for the `source` value of the package metadata. One of `git` or `http`. By default, Composer will generate a git URL for private repositories and http one for public repos.",
"enum": [
"git",
"http",
"https"
]
},
"gitlab-token": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "A hash of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"type": "object"
},
"platform-check": {
"description": "Defaults to \"php-only\" which checks only the PHP version. Setting to true will also check the presence of required PHP extensions. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": [
"boolean",
"string"
]
},
"preferred-install": {
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or a hash of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"secure-svn-domains": {
"description": "A list of domains which should be trusted/marked as using a secure Subversion/SVN transport. By default svn:// protocol is seen as insecure and will throw. This is a better/safer alternative to disabling `secure-http` altogether.",
"items": {
"type": "string"
},
"type": "array"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"enum": [
"dev",
"alpha",
"beta",
"rc",
"RC",
"stable"
],
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]?|-{0,2})[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(\\.\\d+){0,3}|^dev-",
"type": "string"
}
},
"required": [],
"title": "Package",
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | 8022d5b6d49a490fe84725f4b29f094f7b8015da | 2022-08-17T09:06:20 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"anyOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"bitbucket",
"git-bitbucket",
"hg",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"allow-plugins": {
"additionalProperties": {
"type": [
"boolean"
]
},
"description": "This is an object of {\"pattern\": true|false} with packages which are allowed to be loaded as plugins, or true to allow all, false to allow none. Defaults to {} which prompts when an unknown plugin is added.",
"type": [
"object",
"boolean"
]
},
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed), can be \"full\" (compatible with both Windows and Unix-based systems) and \"proxy\" (only bash-style proxy).",
"enum": [
"auto",
"full",
"proxy",
"symlink"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"bitbucket-oauth": {
"additionalProperties": {
"properties": {
"access-token": {
"description": "The OAuth token retrieved from Bitbucket's API, this is written by Composer and you should not set it nor modify it.",
"type": "string"
},
"access-token-expiration": {
"description": "The generated token's expiration timestamp, this is written by Composer and you should not set it nor modify it.",
"type": "integer"
},
"consumer-key": {
"description": "The consumer-key used for OAuth authentication",
"type": "string"
},
"consumer-secret": {
"description": "The consumer-secret used for OAuth authentication",
"type": "string"
}
},
"required": [
"consumer-key",
"consumer-secret"
],
"type": "object"
},
"description": "An object of domain name => {\"consumer-key\": \"...\", \"consumer-secret\": \"...\"}.",
"type": "object"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-read-only": {
"description": "Whether to use the Composer cache in read-only mode.",
"type": [
"boolean"
]
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"https\", \"ssh\", \"git\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"properties": {
"expires-at": {
"description": "The expiration date for this GitLab token",
"type": "integer"
},
"refresh-token": {
"description": "The refresh token used for GitLab authentication",
"type": "string"
},
"token": {
"description": "The token used for GitLab authentication",
"type": "string"
}
},
"required": [
"token"
],
"type": [
"string",
"object"
]
},
"description": "An object of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":{\"expires-at\":\"<expiration date>\", \"refresh-token\":\"<refresh token>\", \"token\":\"<token>\"}}.",
"type": "object"
},
"gitlab-protocol": {
"description": "A protocol to force use of when creating a repository URL for the `source` value of the package metadata. One of `git` or `http`. By default, Composer will generate a git URL for private repositories and http one for public repos.",
"enum": [
"git",
"http",
"https"
]
},
"gitlab-token": {
"additionalProperties": {
"properties": {
"token": {
"description": "The token used for GitLab authentication",
"type": "string"
},
"username": {
"description": "The username used for GitLab authentication",
"type": "string"
}
},
"required": [
"username",
"token"
],
"type": [
"string",
"object"
]
},
"description": "An object of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}, or an object with username and token keys.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "An object of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": [
"string",
"boolean"
]
},
"description": "This is an object of package name (keys) and version (values) that will be used to mock the platform packages on this machine, the version can be set to false to make it appear like the package is not present.",
"type": "object"
},
"platform-check": {
"description": "Defaults to \"php-only\" which checks only the PHP version. Setting to true will also check the presence of required PHP extensions. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": [
"boolean",
"string"
]
},
"preferred-install": {
"additionalProperties": {
"type": [
"string"
]
},
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or an object of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"secure-svn-domains": {
"description": "A list of domains which should be trusted/marked as using a secure Subversion/SVN transport. By default svn:// protocol is seen as insecure and will throw. This is a better/safer alternative to disabling `secure-http` altogether.",
"items": {
"type": "string"
},
"type": "array"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"use-parent-dir": {
"description": "When running Composer in a directory where there is no composer.json, if there is one present in a directory above Composer will by default ask you whether you want to use that directory's composer.json instead. One of: true (always use parent if needed), false (never ask or use it) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"enum": [
"dev",
"alpha",
"beta",
"rc",
"RC",
"stable"
],
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]|-{1,2})?[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(\\.\\d+){0,3}|^dev-",
"type": "string"
}
},
"required": [],
"title": "Package",
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | fc95bc93dbda2b3bc1d0ce49867b95372490063e | 2020-03-11T21:48:34 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"artifact-repository": {
"properties": {
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of directories that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"force-lazy-providers": {
"type": "boolean"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"oneOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"depot": {
"type": "string"
},
"no-api": {
"type": "boolean"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"git-bitbucket",
"hg",
"hg-bitbucket",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"name": "Package",
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of directories that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed) and can be \"full\" (compatible with both Windows and Unix-based systems).",
"enum": [
"auto",
"full"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-token": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "A hash of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"type": "object"
},
"preferred-install": {
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or a hash of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"description": {
"description": "Short package description.",
"type": "string"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"pattern": "^dev|alpha|beta|rc|RC|stable$",
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(((\\.\\d+)?\\.\\d+)?\\.\\d+)?|^dev-",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | ebfcee374809c4f0671c7a4e2ca7f14df65545de | 2020-01-16T22:42:27 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"artifact-repository": {
"properties": {
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of directories that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"force-lazy-providers": {
"type": "boolean"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"oneOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"depot": {
"type": "string"
},
"no-api": {
"type": "boolean"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"git-bitbucket",
"hg",
"hg-bitbucket",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"name": "Package",
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of directories that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed) and can be \"full\" (compatible with both Windows and Unix-based systems).",
"enum": [
"auto",
"full"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-token": {
"additionalProperties": true,
"description": "A hash of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "A hash of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"type": "object"
},
"preferred-install": {
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or a hash of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"description": {
"description": "Short package description.",
"type": "string"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"pattern": "^dev|alpha|beta|rc|RC|stable$",
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(((\\.\\d+)?\\.\\d+)?\\.\\d+)?",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | 5ea81662ffde37eac900a960589f3eb4382d38b5 | 2023-05-01T22:01:10 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"anyOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"bitbucket",
"git-bitbucket",
"hg",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"allow-plugins": {
"additionalProperties": {
"type": [
"boolean"
]
},
"description": "This is an object of {\"pattern\": true|false} with packages which are allowed to be loaded as plugins, or true to allow all, false to allow none. Defaults to {} which prompts when an unknown plugin is added.",
"type": [
"object",
"boolean"
]
},
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed), can be \"full\" (compatible with both Windows and Unix-based systems) and \"proxy\" (only bash-style proxy).",
"enum": [
"auto",
"full",
"proxy",
"symlink"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"bitbucket-oauth": {
"additionalProperties": {
"properties": {
"access-token": {
"description": "The OAuth token retrieved from Bitbucket's API, this is written by Composer and you should not set it nor modify it.",
"type": "string"
},
"access-token-expiration": {
"description": "The generated token's expiration timestamp, this is written by Composer and you should not set it nor modify it.",
"type": "integer"
},
"consumer-key": {
"description": "The consumer-key used for OAuth authentication",
"type": "string"
},
"consumer-secret": {
"description": "The consumer-secret used for OAuth authentication",
"type": "string"
}
},
"required": [
"consumer-key",
"consumer-secret"
],
"type": "object"
},
"description": "An object of domain name => {\"consumer-key\": \"...\", \"consumer-secret\": \"...\"}.",
"type": "object"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-read-only": {
"description": "Whether to use the Composer cache in read-only mode.",
"type": [
"boolean"
]
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"https\", \"ssh\", \"git\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"properties": {
"expires-at": {
"description": "The expiration date for this GitLab token",
"type": "integer"
},
"refresh-token": {
"description": "The refresh token used for GitLab authentication",
"type": "string"
},
"token": {
"description": "The token used for GitLab authentication",
"type": "string"
}
},
"required": [
"token"
],
"type": [
"string",
"object"
]
},
"description": "An object of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":{\"expires-at\":\"<expiration date>\", \"refresh-token\":\"<refresh token>\", \"token\":\"<token>\"}}.",
"type": "object"
},
"gitlab-protocol": {
"description": "A protocol to force use of when creating a repository URL for the `source` value of the package metadata. One of `git` or `http`. By default, Composer will generate a git URL for private repositories and http one for public repos.",
"enum": [
"git",
"http",
"https"
]
},
"gitlab-token": {
"additionalProperties": {
"properties": {
"token": {
"description": "The token used for GitLab authentication",
"type": "string"
},
"username": {
"description": "The username used for GitLab authentication",
"type": "string"
}
},
"required": [
"username",
"token"
],
"type": [
"string",
"object"
]
},
"description": "An object of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}, or an object with username and token keys.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "An object of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": [
"string",
"boolean"
]
},
"description": "This is an object of package name (keys) and version (values) that will be used to mock the platform packages on this machine, the version can be set to false to make it appear like the package is not present.",
"type": "object"
},
"platform-check": {
"description": "Defaults to \"php-only\" which checks only the PHP version. Setting to true will also check the presence of required PHP extensions. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": [
"boolean",
"string"
]
},
"preferred-install": {
"additionalProperties": {
"type": [
"string"
]
},
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or an object of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"secure-svn-domains": {
"description": "A list of domains which should be trusted/marked as using a secure Subversion/SVN transport. By default svn:// protocol is seen as insecure and will throw. This is a better/safer alternative to disabling `secure-http` altogether.",
"items": {
"type": "string"
},
"type": "array"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"use-parent-dir": {
"description": "When running Composer in a directory where there is no composer.json, if there is one present in a directory above Composer will by default ask you whether you want to use that directory's composer.json instead. One of: true (always use parent if needed), false (never ask or use it) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"enum": [
"dev",
"alpha",
"beta",
"rc",
"RC",
"stable"
],
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]|-{1,2})?[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"security": {
"description": "URL to the vulnerability disclosure policy (VDP).",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(\\.\\d+){0,3}|^dev-",
"type": "string"
}
},
"required": [],
"title": "Package",
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | 2881687f18a7cd4224d1e05c54f6551b2c565b0c | 2020-08-16T20:16:38 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of directories that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"oneOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"git-bitbucket",
"hg",
"hg-bitbucket",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"name": "Package",
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of directories that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed) and can be \"full\" (compatible with both Windows and Unix-based systems).",
"enum": [
"auto",
"full"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-token": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "A hash of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"type": "object"
},
"platform-check": {
"description": "Defaults to true. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": "boolean"
},
"preferred-install": {
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or a hash of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"pattern": "^dev|alpha|beta|rc|RC|stable$",
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]?|-{0,2})[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(((\\.\\d+)?\\.\\d+)?\\.\\d+)?|^dev-",
"type": "string"
}
},
"required": [],
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | a95e15c294bd375b8bf6b5be2b4f778370ff69e8 | 2022-05-02T11:01:35 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"anyOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"bitbucket",
"git-bitbucket",
"hg",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"allow-plugins": {
"additionalProperties": {
"type": [
"boolean"
]
},
"description": "This is an object of {\"pattern\": true|false} with packages which are allowed to be loaded as plugins, or true to allow all, false to allow none. Defaults to {} which prompts when an unknown plugin is added.",
"type": [
"object",
"boolean"
]
},
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed), can be \"full\" (compatible with both Windows and Unix-based systems) and \"proxy\" (only bash-style proxy).",
"enum": [
"auto",
"full",
"proxy",
"symlink"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"bitbucket-oauth": {
"additionalProperties": {
"properties": {
"access-token": {
"description": "The OAuth token retrieved from Bitbucket's API, this is written by Composer and you should not set it nor modify it.",
"type": "string"
},
"access-token-expiration": {
"description": "The generated token's expiration timestamp, this is written by Composer and you should not set it nor modify it.",
"type": "integer"
},
"consumer-key": {
"description": "The consumer-key used for OAuth authentication",
"type": "string"
},
"consumer-secret": {
"description": "The consumer-secret used for OAuth authentication",
"type": "string"
}
},
"required": [
"consumer-key",
"consumer-secret"
],
"type": "object"
},
"description": "An object of domain name => {\"consumer-key\": \"...\", \"consumer-secret\": \"...\"}.",
"type": "object"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-read-only": {
"description": "Whether to use the Composer cache in read-only mode.",
"type": [
"boolean"
]
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"https\", \"ssh\", \"git\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-protocol": {
"description": "A protocol to force use of when creating a repository URL for the `source` value of the package metadata. One of `git` or `http`. By default, Composer will generate a git URL for private repositories and http one for public repos.",
"enum": [
"git",
"http",
"https"
]
},
"gitlab-token": {
"additionalProperties": {
"properties": {
"token": {
"description": "The token used for GitLab authentication",
"type": "string"
},
"username": {
"description": "The username used for GitLab authentication",
"type": "string"
}
},
"required": [
"username",
"token"
],
"type": [
"string",
"object"
]
},
"description": "An object of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}, or an object with username and token keys.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "An object of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": [
"string",
"boolean"
]
},
"description": "This is an object of package name (keys) and version (values) that will be used to mock the platform packages on this machine, the version can be set to false to make it appear like the package is not present.",
"type": "object"
},
"platform-check": {
"description": "Defaults to \"php-only\" which checks only the PHP version. Setting to true will also check the presence of required PHP extensions. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": [
"boolean",
"string"
]
},
"preferred-install": {
"additionalProperties": {
"type": [
"string"
]
},
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or an object of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"secure-svn-domains": {
"description": "A list of domains which should be trusted/marked as using a secure Subversion/SVN transport. By default svn:// protocol is seen as insecure and will throw. This is a better/safer alternative to disabling `secure-http` altogether.",
"items": {
"type": "string"
},
"type": "array"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"use-parent-dir": {
"description": "When running Composer in a directory where there is no composer.json, if there is one present in a directory above Composer will by default ask you whether you want to use that directory's composer.json instead. One of: true (always use parent if needed), false (never ask or use it) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"enum": [
"dev",
"alpha",
"beta",
"rc",
"RC",
"stable"
],
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]?|-{0,2})[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(\\.\\d+){0,3}|^dev-",
"type": "string"
}
},
"required": [],
"title": "Package",
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | 9778db18d940a1e0327d6abb7c4b9a93f1d7d4b2 | 2023-07-22T09:06:00 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"anyOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"bitbucket",
"git-bitbucket",
"hg",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"allow-plugins": {
"additionalProperties": {
"type": [
"boolean"
]
},
"description": "This is an object of {\"pattern\": true|false} with packages which are allowed to be loaded as plugins, or true to allow all, false to allow none. Defaults to {} which prompts when an unknown plugin is added.",
"type": [
"object",
"boolean"
]
},
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"audit": {
"description": "Security audit configuration options",
"properties": {
"ignored": {
"description": "A set of advisory ids, remote ids or CVE ids that should be ignored and not reported as part of an audit.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed), can be \"full\" (compatible with both Windows and Unix-based systems) and \"proxy\" (only bash-style proxy).",
"enum": [
"auto",
"full",
"proxy",
"symlink"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"bitbucket-oauth": {
"additionalProperties": {
"properties": {
"access-token": {
"description": "The OAuth token retrieved from Bitbucket's API, this is written by Composer and you should not set it nor modify it.",
"type": "string"
},
"access-token-expiration": {
"description": "The generated token's expiration timestamp, this is written by Composer and you should not set it nor modify it.",
"type": "integer"
},
"consumer-key": {
"description": "The consumer-key used for OAuth authentication",
"type": "string"
},
"consumer-secret": {
"description": "The consumer-secret used for OAuth authentication",
"type": "string"
}
},
"required": [
"consumer-key",
"consumer-secret"
],
"type": "object"
},
"description": "An object of domain name => {\"consumer-key\": \"...\", \"consumer-secret\": \"...\"}.",
"type": "object"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-read-only": {
"description": "Whether to use the Composer cache in read-only mode.",
"type": [
"boolean"
]
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"https\", \"ssh\", \"git\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"properties": {
"expires-at": {
"description": "The expiration date for this GitLab token",
"type": "integer"
},
"refresh-token": {
"description": "The refresh token used for GitLab authentication",
"type": "string"
},
"token": {
"description": "The token used for GitLab authentication",
"type": "string"
}
},
"required": [
"token"
],
"type": [
"string",
"object"
]
},
"description": "An object of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":{\"expires-at\":\"<expiration date>\", \"refresh-token\":\"<refresh token>\", \"token\":\"<token>\"}}.",
"type": "object"
},
"gitlab-protocol": {
"description": "A protocol to force use of when creating a repository URL for the `source` value of the package metadata. One of `git` or `http`. By default, Composer will generate a git URL for private repositories and http one for public repos.",
"enum": [
"git",
"http",
"https"
]
},
"gitlab-token": {
"additionalProperties": {
"properties": {
"token": {
"description": "The token used for GitLab authentication",
"type": "string"
},
"username": {
"description": "The username used for GitLab authentication",
"type": "string"
}
},
"required": [
"username",
"token"
],
"type": [
"string",
"object"
]
},
"description": "An object of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}, or an object with username and token keys.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "An object of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": [
"string",
"boolean"
]
},
"description": "This is an object of package name (keys) and version (values) that will be used to mock the platform packages on this machine, the version can be set to false to make it appear like the package is not present.",
"type": "object"
},
"platform-check": {
"description": "Defaults to \"php-only\" which checks only the PHP version. Setting to true will also check the presence of required PHP extensions. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": [
"boolean",
"string"
]
},
"preferred-install": {
"additionalProperties": {
"type": [
"string"
]
},
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or an object of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"secure-svn-domains": {
"description": "A list of domains which should be trusted/marked as using a secure Subversion/SVN transport. By default svn:// protocol is seen as insecure and will throw. This is a better/safer alternative to disabling `secure-http` altogether.",
"items": {
"type": "string"
},
"type": "array"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"use-parent-dir": {
"description": "When running Composer in a directory where there is no composer.json, if there is one present in a directory above Composer will by default ask you whether you want to use that directory's composer.json instead. One of: true (always use parent if needed), false (never ask or use it) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"enum": [
"dev",
"alpha",
"beta",
"rc",
"RC",
"stable"
],
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]|-{1,2})?[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"security": {
"description": "URL to the vulnerability disclosure policy (VDP).",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(\\.\\d+){0,3}|^dev-",
"type": "string"
}
},
"required": [],
"title": "Package",
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | b8d90de95cfe5e5077dff48c4fe536095113f12d | 2021-12-08T09:06:04 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"anyOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"bitbucket",
"git-bitbucket",
"hg",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"allow-plugins": {
"additionalProperties": {
"type": [
"boolean"
]
},
"description": "This is an object of {\"pattern\": true|false} with packages which are allowed to be loaded as plugins, or true to allow all, false to allow none. Defaults to {} which prompts when an unknown plugin is added.",
"type": [
"object",
"boolean"
]
},
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed), can be \"full\" (compatible with both Windows and Unix-based systems) and \"proxy\" (only bash-style proxy).",
"enum": [
"auto",
"full",
"proxy",
"symlink"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-read-only": {
"description": "Whether to use the Composer cache in read-only mode.",
"type": [
"boolean"
]
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-protocol": {
"description": "A protocol to force use of when creating a repository URL for the `source` value of the package metadata. One of `git` or `http`. By default, Composer will generate a git URL for private repositories and http one for public repos.",
"enum": [
"git",
"http",
"https"
]
},
"gitlab-token": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "An object of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": [
"string",
"boolean"
]
},
"description": "This is an object of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"type": "object"
},
"platform-check": {
"description": "Defaults to \"php-only\" which checks only the PHP version. Setting to true will also check the presence of required PHP extensions. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": [
"boolean",
"string"
]
},
"preferred-install": {
"additionalProperties": {
"type": [
"string"
]
},
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or an object of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"secure-svn-domains": {
"description": "A list of domains which should be trusted/marked as using a secure Subversion/SVN transport. By default svn:// protocol is seen as insecure and will throw. This is a better/safer alternative to disabling `secure-http` altogether.",
"items": {
"type": "string"
},
"type": "array"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"use-parent-dir": {
"description": "When running Composer in a directory where there is no composer.json, if there is one present in a directory above Composer will by default ask you whether you want to use that directory's composer.json instead. One of: true (always use parent if needed), false (never ask or use it) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"enum": [
"dev",
"alpha",
"beta",
"rc",
"RC",
"stable"
],
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]?|-{0,2})[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(\\.\\d+){0,3}|^dev-",
"type": "string"
}
},
"required": [],
"title": "Package",
"type": "object"
} | MIT | en |
ergebnis/composer-normalize | 9dff09b13403b6feec40f02f10498f550086b989 | 2019-12-18T17:35:20 | resource/schema.json | 1,012 | 2024-05-28T06:00:24.047914Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"artifact-repository": {
"properties": {
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of directories that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"force-lazy-providers": {
"type": "boolean"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"oneOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"depot": {
"type": "string"
},
"no-api": {
"type": "boolean"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"git-bitbucket",
"hg",
"hg-bitbucket",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"name": "Package",
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of directories that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed) and can be \"full\" (compatible with both Windows and Unix-based systems).",
"enum": [
"auto",
"full"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "A hash of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"gitlab-token": {
"additionalProperties": true,
"description": "A hash of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "A hash of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"type": "object"
},
"preferred-install": {
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or a hash of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"description": {
"description": "Short package description.",
"type": "string"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"pattern": "^dev|alpha|beta|rc|RC|stable$",
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"oneOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is a hash of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(((\\.\\d+)?\\.\\d+)?\\.\\d+)?",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
} | MIT | en |
ergebnis/day-one-to-obsidian-converter | 1c4b135005df14ec3d06c60add9d582db3a7e8b4 | 2022-07-25T19:28:23 | resource/day-one/schema.json | 8 | 2024-05-27T05:18:22.873762Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"entry": {
"additionalProperties": true,
"description": "An entry",
"properties": {
"creationDate": {
"description": "The date and time of when the entry was created",
"format": "date-time",
"type": "string"
},
"creationDevice": {
"description": "The name of the device on which the entry was created",
"type": "string"
},
"duration": {
"description": "The duration of the entry creation",
"type": "integer"
},
"editingTime": {
"description": "The editing time of the entry creation",
"type": "number"
},
"location": {
"$ref": "#/definitions/location",
"description": "The location of the entry creation"
},
"modifiedDate": {
"description": "The date and time of when the entry was created",
"format": "date-time",
"type": "string"
},
"photos": {
"description": "The photos of the entry",
"items": {
"$ref": "#/definitions/photo"
},
"type": "array"
},
"richText": {
"description": "The rich text of the entry",
"type": "string"
},
"starred": {
"description": "Whether the entry is starred or not",
"type": "boolean"
},
"tags": {
"description": "An array of tags",
"items": {
"type": "string"
},
"type": "array"
},
"text": {
"description": "The Markdown text of the entry",
"type": "string"
},
"timeZone": {
"description": "The time zone of the entry creation",
"type": "string"
},
"uuid": {
"description": "The UUID of the entry",
"type": "string"
},
"weather": {
"$ref": "#/definitions/weather",
"description": "The weather at the time of entry creation"
}
},
"required": [
"creationDate",
"creationDevice",
"duration",
"modifiedDate",
"starred",
"timeZone",
"uuid"
],
"type": "object"
},
"location": {
"additionalProperties": false,
"properties": {
"administrativeArea": {
"description": "The administrative area of the location",
"type": "string"
},
"country": {
"description": "The country of the location",
"type": "string"
},
"foursquareID": {
"description": "The FourSquare ID of the place",
"type": "string"
},
"latitude": {
"description": "The latitude of the location",
"type": "number"
},
"localityName": {
"description": "The name of the locality of the location",
"type": "string"
},
"longitude": {
"description": "The latitude of the location",
"type": "number"
},
"placeName": {
"description": "The name of the place",
"type": "string"
},
"region": {
"description": "The region of the location",
"properties": {
"center": {
"additionalProperties": false,
"description": "The center of the region",
"properties": {
"latitude": {
"description": "The latitude of the center",
"type": "number"
},
"longitude": {
"description": "The longitude of the center",
"type": "number"
},
"radius": {
"description": "The radius",
"type": "integer"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object"
}
},
"type": "object"
},
"timeZoneName": {
"description": "The name of the timezone of the place",
"type": "string"
},
"userLabel": {
"description": "A user label for the place",
"type": "string"
}
},
"required": [
"latitude",
"longitude",
"placeName",
"region"
],
"type": "object"
},
"photo": {
"additionalProperties": false,
"description": "A photo",
"properties": {
"appleCloudIdentifier": {
"description": "The iCloud identifier of the photo",
"type": "string"
},
"cameraMake": {
"description": "The make of the camera with which the photo was created",
"type": "string"
},
"cameraModel": {
"description": "The model of the camera with which the photo was created",
"type": "string"
},
"creationDevice": {
"description": "The name of the device on which the photo was created",
"type": "string"
},
"date": {
"description": "The date and time of when the photo was created",
"format": "date-time",
"type": "string"
},
"duration": {
"description": "The duration of the photo creation",
"type": "integer"
},
"exposureBiasValue": {
"description": "The exposure bias value of the photo",
"type": "number"
},
"favorite": {
"description": "Whether the photo is a favorite or not",
"type": "boolean"
},
"fileSize": {
"description": "The file size of the photo",
"type": "integer"
},
"filename": {
"description": "The file name of the photo",
"type": "string"
},
"fnumber": {
"description": "The fnumber of the photo",
"type": "string"
},
"focalLength": {
"description": "The focal length of the photo",
"type": "string"
},
"height": {
"description": "The height of the photo",
"type": "integer"
},
"identifier": {
"description": "The identifier of the photo",
"type": "string"
},
"isSketch": {
"description": "Whether the photo is a sketch or not",
"type": "boolean"
},
"lensMake": {
"description": "The make of the lens with which the photo was created",
"type": "string"
},
"lensModel": {
"description": "The model of the lens with which the photo was created",
"type": "string"
},
"location": {
"$ref": "#/definitions/location",
"description": "The location of where the photo was created"
},
"md5": {
"description": "The MD5 hash of the photo",
"type": "string"
},
"orderInEntry": {
"description": "The order of the photo in the entry",
"type": "integer"
},
"type": {
"description": "The type of the photo",
"type": "string"
},
"width": {
"description": "The width of the photo",
"type": "integer"
}
},
"required": [
"creationDevice",
"duration",
"fnumber",
"focalLength",
"height",
"identifier",
"isSketch",
"md5",
"orderInEntry",
"type",
"width"
],
"type": "object"
},
"weather": {
"additionalProperties": true,
"properties": {
"conditionsDescription": {
"description": "The description of the weather conditions",
"type": "string"
},
"moonPhase": {
"description": "The moon phase",
"type": "number"
},
"moonPhaseCode": {
"description": "The code of the moon phase",
"type": "string"
},
"pressureMB": {
"description": "The pressure in millibars",
"type": "number"
},
"relativeHumidity": {
"description": "The relative humidity",
"type": "integer"
},
"sunriseDate": {
"description": "The date and time of the sunrise",
"format": "date-time",
"type": "string"
},
"sunsetDate": {
"description": "The date and time of the sunset",
"format": "date-time",
"type": "string"
},
"temperatureCelsius": {
"description": "The temperature in Celsius",
"type": "number"
},
"visibilityKM": {
"description": "The visibility in kilometers",
"type": "number"
},
"weatherCode": {
"description": "The code of the weather",
"type": "string"
},
"weatherServiceName": {
"description": "The name of the weather service",
"type": "string"
},
"windBearing": {
"description": "The wind bearing",
"type": "integer"
},
"windChillCelsius": {
"description": "The wind chill in Celsius",
"type": "number"
},
"windSpeedKPH": {
"description": "The wind speed in kilometers per hour",
"type": "number"
}
},
"required": [
"conditionsDescription",
"relativeHumidity",
"temperatureCelsius",
"weatherCode",
"weatherServiceName"
],
"type": "object"
}
},
"properties": {
"entries": {
"description": "An array of entries",
"items": {
"$ref": "#/definitions/entry"
},
"type": "array"
},
"metadata": {
"additionalProperties": false,
"description": "Metadata of the journal",
"properties": {
"version": {
"description": "Version of the JSON file",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
}
},
"required": [
"entries",
"metadata"
],
"title": "DayOne JSON file",
"type": "object"
} | MIT | en |
ergebnis/day-one-to-obsidian-converter | 0c54f8fde27d56699daac4be0b3ceb1704a9bba4 | 2022-07-28T07:24:13 | resource/day-one/schema.json | 8 | 2024-05-27T05:18:22.873762Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"entry": {
"additionalProperties": false,
"description": "An entry",
"properties": {
"creationDate": {
"description": "The date and time of when the entry was created",
"format": "date-time",
"type": "string"
},
"creationDevice": {
"description": "The name of the device on which the entry was created",
"type": "string"
},
"duration": {
"description": "The duration of the entry creation",
"type": "integer"
},
"editingTime": {
"description": "The editing time of the entry creation",
"type": "number"
},
"location": {
"$ref": "#/definitions/location",
"description": "The location of the entry creation"
},
"modifiedDate": {
"description": "The date and time of when the entry was created",
"format": "date-time",
"type": "string"
},
"photos": {
"description": "The photos of the entry",
"items": {
"$ref": "#/definitions/photo"
},
"type": "array"
},
"richText": {
"description": "The rich text of the entry",
"type": "string"
},
"starred": {
"description": "Whether the entry is starred or not",
"type": "boolean"
},
"tags": {
"description": "An array of tags",
"items": {
"type": "string"
},
"type": "array"
},
"text": {
"description": "The Markdown text of the entry",
"type": "string"
},
"timeZone": {
"description": "The time zone of the entry creation",
"type": "string"
},
"uuid": {
"description": "The UUID of the entry",
"type": "string"
},
"weather": {
"$ref": "#/definitions/weather",
"description": "The weather at the time of entry creation"
}
},
"required": [
"creationDate",
"creationDevice",
"duration",
"modifiedDate",
"starred",
"timeZone",
"uuid"
],
"type": "object"
},
"location": {
"additionalProperties": false,
"properties": {
"administrativeArea": {
"description": "The administrative area of the location",
"type": "string"
},
"country": {
"description": "The country of the location",
"type": "string"
},
"foursquareID": {
"description": "The FourSquare ID of the place",
"type": "string"
},
"latitude": {
"description": "The latitude of the location",
"type": "number"
},
"localityName": {
"description": "The name of the locality of the location",
"type": "string"
},
"longitude": {
"description": "The latitude of the location",
"type": "number"
},
"placeName": {
"description": "The name of the place",
"type": "string"
},
"region": {
"description": "The region of the location",
"properties": {
"center": {
"additionalProperties": false,
"description": "The center of the region",
"properties": {
"latitude": {
"description": "The latitude of the center",
"type": "number"
},
"longitude": {
"description": "The longitude of the center",
"type": "number"
},
"radius": {
"description": "The radius",
"type": "integer"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object"
}
},
"type": "object"
},
"timeZoneName": {
"description": "The name of the timezone of the place",
"type": "string"
},
"userLabel": {
"description": "A user label for the place",
"type": "string"
}
},
"required": [
"latitude",
"longitude",
"placeName",
"region"
],
"type": "object"
},
"photo": {
"additionalProperties": false,
"description": "A photo",
"properties": {
"appleCloudIdentifier": {
"description": "The iCloud identifier of the photo",
"type": "string"
},
"cameraMake": {
"description": "The make of the camera with which the photo was created",
"type": "string"
},
"cameraModel": {
"description": "The model of the camera with which the photo was created",
"type": "string"
},
"creationDevice": {
"description": "The name of the device on which the photo was created",
"type": "string"
},
"date": {
"description": "The date and time of when the photo was created",
"format": "date-time",
"type": "string"
},
"duration": {
"description": "The duration of the photo creation",
"type": "integer"
},
"exposureBiasValue": {
"description": "The exposure bias value of the photo",
"type": "number"
},
"favorite": {
"description": "Whether the photo is a favorite or not",
"type": "boolean"
},
"fileSize": {
"description": "The file size of the photo",
"type": "integer"
},
"filename": {
"description": "The file name of the photo",
"type": "string"
},
"fnumber": {
"description": "The fnumber of the photo",
"type": "string"
},
"focalLength": {
"description": "The focal length of the photo",
"type": "string"
},
"height": {
"description": "The height of the photo",
"type": "integer"
},
"identifier": {
"description": "The identifier of the photo",
"type": "string"
},
"isSketch": {
"description": "Whether the photo is a sketch or not",
"type": "boolean"
},
"lensMake": {
"description": "The make of the lens with which the photo was created",
"type": "string"
},
"lensModel": {
"description": "The model of the lens with which the photo was created",
"type": "string"
},
"location": {
"$ref": "#/definitions/location",
"description": "The location of where the photo was created"
},
"md5": {
"description": "The MD5 hash of the photo",
"type": "string"
},
"orderInEntry": {
"description": "The order of the photo in the entry",
"type": "integer"
},
"type": {
"description": "The type of the photo",
"type": "string"
},
"width": {
"description": "The width of the photo",
"type": "integer"
}
},
"required": [
"creationDevice",
"duration",
"fnumber",
"focalLength",
"height",
"identifier",
"isSketch",
"md5",
"orderInEntry",
"type",
"width"
],
"type": "object"
},
"weather": {
"additionalProperties": false,
"properties": {
"conditionsDescription": {
"description": "The description of the weather conditions",
"type": "string"
},
"moonPhase": {
"description": "The moon phase",
"type": "number"
},
"moonPhaseCode": {
"description": "The code of the moon phase",
"type": "string"
},
"pressureMB": {
"description": "The pressure in millibars",
"type": "number"
},
"relativeHumidity": {
"description": "The relative humidity",
"type": "integer"
},
"sunriseDate": {
"description": "The date and time of the sunrise",
"format": "date-time",
"type": "string"
},
"sunsetDate": {
"description": "The date and time of the sunset",
"format": "date-time",
"type": "string"
},
"temperatureCelsius": {
"description": "The temperature in Celsius",
"type": "number"
},
"visibilityKM": {
"description": "The visibility in kilometers",
"type": "number"
},
"weatherCode": {
"description": "The code of the weather",
"type": "string"
},
"weatherServiceName": {
"description": "The name of the weather service",
"type": "string"
},
"windBearing": {
"description": "The wind bearing",
"type": "integer"
},
"windChillCelsius": {
"description": "The wind chill in Celsius",
"type": "number"
},
"windSpeedKPH": {
"description": "The wind speed in kilometers per hour",
"type": "number"
}
},
"required": [
"conditionsDescription",
"relativeHumidity",
"temperatureCelsius",
"weatherCode",
"weatherServiceName"
],
"type": "object"
}
},
"properties": {
"entries": {
"description": "An array of entries",
"items": {
"$ref": "#/definitions/entry"
},
"type": "array"
},
"metadata": {
"additionalProperties": false,
"description": "Metadata of the journal",
"properties": {
"version": {
"description": "Version of the JSON file",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
}
},
"required": [
"entries",
"metadata"
],
"title": "DayOne JSON file",
"type": "object"
} | MIT | en |
ergebnis/day-one-to-obsidian-converter | c78cc8dd850dbb674e64ca027675df12c4b87790 | 2022-07-28T13:11:56 | resource/day-one/schema.json | 8 | 2024-05-27T05:18:22.873762Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"entry": {
"additionalProperties": false,
"description": "An entry",
"properties": {
"creationDate": {
"description": "The date and time of when the entry was created",
"format": "date-time",
"type": "string"
},
"creationDevice": {
"description": "The name of the device on which the entry was created",
"type": "string"
},
"creationDeviceModel": {
"description": "The model of the device on which the entry was created",
"type": "string"
},
"creationDeviceType": {
"description": "The type of the device on which the entry was created",
"type": "string"
},
"creationOSName": {
"description": "The name of the operating system on which the entry was created",
"type": "string"
},
"creationOSVersion": {
"description": "The version of the operating system on which the entry was created",
"type": "string"
},
"duration": {
"description": "The duration of the entry creation",
"type": "integer"
},
"editingTime": {
"description": "The editing time of the entry creation",
"type": "number"
},
"isAllDay": {
"description": "Whether the entry is for a whole day or not",
"type": "boolean"
},
"isPinned": {
"description": "Whether the entry is pinned or not",
"type": "boolean"
},
"location": {
"$ref": "#/definitions/location",
"description": "The location of the entry creation"
},
"modifiedDate": {
"description": "The date and time of when the entry was created",
"format": "date-time",
"type": "string"
},
"music": {
"$ref": "#/definitions/music",
"description": "The music that was playing when the entry was created"
},
"photos": {
"description": "The photos of the entry",
"items": {
"$ref": "#/definitions/photo"
},
"type": "array"
},
"richText": {
"description": "The rich text of the entry as JSON",
"type": "string"
},
"sourceString": {
"type": "string"
},
"starred": {
"description": "Whether the entry is starred or not",
"type": "boolean"
},
"tags": {
"description": "An array of tags",
"items": {
"type": "string"
},
"type": "array"
},
"template": {
"$ref": "#/definitions/template",
"description": "The template that was used to create the entry"
},
"text": {
"description": "The Markdown text of the entry",
"type": "string"
},
"timeZone": {
"description": "The time zone of the entry creation",
"type": "string"
},
"userActivity": {
"$ref": "#/definitions/userActivity",
"description": "The user activity at the time of entry creation"
},
"uuid": {
"description": "The UUID of the entry",
"type": "string"
},
"weather": {
"$ref": "#/definitions/weather",
"description": "The weather at the time of entry creation"
}
},
"required": [
"creationDate",
"creationDevice",
"duration",
"modifiedDate",
"starred",
"timeZone",
"uuid"
],
"type": "object"
},
"location": {
"additionalProperties": false,
"properties": {
"administrativeArea": {
"description": "The administrative area of the location",
"type": "string"
},
"country": {
"description": "The country of the location",
"type": "string"
},
"foursquareID": {
"description": "The FourSquare ID of the place",
"type": "string"
},
"latitude": {
"description": "The latitude of the location",
"type": "number"
},
"localityName": {
"description": "The name of the locality of the location",
"type": "string"
},
"longitude": {
"description": "The latitude of the location",
"type": "number"
},
"placeName": {
"description": "The name of the place",
"type": "string"
},
"region": {
"description": "The region of the location",
"properties": {
"center": {
"additionalProperties": false,
"description": "The center of the region",
"properties": {
"latitude": {
"description": "The latitude of the center",
"type": "number"
},
"longitude": {
"description": "The longitude of the center",
"type": "number"
},
"radius": {
"description": "The radius",
"type": "integer"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object"
}
},
"type": "object"
},
"timeZoneName": {
"description": "The name of the timezone of the place",
"type": "string"
},
"userLabel": {
"description": "A user label for the place",
"type": "string"
}
},
"required": [
"latitude",
"longitude",
"placeName",
"region"
],
"type": "object"
},
"music": {
"additionalProperties": false,
"description": "Music",
"properties": {
"album": {
"description": "The name of the album",
"type": "string"
},
"albumYear": {
"description": "The year of the album",
"type": "integer"
},
"artist": {
"description": "The name of the artist",
"type": "string"
},
"track": {
"description": "The name of the track",
"type": "string"
}
},
"required": [
"album",
"albumYear",
"artist",
"track"
],
"type": "object"
},
"photo": {
"additionalProperties": false,
"description": "A photo",
"properties": {
"appleCloudIdentifier": {
"description": "The iCloud identifier of the photo",
"type": "string"
},
"cameraMake": {
"description": "The make of the camera with which the photo was created",
"type": "string"
},
"cameraModel": {
"description": "The model of the camera with which the photo was created",
"type": "string"
},
"creationDevice": {
"description": "The name of the device on which the photo was created",
"type": "string"
},
"date": {
"description": "The date and time of when the photo was created",
"format": "date-time",
"type": "string"
},
"duration": {
"description": "The duration of the photo creation",
"type": "integer"
},
"exposureBiasValue": {
"description": "The exposure bias value of the photo",
"type": "number"
},
"favorite": {
"description": "Whether the photo is a favorite or not",
"type": "boolean"
},
"fileSize": {
"description": "The file size of the photo",
"type": "integer"
},
"filename": {
"description": "The file name of the photo",
"type": "string"
},
"fnumber": {
"description": "The fnumber of the photo",
"type": "string"
},
"focalLength": {
"description": "The focal length of the photo",
"type": "string"
},
"height": {
"description": "The height of the photo",
"type": "integer"
},
"identifier": {
"description": "The identifier of the photo",
"type": "string"
},
"isSketch": {
"description": "Whether the photo is a sketch or not",
"type": "boolean"
},
"lensMake": {
"description": "The make of the lens with which the photo was created",
"type": "string"
},
"lensModel": {
"description": "The model of the lens with which the photo was created",
"type": "string"
},
"location": {
"$ref": "#/definitions/location",
"description": "The location of where the photo was created"
},
"md5": {
"description": "The MD5 hash of the photo",
"type": "string"
},
"orderInEntry": {
"description": "The order of the photo in the entry",
"type": "integer"
},
"type": {
"description": "The type of the photo",
"type": "string"
},
"width": {
"description": "The width of the photo",
"type": "integer"
}
},
"required": [
"creationDevice",
"duration",
"fnumber",
"focalLength",
"height",
"identifier",
"isSketch",
"md5",
"orderInEntry",
"type",
"width"
],
"type": "object"
},
"template": {
"additionalProperties": false,
"description": "A template",
"properties": {
"richTextJSON": {
"description": "The rich text of the template as JSON",
"type": "string"
},
"title": {
"description": "The title of the template",
"type": "string"
},
"userModifiedDate": {
"description": "The date and time when the template was modified",
"format": "date-time",
"type": "string"
},
"uuid": {
"description": "The UUID of the template",
"type": "string"
}
},
"required": [
"richTextJSON",
"title",
"userModifiedDate",
"uuid"
],
"type": "object"
},
"userActivity": {
"additionalProperties": false,
"description": "A user activity",
"properties": {
"activityName": {
"description": "The name of the activity",
"type": "string"
},
"stepCount": {
"description": "The number of steps",
"type": "integer"
}
},
"type": "object"
},
"weather": {
"additionalProperties": false,
"properties": {
"conditionsDescription": {
"description": "The description of the weather conditions",
"type": "string"
},
"moonPhase": {
"description": "The moon phase",
"type": "number"
},
"moonPhaseCode": {
"description": "The code of the moon phase",
"type": "string"
},
"pressureMB": {
"description": "The pressure in millibars",
"type": "number"
},
"relativeHumidity": {
"description": "The relative humidity",
"type": "integer"
},
"sunriseDate": {
"description": "The date and time of the sunrise",
"format": "date-time",
"type": "string"
},
"sunsetDate": {
"description": "The date and time of the sunset",
"format": "date-time",
"type": "string"
},
"temperatureCelsius": {
"description": "The temperature in Celsius",
"type": "number"
},
"visibilityKM": {
"description": "The visibility in kilometers",
"type": "number"
},
"weatherCode": {
"description": "The code of the weather",
"type": "string"
},
"weatherServiceName": {
"description": "The name of the weather service",
"type": "string"
},
"windBearing": {
"description": "The wind bearing",
"type": "integer"
},
"windChillCelsius": {
"description": "The wind chill in Celsius",
"type": "number"
},
"windSpeedKPH": {
"description": "The wind speed in kilometers per hour",
"type": "number"
}
},
"required": [
"conditionsDescription",
"relativeHumidity",
"temperatureCelsius",
"weatherCode",
"weatherServiceName"
],
"type": "object"
}
},
"properties": {
"entries": {
"description": "An array of entries",
"items": {
"$ref": "#/definitions/entry"
},
"type": "array"
},
"metadata": {
"additionalProperties": false,
"description": "Metadata of the journal",
"properties": {
"version": {
"description": "Version of the JSON file",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
}
},
"required": [
"entries",
"metadata"
],
"title": "DayOne JSON file",
"type": "object"
} | MIT | en |
ergebnis/json-normalizer | d580c40127d30cb194551d0f7b94301454f51632 | 2022-12-12T06:09:45 | test/Fixture/Vendor/Composer/schema.json | 74 | 2024-05-28T06:00:00.02117Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"anyOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"bitbucket",
"git-bitbucket",
"hg",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"allow-plugins": {
"additionalProperties": {
"type": [
"boolean"
]
},
"description": "This is an object of {\"pattern\": true|false} with packages which are allowed to be loaded as plugins, or true to allow all, false to allow none. Defaults to {} which prompts when an unknown plugin is added.",
"type": [
"object",
"boolean"
]
},
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed), can be \"full\" (compatible with both Windows and Unix-based systems) and \"proxy\" (only bash-style proxy).",
"enum": [
"auto",
"full",
"proxy",
"symlink"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"bitbucket-oauth": {
"additionalProperties": {
"properties": {
"access-token": {
"description": "The OAuth token retrieved from Bitbucket's API, this is written by Composer and you should not set it nor modify it.",
"type": "string"
},
"access-token-expiration": {
"description": "The generated token's expiration timestamp, this is written by Composer and you should not set it nor modify it.",
"type": "integer"
},
"consumer-key": {
"description": "The consumer-key used for OAuth authentication",
"type": "string"
},
"consumer-secret": {
"description": "The consumer-secret used for OAuth authentication",
"type": "string"
}
},
"required": [
"consumer-key",
"consumer-secret"
],
"type": "object"
},
"description": "An object of domain name => {\"consumer-key\": \"...\", \"consumer-secret\": \"...\"}.",
"type": "object"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-read-only": {
"description": "Whether to use the Composer cache in read-only mode.",
"type": [
"boolean"
]
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"https\", \"ssh\", \"git\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"properties": {
"expires-at": {
"description": "The expiration date for this GitLab token",
"type": "integer"
},
"refresh-token": {
"description": "The refresh token used for GitLab authentication",
"type": "string"
},
"token": {
"description": "The token used for GitLab authentication",
"type": "string"
}
},
"required": [
"token"
],
"type": [
"string",
"object"
]
},
"description": "An object of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":{\"expires-at\":\"<expiration date>\", \"refresh-token\":\"<refresh token>\", \"token\":\"<token>\"}}.",
"type": "object"
},
"gitlab-protocol": {
"description": "A protocol to force use of when creating a repository URL for the `source` value of the package metadata. One of `git` or `http`. By default, Composer will generate a git URL for private repositories and http one for public repos.",
"enum": [
"git",
"http",
"https"
]
},
"gitlab-token": {
"additionalProperties": {
"properties": {
"token": {
"description": "The token used for GitLab authentication",
"type": "string"
},
"username": {
"description": "The username used for GitLab authentication",
"type": "string"
}
},
"required": [
"username",
"token"
],
"type": [
"string",
"object"
]
},
"description": "An object of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}, or an object with username and token keys.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "An object of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": [
"string",
"boolean"
]
},
"description": "This is an object of package name (keys) and version (values) that will be used to mock the platform packages on this machine, the version can be set to false to make it appear like the package is not present.",
"type": "object"
},
"platform-check": {
"description": "Defaults to \"php-only\" which checks only the PHP version. Setting to true will also check the presence of required PHP extensions. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": [
"boolean",
"string"
]
},
"preferred-install": {
"additionalProperties": {
"type": [
"string"
]
},
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or an object of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"secure-svn-domains": {
"description": "A list of domains which should be trusted/marked as using a secure Subversion/SVN transport. By default svn:// protocol is seen as insecure and will throw. This is a better/safer alternative to disabling `secure-http` altogether.",
"items": {
"type": "string"
},
"type": "array"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"use-parent-dir": {
"description": "When running Composer in a directory where there is no composer.json, if there is one present in a directory above Composer will by default ask you whether you want to use that directory's composer.json instead. One of: true (always use parent if needed), false (never ask or use it) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"enum": [
"dev",
"alpha",
"beta",
"rc",
"RC",
"stable"
],
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]|-{1,2})?[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(\\.\\d+){0,3}|^dev-",
"type": "string"
}
},
"required": [],
"title": "Package",
"type": "object"
} | MIT | en |
ergebnis/json-normalizer | 5a9c2f7efe00a21b655e9dc93fd347c5ce4c7b47 | 2023-05-02T09:58:39 | test/Fixture/Vendor/Composer/schema.json | 74 | 2024-05-28T06:00:00.02117Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"artifact-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"artifact"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"authors": {
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address of the author.",
"format": "email",
"type": "string"
},
"homepage": {
"description": "Homepage URL for the author.",
"format": "uri",
"type": "string"
},
"name": {
"description": "Full name of the author.",
"type": "string"
},
"role": {
"description": "Author's role in the project.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"autoload": {
"description": "Description of how the package can be autoloaded.",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"exclude-from-classmap": {
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"composer-repository": {
"properties": {
"allow_ssl_downgrade": {
"type": "boolean"
},
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"force-lazy-providers": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"type": "object"
},
"type": {
"enum": [
"composer"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"dist": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"shasum": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"inline-package": {
"additionalProperties": true,
"properties": {
"archive": {
"properties": {
"exclude": {
"type": "array"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"description": {
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"type": [
"object",
"array"
]
},
"homepage": {
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"license": {
"type": [
"string",
"array"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"type": "string"
},
"provide": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"package-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"package": {
"oneOf": [
{
"$ref": "#/definitions/inline-package"
},
{
"items": {
"$ref": "#/definitions/inline-package"
},
"type": "array"
}
]
},
"type": {
"enum": [
"package"
],
"type": "string"
}
},
"required": [
"type",
"package"
],
"type": "object"
},
"path-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"additionalProperties": true,
"properties": {
"symlink": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"type": {
"enum": [
"path"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"pear-repository": {
"properties": {
"canonical": {
"type": "boolean"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"pear"
],
"type": "string"
},
"url": {
"type": "string"
},
"vendor-alias": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
},
"repository": {
"anyOf": [
{
"$ref": "#/definitions/composer-repository"
},
{
"$ref": "#/definitions/vcs-repository"
},
{
"$ref": "#/definitions/path-repository"
},
{
"$ref": "#/definitions/artifact-repository"
},
{
"$ref": "#/definitions/pear-repository"
},
{
"$ref": "#/definitions/package-repository"
}
],
"type": "object"
},
"source": {
"properties": {
"mirrors": {
"type": "array"
},
"reference": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url",
"reference"
],
"type": "object"
},
"vcs-repository": {
"properties": {
"branch": {
"type": "string"
},
"branches-path": {
"type": [
"string",
"boolean"
]
},
"canonical": {
"type": "boolean"
},
"depot": {
"type": "string"
},
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"no-api": {
"type": "boolean"
},
"only": {
"items": {
"type": "string"
},
"type": "array"
},
"p4password": {
"type": "string"
},
"p4user": {
"type": "string"
},
"package-path": {
"type": "string"
},
"secure-http": {
"type": "boolean"
},
"svn-cache-credentials": {
"type": "boolean"
},
"tags-path": {
"type": [
"string",
"boolean"
]
},
"trunk-path": {
"type": [
"string",
"boolean"
]
},
"type": {
"enum": [
"vcs",
"github",
"git",
"gitlab",
"bitbucket",
"git-bitbucket",
"hg",
"fossil",
"perforce",
"svn"
],
"type": "string"
},
"unique_perforce_client_name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
},
"properties": {
"_comment": {
"description": "A key to store comments in",
"type": [
"array",
"string"
]
},
"abandoned": {
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.",
"type": [
"boolean",
"string"
]
},
"archive": {
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark.",
"type": "array"
},
"name": {
"description": "A base name for archive.",
"type": "string"
}
},
"type": [
"object"
]
},
"authors": {
"$ref": "#/definitions/authors"
},
"autoload": {
"$ref": "#/definitions/autoload"
},
"autoload-dev": {
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"classmap": {
"description": "This is an array of paths that contain classes to be included in the class-map generation process.",
"type": "array"
},
"files": {
"description": "This is an array of files that are always required on every request.",
"type": "array"
},
"psr-0": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"type": "object"
},
"psr-4": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"description": "This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"type": "object"
}
},
"type": "object"
},
"bin": {
"description": "A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"config": {
"description": "Composer options.",
"properties": {
"allow-plugins": {
"additionalProperties": {
"type": [
"boolean"
]
},
"description": "This is an object of {\"pattern\": true|false} with packages which are allowed to be loaded as plugins, or true to allow all, false to allow none. Defaults to {} which prompts when an unknown plugin is added.",
"type": [
"object",
"boolean"
]
},
"apcu-autoloader": {
"description": "If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.",
"type": "boolean"
},
"archive-dir": {
"description": "The default archive path when not provided on cli, defaults to \".\".",
"type": "string"
},
"archive-format": {
"description": "The default archiving format when not provided on cli, defaults to \"tar\".",
"type": "string"
},
"autoloader-suffix": {
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.",
"type": "string"
},
"bearer": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => bearer authentication token, for example {\"example.com\":\"<token>\"}.",
"type": "object"
},
"bin-compat": {
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed), can be \"full\" (compatible with both Windows and Unix-based systems) and \"proxy\" (only bash-style proxy).",
"enum": [
"auto",
"full",
"proxy",
"symlink"
]
},
"bin-dir": {
"description": "The location where all binaries are linked, defaults to \"vendor/bin\".",
"type": "string"
},
"bitbucket-oauth": {
"additionalProperties": {
"properties": {
"access-token": {
"description": "The OAuth token retrieved from Bitbucket's API, this is written by Composer and you should not set it nor modify it.",
"type": "string"
},
"access-token-expiration": {
"description": "The generated token's expiration timestamp, this is written by Composer and you should not set it nor modify it.",
"type": "integer"
},
"consumer-key": {
"description": "The consumer-key used for OAuth authentication",
"type": "string"
},
"consumer-secret": {
"description": "The consumer-secret used for OAuth authentication",
"type": "string"
}
},
"required": [
"consumer-key",
"consumer-secret"
],
"type": "object"
},
"description": "An object of domain name => {\"consumer-key\": \"...\", \"consumer-secret\": \"...\"}.",
"type": "object"
},
"cache-dir": {
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows.",
"type": "string"
},
"cache-files-dir": {
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\".",
"type": "string"
},
"cache-files-maxsize": {
"description": "The cache max size for the files cache, defaults to \"300MiB\".",
"type": [
"string",
"integer"
]
},
"cache-files-ttl": {
"description": "The cache time-to-live for files, defaults to the value of cache-ttl.",
"type": "integer"
},
"cache-read-only": {
"description": "Whether to use the Composer cache in read-only mode.",
"type": [
"boolean"
]
},
"cache-repo-dir": {
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\".",
"type": "string"
},
"cache-ttl": {
"description": "The default cache time-to-live, defaults to 15552000 (6 months).",
"type": "integer"
},
"cache-vcs-dir": {
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\".",
"type": "string"
},
"cafile": {
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.",
"type": "string"
},
"capath": {
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.",
"type": "string"
},
"classmap-authoritative": {
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.",
"type": "boolean"
},
"data-dir": {
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes.",
"type": "string"
},
"disable-tls": {
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.",
"type": "boolean"
},
"discard-changes": {
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\".",
"type": [
"string",
"boolean"
]
},
"github-domains": {
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"github-expose-hostname": {
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.",
"type": "boolean"
},
"github-oauth": {
"additionalProperties": {
"type": "string"
},
"description": "An object of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"type": "object"
},
"github-protocols": {
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"https\", \"ssh\", \"git\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-domains": {
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
},
"type": "array"
},
"gitlab-oauth": {
"additionalProperties": {
"properties": {
"expires-at": {
"description": "The expiration date for this GitLab token",
"type": "integer"
},
"refresh-token": {
"description": "The refresh token used for GitLab authentication",
"type": "string"
},
"token": {
"description": "The token used for GitLab authentication",
"type": "string"
}
},
"required": [
"token"
],
"type": [
"string",
"object"
]
},
"description": "An object of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":{\"expires-at\":\"<expiration date>\", \"refresh-token\":\"<refresh token>\", \"token\":\"<token>\"}}.",
"type": "object"
},
"gitlab-protocol": {
"description": "A protocol to force use of when creating a repository URL for the `source` value of the package metadata. One of `git` or `http`. By default, Composer will generate a git URL for private repositories and http one for public repos.",
"enum": [
"git",
"http",
"https"
]
},
"gitlab-token": {
"additionalProperties": {
"properties": {
"token": {
"description": "The token used for GitLab authentication",
"type": "string"
},
"username": {
"description": "The username used for GitLab authentication",
"type": "string"
}
},
"required": [
"username",
"token"
],
"type": [
"string",
"object"
]
},
"description": "An object of domain name => gitlab private tokens, typically {\"gitlab.com\":\"<token>\"}, or an object with username and token keys.",
"type": "object"
},
"htaccess-protect": {
"description": "Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.",
"type": "boolean"
},
"http-basic": {
"additionalProperties": {
"properties": {
"password": {
"description": "The password used for HTTP Basic authentication",
"type": "string"
},
"username": {
"description": "The username used for HTTP Basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"description": "An object of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"type": "object"
},
"lock": {
"description": "Defaults to true. If set to false, Composer will not create a composer.lock file.",
"type": "boolean"
},
"notify-on-install": {
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.",
"type": "boolean"
},
"optimize-autoloader": {
"description": "Always optimize when dumping the autoloader.",
"type": "boolean"
},
"platform": {
"additionalProperties": {
"type": [
"string",
"boolean"
]
},
"description": "This is an object of package name (keys) and version (values) that will be used to mock the platform packages on this machine, the version can be set to false to make it appear like the package is not present.",
"type": "object"
},
"platform-check": {
"description": "Defaults to \"php-only\" which checks only the PHP version. Setting to true will also check the presence of required PHP extensions. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.",
"type": [
"boolean",
"string"
]
},
"preferred-install": {
"additionalProperties": {
"type": [
"string"
]
},
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or an object of {\"pattern\": \"preference\"}.",
"type": [
"string",
"object"
]
},
"prepend-autoloader": {
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.",
"type": "boolean"
},
"process-timeout": {
"description": "The timeout in seconds for process executions, defaults to 300 (5mins).",
"type": "integer"
},
"secure-http": {
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative.",
"type": "boolean"
},
"secure-svn-domains": {
"description": "A list of domains which should be trusted/marked as using a secure Subversion/SVN transport. By default svn:// protocol is seen as insecure and will throw. This is a better/safer alternative to disabling `secure-http` altogether.",
"items": {
"type": "string"
},
"type": "array"
},
"sort-packages": {
"description": "Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.",
"type": "boolean"
},
"store-auths": {
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"use-github-api": {
"description": "Defaults to true. If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.",
"type": "boolean"
},
"use-include-path": {
"description": "If true, the Composer autoloader will also look for classes in the PHP include path.",
"type": "boolean"
},
"use-parent-dir": {
"description": "When running Composer in a directory where there is no composer.json, if there is one present in a directory above Composer will by default ask you whether you want to use that directory's composer.json instead. One of: true (always use parent if needed), false (never ask or use it) or \"prompt\" (ask every time), defaults to prompt.",
"type": [
"string",
"boolean"
]
},
"vendor-dir": {
"description": "The location where all packages are installed, defaults to \"vendor\".",
"type": "string"
}
},
"type": "object"
},
"conflict": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that conflict with this package.",
"type": "object"
},
"default-branch": {
"description": "Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.",
"type": [
"boolean"
]
},
"description": {
"description": "Short package description.",
"type": "string"
},
"dist": {
"$ref": "#/definitions/dist"
},
"extra": {
"additionalProperties": true,
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"type": [
"object",
"array"
]
},
"funding": {
"description": "A list of options to fund the development and maintenance of the package.",
"items": {
"properties": {
"type": {
"description": "Type of funding or platform through which funding is possible.",
"type": "string"
},
"url": {
"description": "URL to a website with details on funding and a way to fund the package.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"homepage": {
"description": "Homepage URL for the project.",
"format": "uri",
"type": "string"
},
"include-path": {
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"keywords": {
"items": {
"description": "A tag/keyword that this package relates to.",
"type": "string"
},
"type": "array"
},
"license": {
"description": "License name. Or an array of license names.",
"type": [
"string",
"array"
]
},
"minimum-stability": {
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"enum": [
"dev",
"alpha",
"beta",
"rc",
"RC",
"stable"
],
"type": [
"string"
]
},
"name": {
"description": "Package name, including 'vendor-name/' prefix.",
"pattern": "^[a-z0-9]([_.-]?[a-z0-9]+)*/[a-z0-9](([_.]|-{1,2})?[a-z0-9]+)*$",
"type": "string"
},
"non-feature-branches": {
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
},
"type": [
"array"
]
},
"prefer-stable": {
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.",
"type": [
"boolean"
]
},
"provide": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"type": "object"
},
"readme": {
"description": "Relative path to the readme document.",
"type": "string"
},
"replace": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that can be replaced by this package.",
"type": "object"
},
"repositories": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"enum": [
false
],
"type": "boolean"
}
]
},
"description": "A set of additional repositories where packages can be found.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/repository"
},
{
"additionalProperties": {
"enum": [
false
],
"type": "boolean"
},
"maxProperties": 1,
"minProperties": 1,
"type": "object"
}
]
},
"type": [
"object",
"array"
]
},
"require": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that are required to run this package.",
"type": "object"
},
"require-dev": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"type": "object"
},
"scripts": {
"description": "Script listeners that will be executed before/after some events.",
"properties": {
"post-autoload-dump": {
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-create-project-cmd": {
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-install-cmd": {
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-install": {
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-uninstall": {
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-package-update": {
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-root-package-install": {
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-status-cmd": {
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"post-update-cmd": {
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-autoload-dump": {
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-install-cmd": {
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-install": {
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-uninstall": {
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-package-update": {
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-status-cmd": {
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
},
"pre-update-cmd": {
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands.",
"type": [
"array",
"string"
]
}
},
"type": [
"object"
]
},
"scripts-descriptions": {
"additionalProperties": {
"type": "string"
},
"description": "Descriptions for custom commands, shown in console help.",
"type": [
"object"
]
},
"source": {
"$ref": "#/definitions/source"
},
"suggest": {
"additionalProperties": {
"type": "string"
},
"description": "This is an object of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"type": "object"
},
"support": {
"properties": {
"chat": {
"description": "URL to the support chat.",
"format": "uri",
"type": "string"
},
"docs": {
"description": "URL to the documentation.",
"format": "uri",
"type": "string"
},
"email": {
"description": "Email address for support.",
"format": "email",
"type": "string"
},
"forum": {
"description": "URL to the forum.",
"format": "uri",
"type": "string"
},
"irc": {
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri",
"type": "string"
},
"issues": {
"description": "URL to the issue tracker.",
"format": "uri",
"type": "string"
},
"rss": {
"description": "URL to the RSS feed.",
"format": "uri",
"type": "string"
},
"security": {
"description": "URL to the vulnerability disclosure policy (VDP).",
"format": "uri",
"type": "string"
},
"source": {
"description": "URL to browse or download the sources.",
"format": "uri",
"type": "string"
},
"wiki": {
"description": "URL to the wiki.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"time": {
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.",
"type": "string"
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"version": {
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.",
"pattern": "^v?\\d+(\\.\\d+){0,3}|^dev-",
"type": "string"
}
},
"required": [],
"title": "Package",
"type": "object"
} | MIT | en |
fharper/coffeechat | cf35d332ac16f05324a3fd0d710e5cdaf2a4fbdc | 2024-05-21T18:00:57 | schema.json | 280 | 2024-05-27T09:15:29.533941Z | {
"$defs": {
"person": {
"additionalProperties": false,
"description": "Information about one person",
"properties": {
"city": {
"description": "City where you live",
"type": "string"
},
"company": {
"description": "Employer's company name",
"type": "string"
},
"country": {
"description": "Country where you live",
"type": "string"
},
"github": {
"description": "GitHub Profile URL",
"pattern": "(^https://)|(^$)",
"type": "string"
},
"languages": {
"description": "Languages spoken well enough for a coffee chat",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"linkedin": {
"description": "LinkedIn profile URL",
"pattern": "(^https://)|(^$)",
"type": "string"
},
"mastodon": {
"description": "Mastodon account URL",
"pattern": "(^https://)|(^$)",
"type": "string"
},
"name": {
"description": "Full name",
"type": "string"
},
"online-only": {
"description": "Whether you are open to in-person Coffee Chat (default: false)",
"type": "boolean"
},
"scheduling": {
"description": "Scheduling platform URL or mailto link",
"pattern": "(^https://)|(^mailto:)",
"type": "string"
},
"title": {
"description": "Professional title",
"type": "string"
},
"topics": {
"description": "List of every topics you are de factor comfortable to discuss or give tips about",
"items": {
"maxLength": 35,
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"twitter": {
"description": "Twitter account URL",
"pattern": "(^https://)|(^$)",
"type": "string"
},
"website": {
"description": "Website URL",
"pattern": "(^https://)|(^$)",
"type": "string"
}
},
"required": [
"name",
"title",
"company",
"languages",
"linkedin",
"scheduling",
"topics"
],
"type": "object"
}
},
"$id": "coffeechat.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "List of awesome people doing coffee chat",
"properties": {
"people": {
"items": {
"$ref": "#/$defs/person"
},
"type": "array"
}
},
"title": "People",
"type": "object"
} | Unlicense | en |
fharper/coffeechat | 68781669992596203ee52ab4d2f96f5e2c09f8f5 | 2024-05-01T16:15:52 | schema.json | 280 | 2024-05-27T09:15:29.533941Z | {
"$defs": {
"person": {
"additionalProperties": false,
"description": "Information about one person",
"properties": {
"city": {
"description": "City where you live",
"type": "string"
},
"company": {
"description": "Employer's company name",
"type": "string"
},
"country": {
"description": "Country where you live",
"type": "string"
},
"languages": {
"description": "Languages spoken well enough for a coffee chat",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"linkedin": {
"$ref": "#/definitions/validURL",
"description": "LinkedIn profile URL"
},
"mastodon": {
"$ref": "#/definitions/validURL",
"description": "Mastodon account URL"
},
"name": {
"description": "Full name",
"type": "string"
},
"online-only": {
"description": "Whether you are open to in-person Coffee Chat (default: false)",
"type": "boolean"
},
"scheduling": {
"$ref": "#/definitions/validScheduling",
"description": "Scheduling platform URL or mailto link"
},
"title": {
"description": "Professional title",
"type": "string"
},
"topics": {
"description": "List of every topics you are de factor comfortable to discuss or give tips about",
"items": {
"maxLength": 40,
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"twitter": {
"$ref": "#/definitions/validURL",
"description": "Twitter account URL"
},
"website": {
"$ref": "#/definitions/validURL",
"description": "Website URL"
}
},
"required": [
"name",
"title",
"company",
"languages",
"linkedin",
"scheduling",
"topics"
],
"type": "object"
}
},
"$id": "coffeechat.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"validScheduling": {
"pattern": "(^https?://)|(^mailto:)",
"type": "string"
},
"validURL": {
"pattern": "(^https?://)|(^$)",
"type": "string"
}
},
"description": "List of awesome people doing coffee chat",
"properties": {
"people": {
"items": {
"$ref": "#/$defs/person"
},
"type": "array"
}
},
"title": "People",
"type": "object"
} | Unlicense | en |
fharper/coffeechat | b188a254d2b4867d75822a987949037f45a8e2c2 | 2024-04-30T13:47:33 | schema.json | 280 | 2024-05-27T09:15:29.533941Z | {
"$defs": {
"person": {
"additionalProperties": false,
"description": "Information about one person",
"properties": {
"city": {
"description": "City where you live",
"type": "string"
},
"company": {
"description": "Employer's company name",
"type": "string"
},
"country": {
"description": "Country where you live",
"type": "string"
},
"languages": {
"description": "Languages spoken well enough for a coffee chat",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"linkedin": {
"$ref": "#/definitions/validURL",
"description": "LinkedIn profile URL"
},
"mastodon": {
"$ref": "#/definitions/validURL",
"description": "Mastodon account URL"
},
"name": {
"description": "Full name",
"type": "string"
},
"online-only": {
"description": "Whether you are open to in-person Coffee Chat (default: false)",
"type": "boolean"
},
"scheduling": {
"$ref": "#/definitions/validScheduling",
"description": "Scheduling platform URL or mailto link"
},
"title": {
"description": "Professional title",
"type": "string"
},
"topics": {
"description": "List of every topics you are de factor comfortable to discuss or give tips about",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"twitter": {
"$ref": "#/definitions/validURL",
"description": "Twitter account URL"
},
"website": {
"$ref": "#/definitions/validURL",
"description": "Website URL"
}
},
"required": [
"name",
"title",
"company",
"languages",
"linkedin",
"scheduling",
"topics"
],
"type": "object"
}
},
"$id": "coffeechat.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"validScheduling": {
"pattern": "(^https?://)|(^mailto:)",
"type": "string"
},
"validURL": {
"pattern": "(^https?://)|(^$)",
"type": "string"
}
},
"description": "List of awesome people doing coffee chat",
"properties": {
"people": {
"items": {
"$ref": "#/$defs/person"
},
"type": "array"
}
},
"title": "People",
"type": "object"
} | Unlicense | en |
fharper/coffeechat | db17a5900f0dbc6333ff4fc2395335d6265cf299 | 2022-04-30T20:17:15 | schema.json | 280 | 2024-05-27T09:15:29.533941Z | {
"$defs": {
"person": {
"description": "Information about one person",
"properties": {
"city": {
"description": "City where you live",
"type": "string"
},
"company": {
"description": "Employer's company name",
"type": "string"
},
"country": {
"description": "Country where you live",
"type": "string"
},
"languages": {
"description": "Languages spoken well enough for a coffee chat",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"linkedin": {
"$ref": "#/definitions/validURL",
"description": "LinkedIn profile URL"
},
"name": {
"description": "Full name",
"type": "string"
},
"online-only": {
"description": "Whether you are open to in-person Coffee Chat (default: false)",
"type": "boolean"
},
"scheduling": {
"$ref": "#/definitions/validScheduling",
"description": "Scheduling platform URL or mailto link"
},
"title": {
"description": "Professional title",
"type": "string"
},
"topics": {
"description": "List of every topics you are de factor comfortable to discuss or give tips about",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"twitter": {
"$ref": "#/definitions/validURL",
"description": "Twitter account URL"
},
"website": {
"$ref": "#/definitions/validURL",
"description": "Website URL"
}
},
"required": [
"name",
"title",
"company",
"languages",
"linkedin",
"scheduling",
"topics"
],
"type": "object"
}
},
"$id": "coffeechat.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"validScheduling": {
"pattern": "(^https?://)|(^mailto:)",
"type": "string"
},
"validURL": {
"pattern": "(^https?://)|(^$)",
"type": "string"
}
},
"description": "List of awesome people doing coffee chat",
"properties": {
"people": {
"items": {
"$ref": "#/$defs/person"
},
"type": "array"
}
},
"title": "People",
"type": "object"
} | Unlicense | en |
fharper/coffeechat | d2a86d224cb08e659e42e131ac4ae13bc07712b2 | 2024-05-01T16:44:08 | schema.json | 280 | 2024-05-27T09:15:29.533941Z | {
"$defs": {
"person": {
"additionalProperties": false,
"description": "Information about one person",
"properties": {
"city": {
"description": "City where you live",
"type": "string"
},
"company": {
"description": "Employer's company name",
"type": "string"
},
"country": {
"description": "Country where you live",
"type": "string"
},
"languages": {
"description": "Languages spoken well enough for a coffee chat",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"linkedin": {
"$ref": "#/definitions/validURL",
"description": "LinkedIn profile URL"
},
"mastodon": {
"$ref": "#/definitions/validURL",
"description": "Mastodon account URL"
},
"name": {
"description": "Full name",
"type": "string"
},
"online-only": {
"description": "Whether you are open to in-person Coffee Chat (default: false)",
"type": "boolean"
},
"scheduling": {
"$ref": "#/definitions/validScheduling",
"description": "Scheduling platform URL or mailto link"
},
"title": {
"description": "Professional title",
"type": "string"
},
"topics": {
"description": "List of every topics you are de factor comfortable to discuss or give tips about",
"items": {
"maxLength": 35,
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"twitter": {
"$ref": "#/definitions/validURL",
"description": "Twitter account URL"
},
"website": {
"$ref": "#/definitions/validURL",
"description": "Website URL"
}
},
"required": [
"name",
"title",
"company",
"languages",
"linkedin",
"scheduling",
"topics"
],
"type": "object"
}
},
"$id": "coffeechat.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"validScheduling": {
"pattern": "(^https?://)|(^mailto:)",
"type": "string"
},
"validURL": {
"pattern": "(^https?://)|(^$)",
"type": "string"
}
},
"description": "List of awesome people doing coffee chat",
"properties": {
"people": {
"items": {
"$ref": "#/$defs/person"
},
"type": "array"
}
},
"title": "People",
"type": "object"
} | Unlicense | en |
fharper/coffeechat | 14536f8aa8f637bafb7ad82ed31b9687d644c472 | 2024-05-02T22:20:45 | schema.json | 280 | 2024-05-27T09:15:29.533941Z | {
"$defs": {
"person": {
"additionalProperties": false,
"description": "Information about one person",
"properties": {
"city": {
"description": "City where you live",
"type": "string"
},
"company": {
"description": "Employer's company name",
"type": "string"
},
"country": {
"description": "Country where you live",
"type": "string"
},
"languages": {
"description": "Languages spoken well enough for a coffee chat",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"linkedin": {
"description": "LinkedIn profile URL",
"pattern": "(^https://)|(^$)",
"type": "string"
},
"mastodon": {
"description": "Mastodon account URL",
"pattern": "(^https://)|(^$)",
"type": "string"
},
"name": {
"description": "Full name",
"type": "string"
},
"online-only": {
"description": "Whether you are open to in-person Coffee Chat (default: false)",
"type": "boolean"
},
"scheduling": {
"description": "Scheduling platform URL or mailto link",
"pattern": "(^https://)|(^mailto:)",
"type": "string"
},
"title": {
"description": "Professional title",
"type": "string"
},
"topics": {
"description": "List of every topics you are de factor comfortable to discuss or give tips about",
"items": {
"maxLength": 35,
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"twitter": {
"description": "Twitter account URL",
"pattern": "(^https://)|(^$)",
"type": "string"
},
"website": {
"description": "Website URL",
"pattern": "(^https://)|(^$)",
"type": "string"
}
},
"required": [
"name",
"title",
"company",
"languages",
"linkedin",
"scheduling",
"topics"
],
"type": "object"
}
},
"$id": "coffeechat.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "List of awesome people doing coffee chat",
"properties": {
"people": {
"items": {
"$ref": "#/$defs/person"
},
"type": "array"
}
},
"title": "People",
"type": "object"
} | Unlicense | en |
fharper/coffeechat | 574423977263a4aab92f639ca999c7b050411581 | 2024-04-30T13:47:08 | schema.json | 280 | 2024-05-27T09:15:29.533941Z | {
"$defs": {
"person": {
"additionalProperties": false,
"description": "Information about one person",
"properties": {
"city": {
"description": "City where you live",
"type": "string"
},
"company": {
"description": "Employer's company name",
"type": "string"
},
"country": {
"description": "Country where you live",
"type": "string"
},
"languages": {
"description": "Languages spoken well enough for a coffee chat",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"linkedin": {
"$ref": "#/definitions/validURL",
"description": "LinkedIn profile URL"
},
"mastodon": {
"$ref": "#/definitions/validURL",
"description": "Mastodon account URL"
},
"name": {
"description": "Full name",
"type": "string"
},
"online-only": {
"description": "Whether you are open to in-person Coffee Chat (default: false)",
"type": "boolean"
},
"scheduling": {
"$ref": "#/definitions/validScheduling",
"description": "Scheduling platform URL or mailto link"
},
"title": {
"description": "Professional title",
"type": "string"
},
"topics": {
"description": "List of every topics you are de factor comfortable to discuss or give tips about",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"twitter": {
"$ref": "#/definitions/validURL",
"description": "Twitter account URL"
},
"website": {
"$ref": "#/definitions/validURL",
"description": "Website URL"
}
},
"required": [
"name",
"title",
"company",
"languages",
"linkedin",
"scheduling",
"topics"
],
"type": "object"
}
},
"$id": "coffeechat.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"validScheduling": {
"pattern": "(^https?://)|(^mailto:)",
"type": "string"
},
"validURL": {
"pattern": "(^https?://)|(^$)",
"type": "string"
}
},
"description": "List of awesome people doing coffee chat",
"properties": {
"people": {
"items": {
"$ref": "#/$defs/person"
},
"type": "array"
}
},
"title": "People",
"type": "object"
} | Unlicense | en |
nautobot/helm-charts | 1a3e9c902fbb6c5a97ffae282b27c8367cb1f1da | 2023-06-04T22:42:45 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"concurrency": {
"minimum": 0,
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"metricsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"taskQueues": {
"type": "string"
}
},
"type": "object"
}
]
},
"deployment": {
"properties": {
"affinity": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/affinity.json"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/envvar.json"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volumemount.json"
},
"type": "array"
},
"extraVolumes": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volume.json"
},
"type": "array"
},
"hostAliases": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/hostalias.json"
},
"type": "array"
},
"initContainers": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"lifecycleHooks": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/lifecycle.json"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"oneOf": [
{
"$ref": "#/$defs/empty-object"
},
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/nodeselector.json"
}
]
},
"pdb": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"minimum": 1,
"type": "integer"
},
"minAvailable": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
"type": [
"object",
"null"
]
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
"type": [
"object",
"null"
]
},
"podSecurityContext": {
"$ref": "#/$defs/podSecurityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/resourcerequirements.json"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"terminationGracePeriodSeconds": {
"type": "integer"
},
"tolerations": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/toleration.json"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"type": "object"
},
"empty-object": {
"additionalProperties": false,
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"singleInit": {
"type": "boolean"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"type": "object"
}
]
},
"podSecurityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/podsecuritycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"probe": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/probe.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
}
}
]
},
"securityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/securitycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
]
},
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.beat"
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.default"
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"global": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"ingressClassName",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"initJob": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"installHook": {
"pattern": "^(post-install|pre-install)$",
"type": "string"
},
"upgradeHook": {
"pattern": "^(post-upgrade|pre-upgrade)$",
"type": "string"
}
},
"required": [
"installHook",
"upgradeHook"
]
}
]
},
"mariadb": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/ba59192a4d0b28454f072903e5186d8bb2adf43f/bitnami/mariadb/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"nautobot": {
"type": "string"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled",
"nautobot"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"nginxExporter": {
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
},
"uwsgiExporter": {
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"nginxExporter",
"prometheusRule",
"serviceMonitor",
"uwsgiExporter"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
}
]
},
"nautobots": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
},
{
"properties": {
"enabled": {
"type": "boolean"
},
"ingressPaths": {
"items": {
"type": "string"
},
"type": "array"
},
"initNautobot": {
"type": "boolean"
},
"staticFilesOnly": {
"type": "boolean"
}
},
"required": [
"enabled",
"ingressPaths",
"initNautobot"
]
}
],
"type": "object"
}
},
"type": "object"
},
"postgresql": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/d3ec8fa952007380c6001c526b027a8bb064cbab/bitnami/postgresql/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"rabbitmq": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"redis": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/6d27b518fe3bf57fb792ac42f16133177f2c4d76/bitnami/redis/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"extraPorts": {
"description": "Extra ports to expose in the nautobot service (normally used with the `sidecars` value)",
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/serviceport.json"
},
"type": "array"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"uwsgimetrics": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"extraPorts",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"automountServiceAccountToken": {
"type": "boolean"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"automountServiceAccountToken",
"create",
"name"
],
"type": "object"
},
"sops": {
"type": "object"
},
"workers": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/celery"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"workers",
"celery",
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"initJob",
"mariadb",
"metrics",
"nautobot",
"nautobots",
"postgresql",
"postgresqlha",
"rabbitmq",
"redis",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | bdfcc7110a586bb879d46fc2e0f3cd827e4563b5 | 2024-05-13T10:57:28 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"concurrency": {
"minimum": 0,
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"metricsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"taskQueues": {
"type": "string"
}
},
"type": "object"
}
]
},
"deployment": {
"properties": {
"affinity": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/affinity.json"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/envvar.json"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volumemount.json"
},
"type": "array"
},
"extraVolumes": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volume.json"
},
"type": "array"
},
"hostAliases": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/hostalias.json"
},
"type": "array"
},
"initContainers": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"lifecycleHooks": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/lifecycle.json"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/",
"type": [
"object",
"null"
],
"x-kubernetes-map-type": "atomic"
},
"pdb": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"minimum": 1,
"type": "integer"
},
"minAvailable": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"persistenceMediaFiles": {
"additionalProperties": false,
"properties": {
"accessMode": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"selector": {
"type": "object"
},
"size": {
"type": "string"
},
"storageClassName": {
"type": "string"
}
},
"required": [
"accessMode",
"enabled",
"selector",
"size",
"storageClassName"
],
"title": "Persistence",
"type": "object"
},
"persistenceStaticFiles": {
"additionalProperties": false,
"properties": {
"accessMode": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"selector": {
"type": "object"
},
"size": {
"type": "string"
},
"storageClassName": {
"type": "string"
}
},
"required": [
"accessMode",
"enabled",
"selector",
"size",
"storageClassName"
],
"title": "Persistence",
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
"type": [
"object",
"null"
]
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
"type": [
"object",
"null"
]
},
"podSecurityContext": {
"$ref": "#/$defs/podSecurityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 0,
"type": "integer"
},
"resources": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/resourcerequirements.json"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"terminationGracePeriodSeconds": {
"type": "integer"
},
"tolerations": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/toleration.json"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"type": "object"
},
"empty-object": {
"additionalProperties": false,
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql|django_prometheus\\.db\\.backends\\.postgresql|django_prometheus\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"singleInit": {
"type": "boolean"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
},
"uwsgi": {
"additionalProperties": false,
"properties": {
"bufferSize": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"harakiri": {
"type": "integer"
},
"listen": {
"minimum": 0,
"type": "integer"
},
"processes": {
"minimum": 0,
"type": "integer"
},
"threads": {
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"podSecurityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/podsecuritycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"probe": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/probe.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
}
}
]
},
"securityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/securitycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
]
},
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.beat"
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.default"
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"global": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"ingressClassName",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"initJob": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"installHook": {
"pattern": "^(post-install|pre-install)$",
"type": "string"
},
"upgradeHook": {
"pattern": "^(post-upgrade|pre-upgrade)$",
"type": "string"
}
},
"required": [
"installHook",
"upgradeHook"
]
}
]
},
"mariadb": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/ba59192a4d0b28454f072903e5186d8bb2adf43f/bitnami/mariadb/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"nautobot": {
"type": "string"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled",
"nautobot"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"nginxExporter": {
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
},
"uwsgiExporter": {
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"nginxExporter",
"prometheusRule",
"serviceMonitor",
"uwsgiExporter"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
}
]
},
"nautobots": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
},
{
"properties": {
"enabled": {
"type": "boolean"
},
"ingressPaths": {
"items": {
"type": "string"
},
"type": "array"
},
"initNautobot": {
"type": "boolean"
},
"staticFilesOnly": {
"type": "boolean"
}
},
"required": [
"enabled",
"ingressPaths",
"initNautobot"
]
}
],
"type": "object"
}
},
"type": "object"
},
"postgresql": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/d3ec8fa952007380c6001c526b027a8bb064cbab/bitnami/postgresql/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"rabbitmq": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"redis": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/6d27b518fe3bf57fb792ac42f16133177f2c4d76/bitnami/redis/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"extraPorts": {
"description": "Extra ports to expose in the nautobot service (normally used with the `sidecars` value)",
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/serviceport.json"
},
"type": "array"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"uwsgimetrics": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"extraPorts",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"automountServiceAccountToken": {
"type": "boolean"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"automountServiceAccountToken",
"create",
"name"
],
"type": "object"
},
"sops": {
"type": "object"
},
"workers": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/celery"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"workers",
"celery",
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"initJob",
"mariadb",
"metrics",
"nautobot",
"nautobots",
"postgresql",
"postgresqlha",
"rabbitmq",
"redis",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 2d6c418f56e878c60704c0f06df4da314202566f | 2022-02-16T22:36:23 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"behavior",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"pdb": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"minimum": 1,
"type": "integer"
},
"minAvailable": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"create",
"minAvailable"
],
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "array"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"capabilities": {
"properties": {
"add": {
"type": "array"
},
"drop": {
"type": "array"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"readOnlyRootFilesystem": {
"type": "boolean"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
},
"seccompProfile": {
"type": "object"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"ingressClassName",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"mariadb": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"rootPassword": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"database",
"password",
"rootPassword",
"username"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"auth",
"enabled"
],
"type": "object"
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"prometheusRule",
"serviceMonitor"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"replicaCount",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"create",
"name"
],
"type": "object"
}
},
"required": [
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"mariadb",
"metrics",
"nautobot",
"postgresql",
"postgresqlha",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 54d92389c601bc239ac13b58ec5c214f64dcdea4 | 2021-10-14T16:05:25 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"behavior",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"autoscaling",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"replicaCount",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"prometheusRule",
"serviceMonitor"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"properties": {
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"create",
"name"
],
"type": "object"
}
},
"required": [
"celeryWorker",
"commonAnnotations",
"ingress",
"nautobot",
"postgresql",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 735ce8e84906b3aa04051d7d468bb282afe7a39f | 2023-04-18T16:59:47 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"concurrency": {
"minimum": 0,
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"metricsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"taskQueues": {
"type": "string"
}
},
"type": "object"
}
]
},
"deployment": {
"properties": {
"affinity": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/affinity.json"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/envvar.json"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volumemount.json"
},
"type": "array"
},
"extraVolumes": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volume.json"
},
"type": "array"
},
"hostAliases": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/hostalias.json"
},
"type": "array"
},
"initContainers": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"lifecycleHooks": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/lifecycle.json"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"oneOf": [
{
"$ref": "#/$defs/empty-object"
},
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/nodeselector.json"
}
]
},
"pdb": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"minimum": 1,
"type": "integer"
},
"minAvailable": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
"type": [
"object",
"null"
]
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
"type": [
"object",
"null"
]
},
"podSecurityContext": {
"$ref": "#/$defs/podSecurityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/resourcerequirements.json"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"tolerations": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/toleration.json"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"type": "object"
},
"empty-object": {
"additionalProperties": false,
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"singleInit": {
"type": "boolean"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"type": "object"
}
]
},
"podSecurityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/podsecuritycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"probe": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/probe.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
}
}
]
},
"securityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/securitycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
]
},
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.beat"
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.default"
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"global": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"ingressClassName",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"initJob": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"installHook": {
"pattern": "^(post-install|pre-install)$",
"type": "string"
},
"upgradeHook": {
"pattern": "^(post-upgrade|pre-upgrade)$",
"type": "string"
}
},
"required": [
"installHook",
"upgradeHook"
]
}
]
},
"mariadb": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/ba59192a4d0b28454f072903e5186d8bb2adf43f/bitnami/mariadb/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"nautobot": {
"type": "string"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled",
"nautobot"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"nginxExporter": {
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
},
"uwsgiExporter": {
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"nginxExporter",
"prometheusRule",
"serviceMonitor",
"uwsgiExporter"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
}
]
},
"nautobots": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
},
{
"properties": {
"enabled": {
"type": "boolean"
},
"ingressPaths": {
"items": {
"type": "string"
},
"type": "array"
},
"initNautobot": {
"type": "boolean"
},
"staticFilesOnly": {
"type": "boolean"
}
},
"required": [
"enabled",
"ingressPaths",
"initNautobot"
]
}
],
"type": "object"
}
},
"type": "object"
},
"postgresql": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/d3ec8fa952007380c6001c526b027a8bb064cbab/bitnami/postgresql/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"rabbitmq": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"redis": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/6d27b518fe3bf57fb792ac42f16133177f2c4d76/bitnami/redis/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"extraPorts": {
"description": "Extra ports to expose in the nautobot service (normally used with the `sidecars` value)",
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/serviceport.json"
},
"type": "array"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"uwsgimetrics": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"extraPorts",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"automountServiceAccountToken": {
"type": "boolean"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"automountServiceAccountToken",
"create",
"name"
],
"type": "object"
},
"sops": {
"type": "object"
},
"workers": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/celery"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"workers",
"celery",
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"initJob",
"mariadb",
"metrics",
"nautobot",
"nautobots",
"postgresql",
"postgresqlha",
"rabbitmq",
"redis",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 9cb6ca6992a5f2d9cedd6974329849b60ac0865a | 2021-11-30T16:53:22 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"behavior",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"mariadb": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"rootPassword": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"database",
"password",
"rootPassword",
"username"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"auth",
"enabled"
],
"type": "object"
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"prometheusRule",
"serviceMonitor"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"replicaCount",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"create",
"name"
],
"type": "object"
}
},
"required": [
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"mariadb",
"metrics",
"nautobot",
"postgresql",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 606c1ada471d4ab8a095b74a747a7f0dfadb7a8c | 2022-02-10T14:40:06 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"behavior",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"pdb": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"minimum": 1,
"type": "integer"
},
"minAvailable": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"create",
"minAvailable"
],
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"capabilities": {
"properties": {
"add": {
"type": "array"
},
"drop": {
"type": "array"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"readOnlyRootFilesystem": {
"type": "boolean"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
},
"seccompProfile": {
"type": "object"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"ingressClassName",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"mariadb": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"rootPassword": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"database",
"password",
"rootPassword",
"username"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"auth",
"enabled"
],
"type": "object"
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"prometheusRule",
"serviceMonitor"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"replicaCount",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"create",
"name"
],
"type": "object"
}
},
"required": [
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"mariadb",
"metrics",
"nautobot",
"postgresql",
"postgresqlha",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 157d90fe8aad7fb7737a5c7a484bb485930651d3 | 2023-06-15T19:59:28 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"concurrency": {
"minimum": 0,
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"metricsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"taskQueues": {
"type": "string"
}
},
"type": "object"
}
]
},
"deployment": {
"properties": {
"affinity": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/affinity.json"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/envvar.json"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volumemount.json"
},
"type": "array"
},
"extraVolumes": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volume.json"
},
"type": "array"
},
"hostAliases": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/hostalias.json"
},
"type": "array"
},
"initContainers": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"lifecycleHooks": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/lifecycle.json"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/",
"type": [
"object",
"null"
],
"x-kubernetes-map-type": "atomic"
},
"pdb": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"minimum": 1,
"type": "integer"
},
"minAvailable": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
"type": [
"object",
"null"
]
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
"type": [
"object",
"null"
]
},
"podSecurityContext": {
"$ref": "#/$defs/podSecurityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/resourcerequirements.json"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"terminationGracePeriodSeconds": {
"type": "integer"
},
"tolerations": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/toleration.json"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"type": "object"
},
"empty-object": {
"additionalProperties": false,
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"singleInit": {
"type": "boolean"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
},
"uwsgi": {
"additionalProperties": false,
"properties": {
"bufferSize": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"listen": {
"minimum": 0,
"type": "integer"
},
"processes": {
"minimum": 0,
"type": "integer"
},
"threads": {
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"podSecurityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/podsecuritycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"probe": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/probe.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
}
}
]
},
"securityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/securitycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
]
},
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.beat"
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.default"
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"global": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"ingressClassName",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"initJob": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"installHook": {
"pattern": "^(post-install|pre-install)$",
"type": "string"
},
"upgradeHook": {
"pattern": "^(post-upgrade|pre-upgrade)$",
"type": "string"
}
},
"required": [
"installHook",
"upgradeHook"
]
}
]
},
"mariadb": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/ba59192a4d0b28454f072903e5186d8bb2adf43f/bitnami/mariadb/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"nautobot": {
"type": "string"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled",
"nautobot"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"nginxExporter": {
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
},
"uwsgiExporter": {
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"nginxExporter",
"prometheusRule",
"serviceMonitor",
"uwsgiExporter"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
}
]
},
"nautobots": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
},
{
"properties": {
"enabled": {
"type": "boolean"
},
"ingressPaths": {
"items": {
"type": "string"
},
"type": "array"
},
"initNautobot": {
"type": "boolean"
},
"staticFilesOnly": {
"type": "boolean"
}
},
"required": [
"enabled",
"ingressPaths",
"initNautobot"
]
}
],
"type": "object"
}
},
"type": "object"
},
"postgresql": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/d3ec8fa952007380c6001c526b027a8bb064cbab/bitnami/postgresql/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"rabbitmq": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"redis": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/6d27b518fe3bf57fb792ac42f16133177f2c4d76/bitnami/redis/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"extraPorts": {
"description": "Extra ports to expose in the nautobot service (normally used with the `sidecars` value)",
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/serviceport.json"
},
"type": "array"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"uwsgimetrics": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"extraPorts",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"automountServiceAccountToken": {
"type": "boolean"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"automountServiceAccountToken",
"create",
"name"
],
"type": "object"
},
"sops": {
"type": "object"
},
"workers": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/celery"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"workers",
"celery",
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"initJob",
"mariadb",
"metrics",
"nautobot",
"nautobots",
"postgresql",
"postgresqlha",
"rabbitmq",
"redis",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 611a35302fdcae7c37408170d79aedf9c40766e8 | 2022-02-17T21:42:27 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"behavior",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"pdb": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"minimum": 1,
"type": "integer"
},
"minAvailable": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"create",
"minAvailable"
],
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "array"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"capabilities": {
"properties": {
"add": {
"type": "array"
},
"drop": {
"type": "array"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"readOnlyRootFilesystem": {
"type": "boolean"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
},
"seccompProfile": {
"type": "object"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"ingressClassName",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"mariadb": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"rootPassword": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"database",
"password",
"rootPassword",
"username"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"auth",
"enabled"
],
"type": "object"
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"prometheusRule",
"serviceMonitor"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"replicaCount",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"extraPorts": {
"description": "Extra ports to expose in the nautobot service (normally used with the `sidecars` value)",
"items": {
"type": "object"
},
"type": "array"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"extraPorts",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"create",
"name"
],
"type": "object"
}
},
"required": [
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"mariadb",
"metrics",
"nautobot",
"postgresql",
"postgresqlha",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | a8873e2736945bb65703e8fe95bc59e46c83ce34 | 2023-01-30T17:20:43 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"behavior",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"pdb": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"minimum": 1,
"type": "integer"
},
"minAvailable": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"create",
"minAvailable"
],
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "array"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"capabilities": {
"properties": {
"add": {
"type": "array"
},
"drop": {
"type": "array"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"readOnlyRootFilesystem": {
"type": "boolean"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
},
"seccompProfile": {
"type": "object"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"global": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"ingressClassName",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"mariadb": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"rootPassword": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"database",
"password",
"rootPassword",
"username"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"auth",
"enabled"
],
"type": "object"
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"prometheusRule",
"serviceMonitor"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"replicaCount",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"extraPorts": {
"description": "Extra ports to expose in the nautobot service (normally used with the `sidecars` value)",
"items": {
"type": "object"
},
"type": "array"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"extraPorts",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"create",
"name"
],
"type": "object"
},
"sops": {
"type": "object"
}
},
"required": [
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"mariadb",
"metrics",
"nautobot",
"postgresql",
"postgresqlha",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | d2fa27c254d09fc38509a5dba207bc07f614ce13 | 2021-10-13T18:23:45 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"replicaCount",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"autoscaling": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"apiVersion",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"properties": {
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"create",
"name"
],
"type": "object"
}
},
"required": [
"autoscaling",
"celeryWorker",
"commonAnnotations",
"ingress",
"nautobot",
"postgresql",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 108e0646d08746ef7aea7a146c9c725e2557797c | 2021-09-24T17:42:35 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"type": [
"null",
"string"
]
},
"extraEnvVarsSecret": {
"type": [
"null",
"string"
]
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"replicaCount",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"autoscaling": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"apiVersion",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"properties": {
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"create",
"name"
],
"type": "object"
}
},
"required": [
"autoscaling",
"celeryWorker",
"commonAnnotations",
"ingress",
"nautobot",
"postgresql",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 6b2800c0e85cf8933716ce543d6f3b1a36d01480 | 2022-10-11T13:37:29 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"behavior",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"pdb": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"minimum": 1,
"type": "integer"
},
"minAvailable": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"create",
"minAvailable"
],
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "array"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"capabilities": {
"properties": {
"add": {
"type": "array"
},
"drop": {
"type": "array"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"readOnlyRootFilesystem": {
"type": "boolean"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
},
"seccompProfile": {
"type": "object"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"global": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"ingressClassName",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"mariadb": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"rootPassword": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"database",
"password",
"rootPassword",
"username"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"auth",
"enabled"
],
"type": "object"
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"prometheusRule",
"serviceMonitor"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"replicaCount",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"extraPorts": {
"description": "Extra ports to expose in the nautobot service (normally used with the `sidecars` value)",
"items": {
"type": "object"
},
"type": "array"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"extraPorts",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"create",
"name"
],
"type": "object"
}
},
"required": [
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"mariadb",
"metrics",
"nautobot",
"postgresql",
"postgresqlha",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 6249d7baacc6cbe0bc82d66501ec5f226e628f85 | 2024-04-18T06:08:03 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"concurrency": {
"minimum": 0,
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"metricsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"taskQueues": {
"type": "string"
}
},
"type": "object"
}
]
},
"deployment": {
"properties": {
"affinity": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/affinity.json"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/envvar.json"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volumemount.json"
},
"type": "array"
},
"extraVolumes": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volume.json"
},
"type": "array"
},
"hostAliases": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/hostalias.json"
},
"type": "array"
},
"initContainers": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"lifecycleHooks": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/lifecycle.json"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/",
"type": [
"object",
"null"
],
"x-kubernetes-map-type": "atomic"
},
"pdb": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"minimum": 1,
"type": "integer"
},
"minAvailable": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"persistenceStaticFiles": {
"additionalProperties": false,
"properties": {
"accessMode": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"selector": {
"type": "object"
},
"size": {
"type": "string"
},
"storageClassName": {
"type": "string"
}
},
"required": [
"accessMode",
"enabled",
"selector",
"size",
"storageClassName"
],
"title": "Persistence",
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
"type": [
"object",
"null"
]
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
"type": [
"object",
"null"
]
},
"podSecurityContext": {
"$ref": "#/$defs/podSecurityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 0,
"type": "integer"
},
"resources": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/resourcerequirements.json"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"terminationGracePeriodSeconds": {
"type": "integer"
},
"tolerations": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/toleration.json"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"type": "object"
},
"empty-object": {
"additionalProperties": false,
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql|django_prometheus\\.db\\.backends\\.postgresql|django_prometheus\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"singleInit": {
"type": "boolean"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
},
"uwsgi": {
"additionalProperties": false,
"properties": {
"bufferSize": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"harakiri": {
"type": "integer"
},
"listen": {
"minimum": 0,
"type": "integer"
},
"processes": {
"minimum": 0,
"type": "integer"
},
"threads": {
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"podSecurityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/podsecuritycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"probe": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/probe.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
}
}
]
},
"securityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/securitycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
]
},
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.beat"
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.default"
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"global": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"ingressClassName",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"initJob": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"installHook": {
"pattern": "^(post-install|pre-install)$",
"type": "string"
},
"upgradeHook": {
"pattern": "^(post-upgrade|pre-upgrade)$",
"type": "string"
}
},
"required": [
"installHook",
"upgradeHook"
]
}
]
},
"mariadb": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/ba59192a4d0b28454f072903e5186d8bb2adf43f/bitnami/mariadb/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"nautobot": {
"type": "string"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled",
"nautobot"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"nginxExporter": {
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
},
"uwsgiExporter": {
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"nginxExporter",
"prometheusRule",
"serviceMonitor",
"uwsgiExporter"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
}
]
},
"nautobots": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
},
{
"properties": {
"enabled": {
"type": "boolean"
},
"ingressPaths": {
"items": {
"type": "string"
},
"type": "array"
},
"initNautobot": {
"type": "boolean"
},
"staticFilesOnly": {
"type": "boolean"
}
},
"required": [
"enabled",
"ingressPaths",
"initNautobot"
]
}
],
"type": "object"
}
},
"type": "object"
},
"postgresql": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/d3ec8fa952007380c6001c526b027a8bb064cbab/bitnami/postgresql/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"rabbitmq": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"redis": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/6d27b518fe3bf57fb792ac42f16133177f2c4d76/bitnami/redis/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"extraPorts": {
"description": "Extra ports to expose in the nautobot service (normally used with the `sidecars` value)",
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/serviceport.json"
},
"type": "array"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"uwsgimetrics": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"extraPorts",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"automountServiceAccountToken": {
"type": "boolean"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"automountServiceAccountToken",
"create",
"name"
],
"type": "object"
},
"sops": {
"type": "object"
},
"workers": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/celery"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"workers",
"celery",
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"initJob",
"mariadb",
"metrics",
"nautobot",
"nautobots",
"postgresql",
"postgresqlha",
"rabbitmq",
"redis",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | cc7af06e0179c1a15f1c99706b2a1637e94376d3 | 2021-11-24T14:34:39 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"behavior",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"autoscaling",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"replicaCount",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"prometheusRule",
"serviceMonitor"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"create",
"name"
],
"type": "object"
}
},
"required": [
"celeryWorker",
"commonAnnotations",
"ingress",
"metrics",
"nautobot",
"postgresql",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 209fc01678fbdbc3b8dd8666a2f319006eae2768 | 2021-10-14T15:19:37 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"replicaCount",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"autoscaling": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"apiVersion",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"prometheusRule",
"serviceMonitor"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"properties": {
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"create",
"name"
],
"type": "object"
}
},
"required": [
"autoscaling",
"celeryWorker",
"commonAnnotations",
"ingress",
"nautobot",
"postgresql",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 5ccf6589c4a87d4e56a0dfb4fc55084bd077c0c7 | 2021-10-26T19:47:18 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"behavior",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"autoscaling",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"replicaCount",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"prometheusRule",
"serviceMonitor"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"create",
"name"
],
"type": "object"
}
},
"required": [
"celeryWorker",
"commonAnnotations",
"ingress",
"metrics",
"nautobot",
"postgresql",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | fc581e61380983d24a67ac32afd3b2db3290ceeb | 2024-01-17T08:38:50 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"concurrency": {
"minimum": 0,
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"metricsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"taskQueues": {
"type": "string"
}
},
"type": "object"
}
]
},
"deployment": {
"properties": {
"affinity": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/affinity.json"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/envvar.json"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volumemount.json"
},
"type": "array"
},
"extraVolumes": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volume.json"
},
"type": "array"
},
"hostAliases": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/hostalias.json"
},
"type": "array"
},
"initContainers": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"lifecycleHooks": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/lifecycle.json"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/",
"type": [
"object",
"null"
],
"x-kubernetes-map-type": "atomic"
},
"pdb": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"minimum": 1,
"type": "integer"
},
"minAvailable": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"persistenceStaticFiles": {
"additionalProperties": false,
"properties": {
"accessMode": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"selector": {
"type": "object"
},
"size": {
"type": "string"
},
"storageClassName": {
"type": "string"
}
},
"required": [
"accessMode",
"enabled",
"selector",
"size",
"storageClassName"
],
"title": "Persistence",
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
"type": [
"object",
"null"
]
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
"type": [
"object",
"null"
]
},
"podSecurityContext": {
"$ref": "#/$defs/podSecurityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 0,
"type": "integer"
},
"resources": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/resourcerequirements.json"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"terminationGracePeriodSeconds": {
"type": "integer"
},
"tolerations": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/toleration.json"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"type": "object"
},
"empty-object": {
"additionalProperties": false,
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql|django_prometheus\\.db\\.backends\\.postgresql|django_prometheus\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"singleInit": {
"type": "boolean"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
},
"uwsgi": {
"additionalProperties": false,
"properties": {
"bufferSize": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"listen": {
"minimum": 0,
"type": "integer"
},
"processes": {
"minimum": 0,
"type": "integer"
},
"threads": {
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"podSecurityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/podsecuritycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"probe": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/probe.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
}
}
]
},
"securityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/securitycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
]
},
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.beat"
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.default"
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"global": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"ingressClassName",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"initJob": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"installHook": {
"pattern": "^(post-install|pre-install)$",
"type": "string"
},
"upgradeHook": {
"pattern": "^(post-upgrade|pre-upgrade)$",
"type": "string"
}
},
"required": [
"installHook",
"upgradeHook"
]
}
]
},
"mariadb": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/ba59192a4d0b28454f072903e5186d8bb2adf43f/bitnami/mariadb/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"nautobot": {
"type": "string"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled",
"nautobot"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"nginxExporter": {
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
},
"uwsgiExporter": {
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"nginxExporter",
"prometheusRule",
"serviceMonitor",
"uwsgiExporter"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
}
]
},
"nautobots": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
},
{
"properties": {
"enabled": {
"type": "boolean"
},
"ingressPaths": {
"items": {
"type": "string"
},
"type": "array"
},
"initNautobot": {
"type": "boolean"
},
"staticFilesOnly": {
"type": "boolean"
}
},
"required": [
"enabled",
"ingressPaths",
"initNautobot"
]
}
],
"type": "object"
}
},
"type": "object"
},
"postgresql": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/d3ec8fa952007380c6001c526b027a8bb064cbab/bitnami/postgresql/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"rabbitmq": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"redis": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/6d27b518fe3bf57fb792ac42f16133177f2c4d76/bitnami/redis/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"extraPorts": {
"description": "Extra ports to expose in the nautobot service (normally used with the `sidecars` value)",
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/serviceport.json"
},
"type": "array"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"uwsgimetrics": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"extraPorts",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"automountServiceAccountToken": {
"type": "boolean"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"automountServiceAccountToken",
"create",
"name"
],
"type": "object"
},
"sops": {
"type": "object"
},
"workers": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/celery"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"workers",
"celery",
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"initJob",
"mariadb",
"metrics",
"nautobot",
"nautobots",
"postgresql",
"postgresqlha",
"rabbitmq",
"redis",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 5a9fbb7c25e93590133f1cf0917d288bff4fa16f | 2022-01-26T17:11:05 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"behavior",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"pdb": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"minimum": 1,
"type": "integer"
},
"minAvailable": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"create",
"minAvailable"
],
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"capabilities": {
"properties": {
"add": {
"type": "array"
},
"drop": {
"type": "array"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"readOnlyRootFilesystem": {
"type": "boolean"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
},
"seccompProfile": {
"type": "object"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"mariadb": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"rootPassword": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"database",
"password",
"rootPassword",
"username"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"auth",
"enabled"
],
"type": "object"
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"prometheusRule",
"serviceMonitor"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"replicaCount",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"create",
"name"
],
"type": "object"
}
},
"required": [
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"mariadb",
"metrics",
"nautobot",
"postgresql",
"postgresqlha",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 3db0c49f3f8b673f0e59c8f83a249a9324995227 | 2021-11-29T18:32:44 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"behavior",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"prometheusRule",
"serviceMonitor"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"replicaCount",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"create",
"name"
],
"type": "object"
}
},
"required": [
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"metrics",
"nautobot",
"postgresql",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | bc443d038aa02ad86c4b1f577b5dc844a5aabc62 | 2021-10-13T16:57:24 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"replicaCount",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"autoscaling": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"apiVersion",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"properties": {
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"create",
"name"
],
"type": "object"
}
},
"required": [
"autoscaling",
"celeryWorker",
"commonAnnotations",
"ingress",
"nautobot",
"postgresql",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 264742688963ecc15595d75a440ebc0f64a65ba3 | 2021-12-20T15:20:32 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"behavior",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"mariadb": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"rootPassword": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"database",
"password",
"rootPassword",
"username"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"auth",
"enabled"
],
"type": "object"
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"prometheusRule",
"serviceMonitor"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"replicaCount",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"create",
"name"
],
"type": "object"
}
},
"required": [
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"mariadb",
"metrics",
"nautobot",
"postgresql",
"postgresqlha",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 1c9b91f763107069f42af42ac392d1453f4ad486 | 2021-12-20T21:12:06 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"behavior",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"capabilities": {
"properties": {
"add": {
"type": "array"
},
"drop": {
"type": "array"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"readOnlyRootFilesystem": {
"type": "boolean"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
},
"seccompProfile": {
"type": "object"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"mariadb": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"rootPassword": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"database",
"password",
"rootPassword",
"username"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"auth",
"enabled"
],
"type": "object"
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"prometheusRule",
"serviceMonitor"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"replicaCount",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"create",
"name"
],
"type": "object"
}
},
"required": [
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"mariadb",
"metrics",
"nautobot",
"postgresql",
"postgresqlha",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 781a8e817f04a059fa3953f076b426f40704be87 | 2021-10-15T13:43:57 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"behavior",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"autoscaling",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"replicaCount",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"prometheusRule",
"serviceMonitor"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"properties": {
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"create",
"name"
],
"type": "object"
}
},
"required": [
"celeryWorker",
"commonAnnotations",
"ingress",
"metrics",
"nautobot",
"postgresql",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | abb7f6acb89802234896d576e22ca9de5bbcc7af | 2023-09-21T13:13:57 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"concurrency": {
"minimum": 0,
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"metricsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"taskQueues": {
"type": "string"
}
},
"type": "object"
}
]
},
"deployment": {
"properties": {
"affinity": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/affinity.json"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/envvar.json"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volumemount.json"
},
"type": "array"
},
"extraVolumes": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volume.json"
},
"type": "array"
},
"hostAliases": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/hostalias.json"
},
"type": "array"
},
"initContainers": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"lifecycleHooks": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/lifecycle.json"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/",
"type": [
"object",
"null"
],
"x-kubernetes-map-type": "atomic"
},
"pdb": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"minimum": 1,
"type": "integer"
},
"minAvailable": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
"type": [
"object",
"null"
]
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
"type": [
"object",
"null"
]
},
"podSecurityContext": {
"$ref": "#/$defs/podSecurityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/resourcerequirements.json"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"terminationGracePeriodSeconds": {
"type": "integer"
},
"tolerations": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/toleration.json"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"type": "object"
},
"empty-object": {
"additionalProperties": false,
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql|django_prometheus\\.db\\.backends\\.postgresql|django_prometheus\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"singleInit": {
"type": "boolean"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
},
"uwsgi": {
"additionalProperties": false,
"properties": {
"bufferSize": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"listen": {
"minimum": 0,
"type": "integer"
},
"processes": {
"minimum": 0,
"type": "integer"
},
"threads": {
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"podSecurityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/podsecuritycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"probe": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/probe.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
}
}
]
},
"securityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/securitycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
]
},
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.beat"
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.default"
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"global": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"ingressClassName",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"initJob": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"installHook": {
"pattern": "^(post-install|pre-install)$",
"type": "string"
},
"upgradeHook": {
"pattern": "^(post-upgrade|pre-upgrade)$",
"type": "string"
}
},
"required": [
"installHook",
"upgradeHook"
]
}
]
},
"mariadb": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/ba59192a4d0b28454f072903e5186d8bb2adf43f/bitnami/mariadb/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"nautobot": {
"type": "string"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled",
"nautobot"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"nginxExporter": {
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
},
"uwsgiExporter": {
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"nginxExporter",
"prometheusRule",
"serviceMonitor",
"uwsgiExporter"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
}
]
},
"nautobots": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
},
{
"properties": {
"enabled": {
"type": "boolean"
},
"ingressPaths": {
"items": {
"type": "string"
},
"type": "array"
},
"initNautobot": {
"type": "boolean"
},
"staticFilesOnly": {
"type": "boolean"
}
},
"required": [
"enabled",
"ingressPaths",
"initNautobot"
]
}
],
"type": "object"
}
},
"type": "object"
},
"postgresql": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/d3ec8fa952007380c6001c526b027a8bb064cbab/bitnami/postgresql/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"rabbitmq": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"redis": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/6d27b518fe3bf57fb792ac42f16133177f2c4d76/bitnami/redis/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"extraPorts": {
"description": "Extra ports to expose in the nautobot service (normally used with the `sidecars` value)",
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/serviceport.json"
},
"type": "array"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"uwsgimetrics": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"extraPorts",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"automountServiceAccountToken": {
"type": "boolean"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"automountServiceAccountToken",
"create",
"name"
],
"type": "object"
},
"sops": {
"type": "object"
},
"workers": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/celery"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"workers",
"celery",
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"initJob",
"mariadb",
"metrics",
"nautobot",
"nautobots",
"postgresql",
"postgresqlha",
"rabbitmq",
"redis",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | b20d5793d35a8b3dde536d6665ede5ca621fceb7 | 2023-11-29T14:20:38 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"concurrency": {
"minimum": 0,
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"metricsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"taskQueues": {
"type": "string"
}
},
"type": "object"
}
]
},
"deployment": {
"properties": {
"affinity": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/affinity.json"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/envvar.json"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volumemount.json"
},
"type": "array"
},
"extraVolumes": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volume.json"
},
"type": "array"
},
"hostAliases": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/hostalias.json"
},
"type": "array"
},
"initContainers": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"lifecycleHooks": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/lifecycle.json"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/",
"type": [
"object",
"null"
],
"x-kubernetes-map-type": "atomic"
},
"pdb": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"minimum": 1,
"type": "integer"
},
"minAvailable": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
"type": [
"object",
"null"
]
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
"type": [
"object",
"null"
]
},
"podSecurityContext": {
"$ref": "#/$defs/podSecurityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 0,
"type": "integer"
},
"resources": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/resourcerequirements.json"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"terminationGracePeriodSeconds": {
"type": "integer"
},
"tolerations": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/toleration.json"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"type": "object"
},
"empty-object": {
"additionalProperties": false,
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql|django_prometheus\\.db\\.backends\\.postgresql|django_prometheus\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"singleInit": {
"type": "boolean"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
},
"uwsgi": {
"additionalProperties": false,
"properties": {
"bufferSize": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"listen": {
"minimum": 0,
"type": "integer"
},
"processes": {
"minimum": 0,
"type": "integer"
},
"threads": {
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"podSecurityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/podsecuritycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"probe": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/probe.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
}
}
]
},
"securityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/securitycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
]
},
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.beat"
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.default"
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"global": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"ingressClassName",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"initJob": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"installHook": {
"pattern": "^(post-install|pre-install)$",
"type": "string"
},
"upgradeHook": {
"pattern": "^(post-upgrade|pre-upgrade)$",
"type": "string"
}
},
"required": [
"installHook",
"upgradeHook"
]
}
]
},
"mariadb": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/ba59192a4d0b28454f072903e5186d8bb2adf43f/bitnami/mariadb/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"nautobot": {
"type": "string"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled",
"nautobot"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"nginxExporter": {
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
},
"uwsgiExporter": {
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"nginxExporter",
"prometheusRule",
"serviceMonitor",
"uwsgiExporter"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
}
]
},
"nautobots": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
},
{
"properties": {
"enabled": {
"type": "boolean"
},
"ingressPaths": {
"items": {
"type": "string"
},
"type": "array"
},
"initNautobot": {
"type": "boolean"
},
"staticFilesOnly": {
"type": "boolean"
}
},
"required": [
"enabled",
"ingressPaths",
"initNautobot"
]
}
],
"type": "object"
}
},
"type": "object"
},
"postgresql": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/d3ec8fa952007380c6001c526b027a8bb064cbab/bitnami/postgresql/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"rabbitmq": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"redis": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/6d27b518fe3bf57fb792ac42f16133177f2c4d76/bitnami/redis/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"extraPorts": {
"description": "Extra ports to expose in the nautobot service (normally used with the `sidecars` value)",
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/serviceport.json"
},
"type": "array"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"uwsgimetrics": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"extraPorts",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"automountServiceAccountToken": {
"type": "boolean"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"automountServiceAccountToken",
"create",
"name"
],
"type": "object"
},
"sops": {
"type": "object"
},
"workers": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/celery"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"workers",
"celery",
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"initJob",
"mariadb",
"metrics",
"nautobot",
"nautobots",
"postgresql",
"postgresqlha",
"rabbitmq",
"redis",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 3a305c0219e74b56daa0663818e0b030a10e584c | 2023-06-04T23:26:17 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"concurrency": {
"minimum": 0,
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"metricsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"taskQueues": {
"type": "string"
}
},
"type": "object"
}
]
},
"deployment": {
"properties": {
"affinity": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/affinity.json"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/envvar.json"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volumemount.json"
},
"type": "array"
},
"extraVolumes": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/volume.json"
},
"type": "array"
},
"hostAliases": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/hostalias.json"
},
"type": "array"
},
"initContainers": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"lifecycleHooks": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/lifecycle.json"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/",
"type": [
"object",
"null"
],
"x-kubernetes-map-type": "atomic"
},
"pdb": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"minimum": 1,
"type": "integer"
},
"minAvailable": {
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
"type": [
"object",
"null"
]
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
"type": [
"object",
"null"
]
},
"podSecurityContext": {
"$ref": "#/$defs/podSecurityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/resourcerequirements.json"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/container.json"
},
"type": "array"
},
"terminationGracePeriodSeconds": {
"type": "integer"
},
"tolerations": {
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/toleration.json"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"type": "object"
},
"empty-object": {
"additionalProperties": false,
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"singleInit": {
"type": "boolean"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"type": "object"
}
]
},
"podSecurityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/podsecuritycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"probe": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/probe.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
}
}
]
},
"securityContext": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12/securitycontext.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"celery": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
]
},
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.beat"
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/celery"
}
],
"description": "DEPRECATED See workers.default"
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"global": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"ingressClassName",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"initJob": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"installHook": {
"pattern": "^(post-install|pre-install)$",
"type": "string"
},
"upgradeHook": {
"pattern": "^(post-upgrade|pre-upgrade)$",
"type": "string"
}
},
"required": [
"installHook",
"upgradeHook"
]
}
]
},
"mariadb": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/ba59192a4d0b28454f072903e5186d8bb2adf43f/bitnami/mariadb/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"nautobot": {
"type": "string"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled",
"nautobot"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"nginxExporter": {
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
},
"uwsgiExporter": {
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"nginxExporter",
"prometheusRule",
"serviceMonitor",
"uwsgiExporter"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
}
]
},
"nautobots": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/nautobot"
},
{
"properties": {
"enabled": {
"type": "boolean"
},
"ingressPaths": {
"items": {
"type": "string"
},
"type": "array"
},
"initNautobot": {
"type": "boolean"
},
"staticFilesOnly": {
"type": "boolean"
}
},
"required": [
"enabled",
"ingressPaths",
"initNautobot"
]
}
],
"type": "object"
}
},
"type": "object"
},
"postgresql": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/d3ec8fa952007380c6001c526b027a8bb064cbab/bitnami/postgresql/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"rabbitmq": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"redis": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/bitnami/charts/6d27b518fe3bf57fb792ac42f16133177f2c4d76/bitnami/redis/values.schema.json"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"extraPorts": {
"description": "Extra ports to expose in the nautobot service (normally used with the `sidecars` value)",
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.23.12-standalone-strict/serviceport.json"
},
"type": "array"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"uwsgimetrics": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"extraPorts",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"automountServiceAccountToken": {
"type": "boolean"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"automountServiceAccountToken",
"create",
"name"
],
"type": "object"
},
"sops": {
"type": "object"
},
"workers": {
"description": "List of Nautobot objects (matching the Nautobot spec) to create deployments for",
"patternProperties": {
"^[a-zA-Z0-9]+$": {
"allOf": [
{
"$ref": "#/$defs/celery"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
}
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"workers",
"celery",
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"initJob",
"mariadb",
"metrics",
"nautobot",
"nautobots",
"postgresql",
"postgresqlha",
"rabbitmq",
"redis",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 9895090fe574d18825042770a0e232ba4be2ee5e | 2021-10-13T20:11:54 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"replicaCount",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"autoscaling": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"apiVersion",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"properties": {
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"create",
"name"
],
"type": "object"
}
},
"required": [
"autoscaling",
"celeryWorker",
"commonAnnotations",
"ingress",
"nautobot",
"postgresql",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 46049ec21cb287951edf54f852876b4c706b0b45 | 2022-09-29T12:29:27 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"additionalProperties": false,
"properties": {
"behavior": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"behavior",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"items": {
"type": "string"
},
"type": "array"
},
"extraEnvVarsSecret": {
"items": {
"type": "string"
},
"type": "array"
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"pdb": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"maxUnavailable": {
"minimum": 1,
"type": "integer"
},
"minAvailable": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"create",
"minAvailable"
],
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"minimum": 1,
"type": "integer"
},
"sidecars": {
"type": "array"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"capabilities": {
"properties": {
"add": {
"type": "array"
},
"drop": {
"type": "array"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"readOnlyRootFilesystem": {
"type": "boolean"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
},
"seccompProfile": {
"type": "object"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": {
"type": "object"
},
"properties": {
"celeryBeat": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"additionalProperties": false,
"properties": {
"backendProtocol": {
"pattern": "^(http|https)$",
"type": "string"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"secretName": {
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"backendProtocol",
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"ingressClassName",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"mariadb": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"rootPassword": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"database",
"password",
"rootPassword",
"username"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"auth",
"enabled"
],
"type": "object"
},
"metrics": {
"additionalProperties": false,
"properties": {
"capacityMetrics": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"enabled": {
"type": "boolean"
},
"prometheusRule": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"interval": {
"type": "string"
},
"labels": {
"type": "object"
},
"scrapeTimeout": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"capacityMetrics",
"enabled",
"prometheusRule",
"serviceMonitor"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"additionalProperties": false,
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"existingSecret",
"existingSecretPasswordKey",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string"
},
"existingSecretPasswordKey": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"existingSecret",
"existingSecretPasswordKey",
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"replicaCount",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"postgresql-ha": {
"type": "object"
},
"postgresqlha": {
"properties": {
"enabled": {
"type": "boolean"
},
"pgpool": {
"properties": {
"adminPassword": {
"type": "string"
}
},
"required": [
"adminPassword"
],
"type": "object"
},
"postgresql": {
"properties": {
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"repmgrPassword": {
"type": "string"
}
},
"required": [
"password",
"postgresPassword",
"repmgrPassword"
],
"type": "object"
}
},
"required": [
"enabled",
"pgpool",
"postgresql"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"autoscaling",
"enabled",
"replicaCount"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"extraPorts": {
"description": "Extra ports to expose in the nautobot service (normally used with the `sidecars` value)",
"items": {
"type": "object"
},
"type": "array"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"extraPorts",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type:": "object"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"create",
"name"
],
"type": "object"
}
},
"required": [
"celeryBeat",
"celeryWorker",
"commonAnnotations",
"ingress",
"mariadb",
"metrics",
"nautobot",
"postgresql",
"postgresqlha",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
nautobot/helm-charts | 14c0c26a3d9d5a1243215143ebf40495f3826fb6 | 2021-09-22T21:08:09 | charts/nautobot/values.schema.json | 22 | 2024-05-28T06:12:34.782554Z | {
"$defs": {
"deployment": {
"properties": {
"affinity": {
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"containerSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"extraEnvVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"extraEnvVarsCM": {
"type": [
"null",
"string"
]
},
"extraEnvVarsSecret": {
"type": [
"null",
"string"
]
},
"extraVolumeMounts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumes": {
"items": {
"type": "object"
},
"type": "array"
},
"hostAliases": {
"items": {
"type": "object"
},
"type": "array"
},
"initContainers": {
"items": {
"type": "object"
},
"type": "array"
},
"lifecycleHooks": {
"type": "object"
},
"livenessProbe": {
"$ref": "#/$defs/probe"
},
"nodeAffinityPreset": {
"properties": {
"key": {
"type": "string"
},
"type": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"type",
"values"
],
"type": "object"
},
"nodeSelector": {
"type": "object"
},
"podAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podAnnotations": {
"type": "object"
},
"podAntiAffinityPreset": {
"pattern": "^(soft|hard|)$",
"type": "string"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/securityContext"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/$defs/probe"
},
"replicaCount": {
"minimum": 1,
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"sidecars": {
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"properties": {
"type": {
"pattern": "^(Recreate|RollingUpdate)$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"affinity",
"args",
"command",
"containerSecurityContext",
"extraEnvVars",
"extraVolumeMounts",
"extraVolumes",
"hostAliases",
"initContainers",
"lifecycleHooks",
"livenessProbe",
"nodeAffinityPreset",
"nodeSelector",
"podAffinityPreset",
"podAntiAffinityPreset",
"podAnnotations",
"podLabels",
"podSecurityContext",
"priorityClassName",
"readinessProbe",
"replicaCount",
"resources",
"sidecars",
"tolerations",
"updateStrategy"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"exec": {
"type": "object"
},
"failureThreshold": {
"minimum": 1,
"type": "integer"
},
"httpGet": {
"type": "object"
},
"initialDelaySeconds": {
"minimum": 1,
"type": "integer"
},
"periodSeconds": {
"minimum": 1,
"type": "integer"
},
"successThreshold": {
"minimum": 1,
"type": "integer"
},
"tcpSocket": {
"type": "object"
},
"timeoutSeconds": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"securityContext": {
"properties": {
"properties": {
"enabled": {
"type": "boolean"
},
"fsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsGroup": {
"minimum": 1,
"type": "integer"
},
"runAsUser": {
"minimum": 1,
"type": "integer"
}
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"$schema": "http://json-schema.org/schema#",
"additionalProperties": false,
"properties": {
"autoscaling": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"minimum": 1,
"type": "integer"
},
"metrics": {
"items": {
"type": "object"
},
"type": "array"
},
"minReplicas": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"apiVersion",
"enabled",
"minReplicas",
"maxReplicas",
"metrics"
],
"type": "object"
},
"celeryWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"common": {
"type": "object"
},
"commonAnnotations": {
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"apiVersion": {
"type": [
"null",
"string"
]
},
"enabled": {
"type": "boolean"
},
"extraHosts": {
"items": {
"type": "object"
},
"type": "array"
},
"extraPaths": {
"items": {
"type": "object"
},
"type": "array"
},
"extraTls": {
"items": {
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"path": {
"type": "string"
},
"pathType": {
"pattern": "^(Exact|Prefix|ImplementationSpecific)$",
"type": "string"
},
"tls": {
"type": "boolean"
}
},
"required": [
"enabled",
"extraHosts",
"extraPaths",
"extraTls",
"pathType",
"hostname",
"path",
"annotations",
"tls"
],
"type": "object"
},
"nautobot": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"allowedHosts": {
"type": "string"
},
"config": {
"type": "string"
},
"db": {
"properties": {
"engine": {
"pattern": "^(django\\.db\\.backends\\.postgresql|django\\.db\\.backends\\.mysql)$",
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"timeout": {
"minimum": 0,
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"engine",
"host",
"name",
"password",
"port",
"timeout",
"user"
]
},
"debug": {
"type": "boolean"
},
"extraVars": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"image": {
"properties": {
"pullPolicy": {
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"pullSecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"pullPolicy",
"pullSecrets",
"registry",
"repository",
"tag"
],
"type": "object"
},
"logLevel": {
"pattern": "^(CRITICAL|ERROR|WARNING|INFO|DEBUG)",
"type": "string"
},
"metrics": {
"type": "boolean"
},
"redis": {
"properties": {
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"ssl": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"host",
"password",
"port",
"ssl",
"username"
]
},
"secretKey": {
"type": "string"
},
"superUser": {
"properties": {
"apitoken": {
"pattern": "^([0-9A-Za-z]+|)$",
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"apitoken",
"email",
"enabled",
"username",
"password"
]
},
"uWSGIini": {
"type": "string"
}
},
"required": [
"allowedHosts",
"config",
"db",
"debug",
"extraVars",
"image",
"logLevel",
"metrics",
"redis",
"secretKey",
"superUser",
"uWSGIini"
],
"type": "object"
}
]
},
"postgresql": {
"properties": {
"enabled": {
"type": "boolean"
},
"postgresqlPassword": {
"type": "string"
}
},
"required": [
"enabled",
"postgresqlPassword"
],
"type": "object"
},
"redis": {
"properties": {
"auth": {
"properties": {
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
}
},
"required": [
"enabled",
"password"
],
"type": "object"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"auth"
],
"type": "object"
},
"rqWorker": {
"allOf": [
{
"$ref": "#/$defs/deployment"
},
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
]
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"type:": "object"
},
"clusterIP": {
"description": "Optional, clusterIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"externalTrafficPolicy": {
"description": "External Traffic Policy: https://kubernetes.io/docs/concepts/services-networking/service/",
"pattern": "^(Cluster|Local)$",
"type": "string"
},
"httpsPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"loadBalancerIP": {
"description": "Optional, loadBalancerIP, should match IPv4 or IPv6: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
"pattern": "^((?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4})$",
"type": [
"null",
"string"
]
},
"loadBalancerSourceRanges": {
"items": {
"type": "string"
},
"type": "array"
},
"nodePorts": {
"properties": {
"http": {
"description": "Node Port to use for the http service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"https": {
"description": "Node Port to use for the https service, the default range is 30000-32767 however this can be changed with --service-node-port-range",
"maximum": 65535,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Service Type: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types",
"pattern": "^(ExternalName|ClusterIP|NodePort|LoadBalancer)$",
"type": "string"
}
},
"required": [
"annotations",
"externalTrafficPolicy",
"httpsPort",
"loadBalancerSourceRanges",
"nodePorts",
"port",
"type"
],
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"create",
"name"
],
"type": "object"
}
},
"required": [
"autoscaling",
"celeryWorker",
"commonAnnotations",
"ingress",
"nautobot",
"postgresql",
"redis",
"rqWorker",
"service",
"serviceAccount"
],
"type": "object"
} | Apache-2.0 | en |
Subsets and Splits