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 |
---|---|---|---|---|---|---|---|---|
FlowFuse/helm | ad8dd5a3392c10ec3a80753fa489864e27f26410 | 2024-01-15T09:01:13 | helm/flowforge/values.schema.json | 5 | 2024-05-27T04:56:22.465614Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"editors": {
"properties": {
"serviceAccount": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"create": {
"type": "boolean"
},
"name": {
"description": "Name of service account (scope of uniqueness is a 'Projects' namespace)",
"type": "string"
}
},
"required": [
"annotations",
"name"
],
"type": "object"
}
},
"required": [
"serviceAccount"
],
"type": "object"
},
"forge": {
"if": {
"properties": {
"localPostgresql": {
"enum": [
false
]
}
}
},
"properties": {
"affinity": {
"type": "object"
},
"aws": {
"properties": {
"IAMRole": {
"type": "string"
}
},
"type": "object"
},
"baseURL": {
"type": "string"
},
"branding": {
"type": "object"
},
"broker": {
"properties": {
"affinity": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"public_url": {
"type": "string"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"url": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"cloudProvider": {
"type": "string"
},
"clusterRole": {
"properties": {
"name": {
"description": "Name of cluster role",
"type": "string"
}
},
"type": "object"
},
"contentSecurityPolicy": {
"properties": {
"directives": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"reportOnly": {
"type": "boolean"
},
"reportUri": {
"type": "string"
}
},
"type": "object"
},
"dbName": {
"type": "string"
},
"dbPassword": {
"type": "string"
},
"dbUsername": {
"type": "string"
},
"domain": {
"pattern": "^([a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,25}$",
"type": "string"
},
"ee": {
"properties": {
"billing": {
"properties": {
"stripe": {
"properties": {
"device_price": {
"type": "string"
},
"device_product": {
"type": "string"
},
"key": {
"type": "string"
},
"new_customer_free_credit": {
"type": "integer"
},
"project_price": {
"type": "string"
},
"project_product": {
"type": "string"
},
"team_price": {
"type": "string"
},
"team_product": {
"type": "string"
},
"teams": {
"type": "object"
},
"wh_secret": {
"type": "string"
}
},
"required": [
"key",
"wh_secret",
"team_price",
"team_product",
"project_price",
"project_product"
],
"type": "object"
}
},
"required": [
"stripe"
],
"type": "object"
}
},
"required": [
"billing"
],
"type": "object"
},
"email": {
"properties": {
"from": {
"type": "string"
},
"ses": {
"properties": {
"region": {
"type": "string"
}
},
"required": [
"region"
],
"type": "object"
},
"smtp": {
"properties": {
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"type": "integer"
},
"tls": {
"type": "boolean"
},
"user": {
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
}
},
"type": "object"
},
"entryPoint": {
"type": "string"
},
"fileStore": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"enabled": {
"type": "boolean"
},
"options": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"type",
"options"
]
},
"type": "object"
},
"https": {
"type": "boolean"
},
"image": {
"type": "string"
},
"localPostgresql": {
"type": "boolean"
},
"managementSelector": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"postgres": {
"properties": {
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"ssl": {
"type": "boolean"
}
},
"required": [
"host"
],
"type": "object"
},
"projectDeploymentTolerations": {
"default": [],
"items": {
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"effect",
"key",
"operator",
"value"
],
"type": "object"
},
"type": "array"
},
"projectNamespace": {
"type": "string"
},
"projectSelector": {
"type": "object"
},
"rateLimits": {
"properties": {
"enabled": {
"type": "boolean"
},
"global": {
"type": "boolean"
},
"max": {
"type": "integer"
},
"maxAnonymous": {
"type": "integer"
},
"timeWindow": {
"type": "integer"
}
},
"type": "object"
},
"registry": {
"type": "string"
},
"registrySecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"support": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"enabled": {
"type": "boolean"
},
"hubspot": {
"type": "integer"
}
},
"then": {
"required": [
"hubspot"
]
},
"type": "object"
},
"telemetry": {
"properties": {
"backend": {
"properties": {
"prometheus": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"plausible": {
"type": "string"
},
"posthog": {
"properties": {
"apikey": {
"type": "string"
},
"apiurl": {
"type": "string"
},
"capture_pageview": {
"type": "boolean"
}
},
"required": [
"apikey"
],
"type": "object"
},
"sentry": {
"properties": {
"backend_dsn": {
"type": "string"
},
"environment": {
"type": "string"
},
"frontend_dsn": {
"type": "string"
},
"production_mode": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"domain",
"dbUsername",
"dbPassword"
],
"then": {
"required": [
"postgres"
]
},
"type": "object"
},
"ingress": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"className": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"forge"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
FlowFuse/helm | afd704fdb50b5bfc2cf6bec39cf792071108b9c2 | 2024-02-06T09:18:59 | helm/flowforge/values.schema.json | 5 | 2024-05-27T04:56:22.465614Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"else": {
"properties": {
"postgresql": {
"required": [
"auth"
]
}
}
},
"if": {
"properties": {
"forge": {
"properties": {
"localPostgresql": {
"const": false
}
}
}
}
},
"properties": {
"editors": {
"properties": {
"serviceAccount": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"create": {
"type": "boolean"
},
"name": {
"description": "Name of service account (scope of uniqueness is a 'Projects' namespace)",
"type": "string"
}
},
"required": [
"annotations",
"name"
],
"type": "object"
}
},
"required": [
"serviceAccount"
],
"type": "object"
},
"forge": {
"properties": {
"affinity": {
"type": "object"
},
"aws": {
"properties": {
"IAMRole": {
"type": "string"
}
},
"type": "object"
},
"baseURL": {
"type": "string"
},
"branding": {
"type": "object"
},
"broker": {
"properties": {
"affinity": {
"type": "object"
},
"containerSecurityContext": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"public_url": {
"type": "string"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"url": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"cloudProvider": {
"type": "string"
},
"clusterRole": {
"properties": {
"name": {
"description": "Name of cluster role",
"type": "string"
}
},
"type": "object"
},
"containerSecurityContext": {
"type": "object"
},
"contentSecurityPolicy": {
"properties": {
"directives": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"reportOnly": {
"type": "boolean"
},
"reportUri": {
"type": "string"
}
},
"type": "object"
},
"domain": {
"pattern": "^([a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,25}$",
"type": "string"
},
"ee": {
"properties": {
"billing": {
"properties": {
"stripe": {
"properties": {
"device_price": {
"type": "string"
},
"device_product": {
"type": "string"
},
"key": {
"type": "string"
},
"new_customer_free_credit": {
"type": "integer"
},
"project_price": {
"type": "string"
},
"project_product": {
"type": "string"
},
"team_price": {
"type": "string"
},
"team_product": {
"type": "string"
},
"teams": {
"type": "object"
},
"wh_secret": {
"type": "string"
}
},
"required": [
"key",
"wh_secret",
"team_price",
"team_product",
"project_price",
"project_product"
],
"type": "object"
}
},
"required": [
"stripe"
],
"type": "object"
}
},
"required": [
"billing"
],
"type": "object"
},
"email": {
"properties": {
"from": {
"type": "string"
},
"ses": {
"properties": {
"region": {
"type": "string"
}
},
"required": [
"region"
],
"type": "object"
},
"smtp": {
"properties": {
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"type": "integer"
},
"tls": {
"type": "boolean"
},
"user": {
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
}
},
"type": "object"
},
"entryPoint": {
"type": "string"
},
"fileStore": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"containerSecurityContext": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"options": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"type",
"options"
]
},
"type": "object"
},
"https": {
"type": "boolean"
},
"image": {
"type": "string"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"localPostgresql": {
"type": "boolean"
},
"logPassthrough": {
"type": "boolean"
},
"managementSelector": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"projectDeploymentTolerations": {
"default": [],
"items": {
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"effect",
"key",
"operator",
"value"
],
"type": "object"
},
"type": "array"
},
"projectNamespace": {
"type": "string"
},
"projectSelector": {
"type": "object"
},
"rateLimits": {
"properties": {
"enabled": {
"type": "boolean"
},
"global": {
"type": "boolean"
},
"max": {
"type": "integer"
},
"maxAnonymous": {
"type": "integer"
},
"timeWindow": {
"type": "integer"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"registry": {
"type": "string"
},
"registrySecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"support": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"enabled": {
"type": "boolean"
},
"hubspot": {
"type": "integer"
}
},
"then": {
"required": [
"hubspot"
]
},
"type": "object"
},
"telemetry": {
"properties": {
"backend": {
"properties": {
"prometheus": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"plausible": {
"type": "string"
},
"posthog": {
"properties": {
"apikey": {
"type": "string"
},
"apiurl": {
"type": "string"
},
"capture_pageview": {
"type": "boolean"
}
},
"required": [
"apikey"
],
"type": "object"
},
"sentry": {
"properties": {
"backend_dsn": {
"type": "string"
},
"environment": {
"type": "string"
},
"frontend_dsn": {
"type": "string"
},
"production_mode": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"domain",
"localPostgresql"
],
"type": "object"
},
"ingress": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"certManagerIssuer": {
"type": "string"
},
"className": {
"type": "string"
}
},
"type": "object"
},
"postgresql": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"username",
"password",
"database"
],
"type": "object"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"ssl": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"forge",
"postgresql"
],
"then": {
"properties": {
"postgresql": {
"required": [
"host",
"auth"
]
}
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
FlowFuse/helm | a8dad30bdbf334a7c809c7976ee7e09a630800fb | 2024-04-12T15:25:12 | helm/flowforge/values.schema.json | 5 | 2024-05-27T04:56:22.465614Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"else": {
"properties": {
"postgresql": {
"required": [
"auth"
]
}
}
},
"if": {
"properties": {
"forge": {
"properties": {
"localPostgresql": {
"const": false
}
}
}
}
},
"properties": {
"editors": {
"properties": {
"serviceAccount": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"create": {
"type": "boolean"
},
"name": {
"description": "Name of service account (scope of uniqueness is a 'Projects' namespace)",
"type": "string"
}
},
"required": [
"annotations",
"name"
],
"type": "object"
}
},
"required": [
"serviceAccount"
],
"type": "object"
},
"forge": {
"properties": {
"affinity": {
"type": "object"
},
"aws": {
"properties": {
"IAMRole": {
"type": "string"
}
},
"type": "object"
},
"baseURL": {
"type": "string"
},
"branding": {
"type": "object"
},
"broker": {
"properties": {
"affinity": {
"type": "object"
},
"containerSecurityContext": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"hostname": {
"type": "string"
},
"ingress": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
}
},
"type": "object"
},
"labels": {
"type": "object"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"public_url": {
"type": "string"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"url": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"cloudProvider": {
"type": "string"
},
"clusterRole": {
"properties": {
"name": {
"description": "Name of cluster role",
"type": "string"
}
},
"type": "object"
},
"containerSecurityContext": {
"type": "object"
},
"contentSecurityPolicy": {
"properties": {
"directives": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"reportOnly": {
"type": "boolean"
},
"reportUri": {
"type": "string"
}
},
"type": "object"
},
"domain": {
"pattern": "^([a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,25}$",
"type": "string"
},
"ee": {
"properties": {
"billing": {
"properties": {
"stripe": {
"properties": {
"device_price": {
"type": "string"
},
"device_product": {
"type": "string"
},
"key": {
"type": "string"
},
"new_customer_free_credit": {
"type": "integer"
},
"project_price": {
"type": "string"
},
"project_product": {
"type": "string"
},
"team_price": {
"type": "string"
},
"team_product": {
"type": "string"
},
"teams": {
"type": "object"
},
"wh_secret": {
"type": "string"
}
},
"required": [
"key",
"wh_secret",
"team_price",
"team_product",
"project_price",
"project_product"
],
"type": "object"
}
},
"required": [
"stripe"
],
"type": "object"
}
},
"required": [
"billing"
],
"type": "object"
},
"email": {
"properties": {
"from": {
"type": "string"
},
"ses": {
"properties": {
"region": {
"type": "string"
}
},
"required": [
"region"
],
"type": "object"
},
"smtp": {
"properties": {
"existingSecret": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"type": "integer"
},
"tls": {
"type": "boolean"
},
"user": {
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
}
},
"type": "object"
},
"entryPoint": {
"type": "string"
},
"fileStore": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"containerSecurityContext": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"image": {
"type": "string"
},
"labels": {
"type": "object"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"options": {
"type": "object"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"type",
"options"
]
},
"type": "object"
},
"https": {
"type": "boolean"
},
"image": {
"type": "string"
},
"labels": {
"type": "object"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"localPostgresql": {
"type": "boolean"
},
"logPassthrough": {
"type": "boolean"
},
"managementSelector": {
"type": "object"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"projectDeploymentTolerations": {
"default": [],
"items": {
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"effect",
"key",
"operator",
"value"
],
"type": "object"
},
"type": "array"
},
"projectNamespace": {
"type": "string"
},
"projectNetworkPolicy": {
"properties": {
"egress": {
"type": "array"
},
"enabled": {
"type": "boolean"
},
"ingress": {
"type": "array"
}
},
"type": "object"
},
"projectSelector": {
"type": "object"
},
"rateLimits": {
"properties": {
"enabled": {
"type": "boolean"
},
"global": {
"type": "boolean"
},
"max": {
"type": "integer"
},
"maxAnonymous": {
"type": "integer"
},
"timeWindow": {
"type": "integer"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"registry": {
"type": "string"
},
"registrySecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"replicas": {
"type": "integer"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"support": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"enabled": {
"type": "boolean"
},
"hubspot": {
"type": "integer"
}
},
"then": {
"required": [
"hubspot"
]
},
"type": "object"
},
"telemetry": {
"properties": {
"backend": {
"properties": {
"prometheus": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"google": {
"properties": {
"events": {
"type": "object"
},
"tag": {
"type": "string"
}
},
"required": [
"tag"
],
"type": "object"
},
"plausible": {
"type": "string"
},
"posthog": {
"properties": {
"apikey": {
"type": "string"
},
"apiurl": {
"type": "string"
},
"capture_pageview": {
"type": "boolean"
}
},
"required": [
"apikey"
],
"type": "object"
},
"sentry": {
"properties": {
"backend_dsn": {
"type": "string"
},
"environment": {
"type": "string"
},
"frontend_dsn": {
"type": "string"
},
"production_mode": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"domain",
"localPostgresql"
],
"type": "object"
},
"ingress": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"certManagerIssuer": {
"type": "string"
},
"className": {
"type": "string"
}
},
"type": "object"
},
"postgresql": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"username",
"password",
"database"
],
"type": "object"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"ssl": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"forge",
"postgresql"
],
"then": {
"properties": {
"postgresql": {
"required": [
"host",
"auth"
]
}
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
FlowFuse/helm | 7a9a727cf3ca46202e5bec11fc785297e8602173 | 2024-02-27T20:11:59 | helm/flowforge/values.schema.json | 5 | 2024-05-27T04:56:22.465614Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"else": {
"properties": {
"postgresql": {
"required": [
"auth"
]
}
}
},
"if": {
"properties": {
"forge": {
"properties": {
"localPostgresql": {
"const": false
}
}
}
}
},
"properties": {
"editors": {
"properties": {
"serviceAccount": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"create": {
"type": "boolean"
},
"name": {
"description": "Name of service account (scope of uniqueness is a 'Projects' namespace)",
"type": "string"
}
},
"required": [
"annotations",
"name"
],
"type": "object"
}
},
"required": [
"serviceAccount"
],
"type": "object"
},
"forge": {
"properties": {
"affinity": {
"type": "object"
},
"aws": {
"properties": {
"IAMRole": {
"type": "string"
}
},
"type": "object"
},
"baseURL": {
"type": "string"
},
"branding": {
"type": "object"
},
"broker": {
"properties": {
"affinity": {
"type": "object"
},
"containerSecurityContext": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"ingress": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
}
},
"type": "object"
},
"labels": {
"type": "object"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"public_url": {
"type": "string"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"url": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"cloudProvider": {
"type": "string"
},
"clusterRole": {
"properties": {
"name": {
"description": "Name of cluster role",
"type": "string"
}
},
"type": "object"
},
"containerSecurityContext": {
"type": "object"
},
"contentSecurityPolicy": {
"properties": {
"directives": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"reportOnly": {
"type": "boolean"
},
"reportUri": {
"type": "string"
}
},
"type": "object"
},
"domain": {
"pattern": "^([a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,25}$",
"type": "string"
},
"ee": {
"properties": {
"billing": {
"properties": {
"stripe": {
"properties": {
"device_price": {
"type": "string"
},
"device_product": {
"type": "string"
},
"key": {
"type": "string"
},
"new_customer_free_credit": {
"type": "integer"
},
"project_price": {
"type": "string"
},
"project_product": {
"type": "string"
},
"team_price": {
"type": "string"
},
"team_product": {
"type": "string"
},
"teams": {
"type": "object"
},
"wh_secret": {
"type": "string"
}
},
"required": [
"key",
"wh_secret",
"team_price",
"team_product",
"project_price",
"project_product"
],
"type": "object"
}
},
"required": [
"stripe"
],
"type": "object"
}
},
"required": [
"billing"
],
"type": "object"
},
"email": {
"properties": {
"from": {
"type": "string"
},
"ses": {
"properties": {
"region": {
"type": "string"
}
},
"required": [
"region"
],
"type": "object"
},
"smtp": {
"properties": {
"existingSecret": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"type": "integer"
},
"tls": {
"type": "boolean"
},
"user": {
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
}
},
"type": "object"
},
"entryPoint": {
"type": "string"
},
"fileStore": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"containerSecurityContext": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"image": {
"type": "string"
},
"labels": {
"type": "object"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"options": {
"type": "object"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"type",
"options"
]
},
"type": "object"
},
"https": {
"type": "boolean"
},
"image": {
"type": "string"
},
"labels": {
"type": "object"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"localPostgresql": {
"type": "boolean"
},
"logPassthrough": {
"type": "boolean"
},
"managementSelector": {
"type": "object"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"projectDeploymentTolerations": {
"default": [],
"items": {
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"effect",
"key",
"operator",
"value"
],
"type": "object"
},
"type": "array"
},
"projectNamespace": {
"type": "string"
},
"projectNetworkPolicy": {
"properties": {
"egress": {
"type": "array"
},
"enabled": {
"type": "boolean"
},
"ingress": {
"type": "array"
}
},
"type": "object"
},
"projectSelector": {
"type": "object"
},
"rateLimits": {
"properties": {
"enabled": {
"type": "boolean"
},
"global": {
"type": "boolean"
},
"max": {
"type": "integer"
},
"maxAnonymous": {
"type": "integer"
},
"timeWindow": {
"type": "integer"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"registry": {
"type": "string"
},
"registrySecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"support": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"enabled": {
"type": "boolean"
},
"hubspot": {
"type": "integer"
}
},
"then": {
"required": [
"hubspot"
]
},
"type": "object"
},
"telemetry": {
"properties": {
"backend": {
"properties": {
"prometheus": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"google": {
"properties": {
"events": {
"type": "object"
},
"tag": {
"type": "string"
}
},
"required": [
"tag"
],
"type": "object"
},
"plausible": {
"type": "string"
},
"posthog": {
"properties": {
"apikey": {
"type": "string"
},
"apiurl": {
"type": "string"
},
"capture_pageview": {
"type": "boolean"
}
},
"required": [
"apikey"
],
"type": "object"
},
"sentry": {
"properties": {
"backend_dsn": {
"type": "string"
},
"environment": {
"type": "string"
},
"frontend_dsn": {
"type": "string"
},
"production_mode": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"domain",
"localPostgresql"
],
"type": "object"
},
"ingress": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"certManagerIssuer": {
"type": "string"
},
"className": {
"type": "string"
}
},
"type": "object"
},
"postgresql": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"username",
"password",
"database"
],
"type": "object"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"ssl": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"forge",
"postgresql"
],
"then": {
"properties": {
"postgresql": {
"required": [
"host",
"auth"
]
}
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
FlowFuse/helm | 7de174211c08362c1a5413b6407e8801d35ac1b9 | 2024-01-12T11:30:22 | helm/flowforge/values.schema.json | 5 | 2024-05-27T04:56:22.465614Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"editors": {
"properties": {
"serviceAccount": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"create": {
"type": "boolean"
},
"name": {
"description": "Name of service account (scope of uniqueness is a 'Projects' namespace)",
"type": "string"
}
},
"required": [
"annotations",
"name"
],
"type": "object"
}
},
"required": [
"serviceAccount"
],
"type": "object"
},
"forge": {
"if": {
"properties": {
"localPostgresql": {
"enum": [
false
]
}
}
},
"properties": {
"affinity": {
"type": "object"
},
"aws": {
"properties": {
"IAMRole": {
"type": "string"
}
},
"type": "object"
},
"baseURL": {
"type": "string"
},
"branding": {
"type": "object"
},
"broker": {
"properties": {
"affinity": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"public_url": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"cloudProvider": {
"type": "string"
},
"clusterRole": {
"properties": {
"name": {
"description": "Name of cluster role",
"type": "string"
}
},
"type": "object"
},
"contentSecurityPolicy": {
"properties": {
"directives": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"reportOnly": {
"type": "boolean"
},
"reportUri": {
"type": "string"
}
},
"type": "object"
},
"dbName": {
"type": "string"
},
"dbPassword": {
"type": "string"
},
"dbUsername": {
"type": "string"
},
"domain": {
"pattern": "^([a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,25}$",
"type": "string"
},
"ee": {
"properties": {
"billing": {
"properties": {
"stripe": {
"properties": {
"device_price": {
"type": "string"
},
"device_product": {
"type": "string"
},
"key": {
"type": "string"
},
"new_customer_free_credit": {
"type": "integer"
},
"project_price": {
"type": "string"
},
"project_product": {
"type": "string"
},
"team_price": {
"type": "string"
},
"team_product": {
"type": "string"
},
"teams": {
"type": "object"
},
"wh_secret": {
"type": "string"
}
},
"required": [
"key",
"wh_secret",
"team_price",
"team_product",
"project_price",
"project_product"
],
"type": "object"
}
},
"required": [
"stripe"
],
"type": "object"
}
},
"required": [
"billing"
],
"type": "object"
},
"email": {
"properties": {
"from": {
"type": "string"
},
"ses": {
"properties": {
"region": {
"type": "string"
}
},
"required": [
"region"
],
"type": "object"
},
"smtp": {
"properties": {
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"type": "integer"
},
"tls": {
"type": "boolean"
},
"user": {
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
}
},
"type": "object"
},
"entryPoint": {
"type": "string"
},
"fileStore": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"enabled": {
"type": "boolean"
},
"options": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"type",
"options"
]
},
"type": "object"
},
"https": {
"type": "boolean"
},
"image": {
"type": "string"
},
"localPostgresql": {
"type": "boolean"
},
"managementSelector": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"postgres": {
"properties": {
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"ssl": {
"type": "boolean"
}
},
"required": [
"host"
],
"type": "object"
},
"projectDeploymentTolerations": {
"default": [],
"items": {
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"effect",
"key",
"operator",
"value"
],
"type": "object"
},
"type": "array"
},
"projectNamespace": {
"type": "string"
},
"projectSelector": {
"type": "object"
},
"rateLimits": {
"properties": {
"enabled": {
"type": "boolean"
},
"global": {
"type": "boolean"
},
"max": {
"type": "integer"
},
"maxAnonymous": {
"type": "integer"
},
"timeWindow": {
"type": "integer"
}
},
"type": "object"
},
"registry": {
"type": "string"
},
"registrySecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"support": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"enabled": {
"type": "boolean"
},
"hubspot": {
"type": "integer"
}
},
"then": {
"required": [
"hubspot"
]
},
"type": "object"
},
"telemetry": {
"properties": {
"backend": {
"properties": {
"prometheus": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"plausible": {
"type": "string"
},
"posthog": {
"properties": {
"apikey": {
"type": "string"
},
"apiurl": {
"type": "string"
},
"capture_pageview": {
"type": "boolean"
}
},
"required": [
"apikey"
],
"type": "object"
},
"sentry": {
"properties": {
"backend_dsn": {
"type": "string"
},
"environment": {
"type": "string"
},
"frontend_dsn": {
"type": "string"
},
"production_mode": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"domain",
"dbUsername",
"dbPassword"
],
"then": {
"required": [
"postgres"
]
},
"type": "object"
},
"ingress": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"className": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"forge"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
FlowFuse/helm | c5491fadd61047b2375950087da411b8bbb5c4a1 | 2023-11-21T08:39:52 | helm/flowforge/values.schema.json | 5 | 2024-05-27T04:56:22.465614Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"editors": {
"properties": {
"serviceAccount": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"create": {
"type": "boolean"
},
"name": {
"description": "Name of service account (scope of uniqueness is a 'Projects' namespace)",
"type": "string"
}
},
"required": [
"annotations",
"name"
],
"type": "object"
}
},
"required": [
"serviceAccount"
],
"type": "object"
},
"forge": {
"if": {
"properties": {
"localPostgresql": {
"enum": [
false
]
}
}
},
"properties": {
"affinity": {
"type": "object"
},
"aws": {
"properties": {
"IAMRole": {
"type": "string"
}
},
"type": "object"
},
"baseURL": {
"type": "string"
},
"branding": {
"type": "object"
},
"broker": {
"properties": {
"affinity": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"public_url": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"cloudProvider": {
"type": "string"
},
"contentSecurityPolicy": {
"properties": {
"directives": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"reportOnly": {
"type": "boolean"
},
"reportUri": {
"type": "string"
}
},
"type": "object"
},
"dbName": {
"type": "string"
},
"dbPassword": {
"type": "string"
},
"dbUsername": {
"type": "string"
},
"domain": {
"pattern": "^([a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,6}$",
"type": "string"
},
"ee": {
"properties": {
"billing": {
"properties": {
"stripe": {
"properties": {
"device_price": {
"type": "string"
},
"device_product": {
"type": "string"
},
"key": {
"type": "string"
},
"new_customer_free_credit": {
"type": "integer"
},
"project_price": {
"type": "string"
},
"project_product": {
"type": "string"
},
"team_price": {
"type": "string"
},
"team_product": {
"type": "string"
},
"teams": {
"type": "object"
},
"wh_secret": {
"type": "string"
}
},
"required": [
"key",
"wh_secret",
"team_price",
"team_product",
"project_price",
"project_product"
],
"type": "object"
}
},
"required": [
"stripe"
],
"type": "object"
}
},
"required": [
"billing"
],
"type": "object"
},
"email": {
"properties": {
"from": {
"type": "string"
},
"ses": {
"properties": {
"region": {
"type": "string"
}
},
"required": [
"region"
],
"type": "object"
},
"smtp": {
"properties": {
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"type": "integer"
},
"tls": {
"type": "boolean"
},
"user": {
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
}
},
"type": "object"
},
"entryPoint": {
"type": "string"
},
"fileStore": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"enabled": {
"type": "boolean"
},
"options": {
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"type",
"options"
]
},
"type": "object"
},
"https": {
"type": "boolean"
},
"image": {
"type": "string"
},
"localPostgresql": {
"type": "boolean"
},
"managementSelector": {
"type": "object"
},
"postgres": {
"properties": {
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"ssl": {
"type": "boolean"
}
},
"required": [
"host"
],
"type": "object"
},
"projectDeploymentTolerations": {
"default": [],
"items": {
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"effect",
"key",
"operator",
"value"
],
"type": "object"
},
"type": "array"
},
"projectNamespace": {
"type": "string"
},
"projectSelector": {
"type": "object"
},
"rateLimits": {
"properties": {
"enabled": {
"type": "boolean"
},
"global": {
"type": "boolean"
},
"max": {
"type": "integer"
},
"maxAnonymous": {
"type": "integer"
},
"timeWindow": {
"type": "integer"
}
},
"type": "object"
},
"registry": {
"type": "string"
},
"registrySecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"support": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"enabled": {
"type": "boolean"
},
"hubspot": {
"type": "integer"
}
},
"then": {
"required": [
"hubspot"
]
},
"type": "object"
},
"telemetry": {
"properties": {
"backend": {
"properties": {
"prometheus": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"plausible": {
"type": "string"
},
"posthog": {
"properties": {
"apikey": {
"type": "string"
},
"apiurl": {
"type": "string"
},
"capture_pageview": {
"type": "boolean"
}
},
"required": [
"apikey"
],
"type": "object"
},
"sentry": {
"properties": {
"backend_dsn": {
"type": "string"
},
"environment": {
"type": "string"
},
"frontend_dsn": {
"type": "string"
},
"production_mode": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"domain",
"dbUsername",
"dbPassword"
],
"then": {
"required": [
"postgres"
]
},
"type": "object"
},
"ingress": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"className": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"forge"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
FlowFuse/helm | 9712e04b92675116f49d7879df3d84182d09eded | 2024-02-01T14:51:40 | helm/flowforge/values.schema.json | 5 | 2024-05-27T04:56:22.465614Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"else": {
"properties": {
"postgresql": {
"required": [
"auth"
]
}
}
},
"if": {
"properties": {
"forge": {
"properties": {
"localPostgresql": {
"const": false
}
}
}
}
},
"properties": {
"editors": {
"properties": {
"serviceAccount": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"create": {
"type": "boolean"
},
"name": {
"description": "Name of service account (scope of uniqueness is a 'Projects' namespace)",
"type": "string"
}
},
"required": [
"annotations",
"name"
],
"type": "object"
}
},
"required": [
"serviceAccount"
],
"type": "object"
},
"forge": {
"properties": {
"affinity": {
"type": "object"
},
"aws": {
"properties": {
"IAMRole": {
"type": "string"
}
},
"type": "object"
},
"baseURL": {
"type": "string"
},
"branding": {
"type": "object"
},
"broker": {
"properties": {
"affinity": {
"type": "object"
},
"containerSecurityContext": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"public_url": {
"type": "string"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"url": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"cloudProvider": {
"type": "string"
},
"clusterRole": {
"properties": {
"name": {
"description": "Name of cluster role",
"type": "string"
}
},
"type": "object"
},
"containerSecurityContext": {
"type": "object"
},
"contentSecurityPolicy": {
"properties": {
"directives": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"reportOnly": {
"type": "boolean"
},
"reportUri": {
"type": "string"
}
},
"type": "object"
},
"domain": {
"pattern": "^([a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,25}$",
"type": "string"
},
"ee": {
"properties": {
"billing": {
"properties": {
"stripe": {
"properties": {
"device_price": {
"type": "string"
},
"device_product": {
"type": "string"
},
"key": {
"type": "string"
},
"new_customer_free_credit": {
"type": "integer"
},
"project_price": {
"type": "string"
},
"project_product": {
"type": "string"
},
"team_price": {
"type": "string"
},
"team_product": {
"type": "string"
},
"teams": {
"type": "object"
},
"wh_secret": {
"type": "string"
}
},
"required": [
"key",
"wh_secret",
"team_price",
"team_product",
"project_price",
"project_product"
],
"type": "object"
}
},
"required": [
"stripe"
],
"type": "object"
}
},
"required": [
"billing"
],
"type": "object"
},
"email": {
"properties": {
"from": {
"type": "string"
},
"ses": {
"properties": {
"region": {
"type": "string"
}
},
"required": [
"region"
],
"type": "object"
},
"smtp": {
"properties": {
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"type": "integer"
},
"tls": {
"type": "boolean"
},
"user": {
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
}
},
"type": "object"
},
"entryPoint": {
"type": "string"
},
"fileStore": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"containerSecurityContext": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"options": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"type",
"options"
]
},
"type": "object"
},
"https": {
"type": "boolean"
},
"image": {
"type": "string"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"localPostgresql": {
"type": "boolean"
},
"managementSelector": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"projectDeploymentTolerations": {
"default": [],
"items": {
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"effect",
"key",
"operator",
"value"
],
"type": "object"
},
"type": "array"
},
"projectNamespace": {
"type": "string"
},
"projectSelector": {
"type": "object"
},
"rateLimits": {
"properties": {
"enabled": {
"type": "boolean"
},
"global": {
"type": "boolean"
},
"max": {
"type": "integer"
},
"maxAnonymous": {
"type": "integer"
},
"timeWindow": {
"type": "integer"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"registry": {
"type": "string"
},
"registrySecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"support": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"enabled": {
"type": "boolean"
},
"hubspot": {
"type": "integer"
}
},
"then": {
"required": [
"hubspot"
]
},
"type": "object"
},
"telemetry": {
"properties": {
"backend": {
"properties": {
"prometheus": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"plausible": {
"type": "string"
},
"posthog": {
"properties": {
"apikey": {
"type": "string"
},
"apiurl": {
"type": "string"
},
"capture_pageview": {
"type": "boolean"
}
},
"required": [
"apikey"
],
"type": "object"
},
"sentry": {
"properties": {
"backend_dsn": {
"type": "string"
},
"environment": {
"type": "string"
},
"frontend_dsn": {
"type": "string"
},
"production_mode": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"domain",
"localPostgresql"
],
"type": "object"
},
"ingress": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"certManagerIssuer": {
"type": "string"
},
"className": {
"type": "string"
}
},
"type": "object"
},
"postgresql": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"username",
"password",
"database"
],
"type": "object"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"ssl": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"forge",
"postgresql"
],
"then": {
"properties": {
"postgresql": {
"required": [
"host",
"auth"
]
}
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
FlowFuse/helm | c18aeb6f128da7389b4b2c8bbd62518c95e5d815 | 2024-02-07T21:47:03 | helm/flowforge/values.schema.json | 5 | 2024-05-27T04:56:22.465614Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"else": {
"properties": {
"postgresql": {
"required": [
"auth"
]
}
}
},
"if": {
"properties": {
"forge": {
"properties": {
"localPostgresql": {
"const": false
}
}
}
}
},
"properties": {
"editors": {
"properties": {
"serviceAccount": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"create": {
"type": "boolean"
},
"name": {
"description": "Name of service account (scope of uniqueness is a 'Projects' namespace)",
"type": "string"
}
},
"required": [
"annotations",
"name"
],
"type": "object"
}
},
"required": [
"serviceAccount"
],
"type": "object"
},
"forge": {
"properties": {
"affinity": {
"type": "object"
},
"aws": {
"properties": {
"IAMRole": {
"type": "string"
}
},
"type": "object"
},
"baseURL": {
"type": "string"
},
"branding": {
"type": "object"
},
"broker": {
"properties": {
"affinity": {
"type": "object"
},
"containerSecurityContext": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"public_url": {
"type": "string"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"url": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"cloudProvider": {
"type": "string"
},
"clusterRole": {
"properties": {
"name": {
"description": "Name of cluster role",
"type": "string"
}
},
"type": "object"
},
"containerSecurityContext": {
"type": "object"
},
"contentSecurityPolicy": {
"properties": {
"directives": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"reportOnly": {
"type": "boolean"
},
"reportUri": {
"type": "string"
}
},
"type": "object"
},
"domain": {
"pattern": "^([a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,25}$",
"type": "string"
},
"ee": {
"properties": {
"billing": {
"properties": {
"stripe": {
"properties": {
"device_price": {
"type": "string"
},
"device_product": {
"type": "string"
},
"key": {
"type": "string"
},
"new_customer_free_credit": {
"type": "integer"
},
"project_price": {
"type": "string"
},
"project_product": {
"type": "string"
},
"team_price": {
"type": "string"
},
"team_product": {
"type": "string"
},
"teams": {
"type": "object"
},
"wh_secret": {
"type": "string"
}
},
"required": [
"key",
"wh_secret",
"team_price",
"team_product",
"project_price",
"project_product"
],
"type": "object"
}
},
"required": [
"stripe"
],
"type": "object"
}
},
"required": [
"billing"
],
"type": "object"
},
"email": {
"properties": {
"from": {
"type": "string"
},
"ses": {
"properties": {
"region": {
"type": "string"
}
},
"required": [
"region"
],
"type": "object"
},
"smtp": {
"properties": {
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"type": "integer"
},
"tls": {
"type": "boolean"
},
"user": {
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
}
},
"type": "object"
},
"entryPoint": {
"type": "string"
},
"fileStore": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"containerSecurityContext": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"options": {
"type": "object"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"type",
"options"
]
},
"type": "object"
},
"https": {
"type": "boolean"
},
"image": {
"type": "string"
},
"labels": {
"type": "object"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"localPostgresql": {
"type": "boolean"
},
"logPassthrough": {
"type": "boolean"
},
"managementSelector": {
"type": "object"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"projectDeploymentTolerations": {
"default": [],
"items": {
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"effect",
"key",
"operator",
"value"
],
"type": "object"
},
"type": "array"
},
"projectNamespace": {
"type": "string"
},
"projectSelector": {
"type": "object"
},
"rateLimits": {
"properties": {
"enabled": {
"type": "boolean"
},
"global": {
"type": "boolean"
},
"max": {
"type": "integer"
},
"maxAnonymous": {
"type": "integer"
},
"timeWindow": {
"type": "integer"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"registry": {
"type": "string"
},
"registrySecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"support": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"enabled": {
"type": "boolean"
},
"hubspot": {
"type": "integer"
}
},
"then": {
"required": [
"hubspot"
]
},
"type": "object"
},
"telemetry": {
"properties": {
"backend": {
"properties": {
"prometheus": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"plausible": {
"type": "string"
},
"posthog": {
"properties": {
"apikey": {
"type": "string"
},
"apiurl": {
"type": "string"
},
"capture_pageview": {
"type": "boolean"
}
},
"required": [
"apikey"
],
"type": "object"
},
"sentry": {
"properties": {
"backend_dsn": {
"type": "string"
},
"environment": {
"type": "string"
},
"frontend_dsn": {
"type": "string"
},
"production_mode": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"domain",
"localPostgresql"
],
"type": "object"
},
"ingress": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"certManagerIssuer": {
"type": "string"
},
"className": {
"type": "string"
}
},
"type": "object"
},
"postgresql": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"username",
"password",
"database"
],
"type": "object"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"ssl": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"forge",
"postgresql"
],
"then": {
"properties": {
"postgresql": {
"required": [
"host",
"auth"
]
}
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
FlowFuse/helm | 31c44736f8615ed4bb61b219cee9e89c38f935c0 | 2023-12-01T17:56:09 | helm/flowforge/values.schema.json | 5 | 2024-05-27T04:56:22.465614Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"editors": {
"properties": {
"serviceAccount": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"create": {
"type": "boolean"
},
"name": {
"description": "Name of service account (scope of uniqueness is a 'Projects' namespace)",
"type": "string"
}
},
"required": [
"annotations",
"name"
],
"type": "object"
}
},
"required": [
"serviceAccount"
],
"type": "object"
},
"forge": {
"if": {
"properties": {
"localPostgresql": {
"enum": [
false
]
}
}
},
"properties": {
"affinity": {
"type": "object"
},
"aws": {
"properties": {
"IAMRole": {
"type": "string"
}
},
"type": "object"
},
"baseURL": {
"type": "string"
},
"branding": {
"type": "object"
},
"broker": {
"properties": {
"affinity": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"public_url": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"cloudProvider": {
"type": "string"
},
"clusterRole": {
"properties": {
"name": {
"description": "Name of cluster role",
"type": "string"
}
},
"type": "object"
},
"contentSecurityPolicy": {
"properties": {
"directives": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"reportOnly": {
"type": "boolean"
},
"reportUri": {
"type": "string"
}
},
"type": "object"
},
"dbName": {
"type": "string"
},
"dbPassword": {
"type": "string"
},
"dbUsername": {
"type": "string"
},
"domain": {
"pattern": "^([a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,25}$",
"type": "string"
},
"ee": {
"properties": {
"billing": {
"properties": {
"stripe": {
"properties": {
"device_price": {
"type": "string"
},
"device_product": {
"type": "string"
},
"key": {
"type": "string"
},
"new_customer_free_credit": {
"type": "integer"
},
"project_price": {
"type": "string"
},
"project_product": {
"type": "string"
},
"team_price": {
"type": "string"
},
"team_product": {
"type": "string"
},
"teams": {
"type": "object"
},
"wh_secret": {
"type": "string"
}
},
"required": [
"key",
"wh_secret",
"team_price",
"team_product",
"project_price",
"project_product"
],
"type": "object"
}
},
"required": [
"stripe"
],
"type": "object"
}
},
"required": [
"billing"
],
"type": "object"
},
"email": {
"properties": {
"from": {
"type": "string"
},
"ses": {
"properties": {
"region": {
"type": "string"
}
},
"required": [
"region"
],
"type": "object"
},
"smtp": {
"properties": {
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"type": "integer"
},
"tls": {
"type": "boolean"
},
"user": {
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
}
},
"type": "object"
},
"entryPoint": {
"type": "string"
},
"fileStore": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"enabled": {
"type": "boolean"
},
"options": {
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"type",
"options"
]
},
"type": "object"
},
"https": {
"type": "boolean"
},
"image": {
"type": "string"
},
"localPostgresql": {
"type": "boolean"
},
"managementSelector": {
"type": "object"
},
"postgres": {
"properties": {
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"ssl": {
"type": "boolean"
}
},
"required": [
"host"
],
"type": "object"
},
"projectDeploymentTolerations": {
"default": [],
"items": {
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"effect",
"key",
"operator",
"value"
],
"type": "object"
},
"type": "array"
},
"projectNamespace": {
"type": "string"
},
"projectSelector": {
"type": "object"
},
"rateLimits": {
"properties": {
"enabled": {
"type": "boolean"
},
"global": {
"type": "boolean"
},
"max": {
"type": "integer"
},
"maxAnonymous": {
"type": "integer"
},
"timeWindow": {
"type": "integer"
}
},
"type": "object"
},
"registry": {
"type": "string"
},
"registrySecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"support": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"enabled": {
"type": "boolean"
},
"hubspot": {
"type": "integer"
}
},
"then": {
"required": [
"hubspot"
]
},
"type": "object"
},
"telemetry": {
"properties": {
"backend": {
"properties": {
"prometheus": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"plausible": {
"type": "string"
},
"posthog": {
"properties": {
"apikey": {
"type": "string"
},
"apiurl": {
"type": "string"
},
"capture_pageview": {
"type": "boolean"
}
},
"required": [
"apikey"
],
"type": "object"
},
"sentry": {
"properties": {
"backend_dsn": {
"type": "string"
},
"environment": {
"type": "string"
},
"frontend_dsn": {
"type": "string"
},
"production_mode": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"domain",
"dbUsername",
"dbPassword"
],
"then": {
"required": [
"postgres"
]
},
"type": "object"
},
"ingress": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"className": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"forge"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
FlowFuse/helm | 4a4f58e44bf9f527768f75af246182f2b758d730 | 2024-02-15T14:02:07 | helm/flowforge/values.schema.json | 5 | 2024-05-27T04:56:22.465614Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"else": {
"properties": {
"postgresql": {
"required": [
"auth"
]
}
}
},
"if": {
"properties": {
"forge": {
"properties": {
"localPostgresql": {
"const": false
}
}
}
}
},
"properties": {
"editors": {
"properties": {
"serviceAccount": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"create": {
"type": "boolean"
},
"name": {
"description": "Name of service account (scope of uniqueness is a 'Projects' namespace)",
"type": "string"
}
},
"required": [
"annotations",
"name"
],
"type": "object"
}
},
"required": [
"serviceAccount"
],
"type": "object"
},
"forge": {
"properties": {
"affinity": {
"type": "object"
},
"aws": {
"properties": {
"IAMRole": {
"type": "string"
}
},
"type": "object"
},
"baseURL": {
"type": "string"
},
"branding": {
"type": "object"
},
"broker": {
"properties": {
"affinity": {
"type": "object"
},
"containerSecurityContext": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"labels": {
"type": "object"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"public_url": {
"type": "string"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"url": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"cloudProvider": {
"type": "string"
},
"clusterRole": {
"properties": {
"name": {
"description": "Name of cluster role",
"type": "string"
}
},
"type": "object"
},
"containerSecurityContext": {
"type": "object"
},
"contentSecurityPolicy": {
"properties": {
"directives": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"reportOnly": {
"type": "boolean"
},
"reportUri": {
"type": "string"
}
},
"type": "object"
},
"domain": {
"pattern": "^([a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,25}$",
"type": "string"
},
"ee": {
"properties": {
"billing": {
"properties": {
"stripe": {
"properties": {
"device_price": {
"type": "string"
},
"device_product": {
"type": "string"
},
"key": {
"type": "string"
},
"new_customer_free_credit": {
"type": "integer"
},
"project_price": {
"type": "string"
},
"project_product": {
"type": "string"
},
"team_price": {
"type": "string"
},
"team_product": {
"type": "string"
},
"teams": {
"type": "object"
},
"wh_secret": {
"type": "string"
}
},
"required": [
"key",
"wh_secret",
"team_price",
"team_product",
"project_price",
"project_product"
],
"type": "object"
}
},
"required": [
"stripe"
],
"type": "object"
}
},
"required": [
"billing"
],
"type": "object"
},
"email": {
"properties": {
"from": {
"type": "string"
},
"ses": {
"properties": {
"region": {
"type": "string"
}
},
"required": [
"region"
],
"type": "object"
},
"smtp": {
"properties": {
"existingSecret": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"type": "integer"
},
"tls": {
"type": "boolean"
},
"user": {
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
}
},
"type": "object"
},
"entryPoint": {
"type": "string"
},
"fileStore": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"containerSecurityContext": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"image": {
"type": "string"
},
"labels": {
"type": "object"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"options": {
"type": "object"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"type",
"options"
]
},
"type": "object"
},
"https": {
"type": "boolean"
},
"image": {
"type": "string"
},
"labels": {
"type": "object"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"localPostgresql": {
"type": "boolean"
},
"logPassthrough": {
"type": "boolean"
},
"managementSelector": {
"type": "object"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"projectDeploymentTolerations": {
"default": [],
"items": {
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"effect",
"key",
"operator",
"value"
],
"type": "object"
},
"type": "array"
},
"projectNamespace": {
"type": "string"
},
"projectSelector": {
"type": "object"
},
"rateLimits": {
"properties": {
"enabled": {
"type": "boolean"
},
"global": {
"type": "boolean"
},
"max": {
"type": "integer"
},
"maxAnonymous": {
"type": "integer"
},
"timeWindow": {
"type": "integer"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"registry": {
"type": "string"
},
"registrySecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"support": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"enabled": {
"type": "boolean"
},
"hubspot": {
"type": "integer"
}
},
"then": {
"required": [
"hubspot"
]
},
"type": "object"
},
"telemetry": {
"properties": {
"backend": {
"properties": {
"prometheus": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"google": {
"properties": {
"events": {
"type": "object"
},
"tag": {
"type": "string"
}
},
"required": [
"tag"
],
"type": "object"
},
"plausible": {
"type": "string"
},
"posthog": {
"properties": {
"apikey": {
"type": "string"
},
"apiurl": {
"type": "string"
},
"capture_pageview": {
"type": "boolean"
}
},
"required": [
"apikey"
],
"type": "object"
},
"sentry": {
"properties": {
"backend_dsn": {
"type": "string"
},
"environment": {
"type": "string"
},
"frontend_dsn": {
"type": "string"
},
"production_mode": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"domain",
"localPostgresql"
],
"type": "object"
},
"ingress": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"certManagerIssuer": {
"type": "string"
},
"className": {
"type": "string"
}
},
"type": "object"
},
"postgresql": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"username",
"password",
"database"
],
"type": "object"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"ssl": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"forge",
"postgresql"
],
"then": {
"properties": {
"postgresql": {
"required": [
"host",
"auth"
]
}
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
FlowFuse/helm | 8926ab82c2f4f3a5c7cfd2dbb0bef6c9de96a28f | 2024-02-21T12:07:34 | helm/flowforge/values.schema.json | 5 | 2024-05-27T04:56:22.465614Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"else": {
"properties": {
"postgresql": {
"required": [
"auth"
]
}
}
},
"if": {
"properties": {
"forge": {
"properties": {
"localPostgresql": {
"const": false
}
}
}
}
},
"properties": {
"editors": {
"properties": {
"serviceAccount": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"create": {
"type": "boolean"
},
"name": {
"description": "Name of service account (scope of uniqueness is a 'Projects' namespace)",
"type": "string"
}
},
"required": [
"annotations",
"name"
],
"type": "object"
}
},
"required": [
"serviceAccount"
],
"type": "object"
},
"forge": {
"properties": {
"affinity": {
"type": "object"
},
"aws": {
"properties": {
"IAMRole": {
"type": "string"
}
},
"type": "object"
},
"baseURL": {
"type": "string"
},
"branding": {
"type": "object"
},
"broker": {
"properties": {
"affinity": {
"type": "object"
},
"containerSecurityContext": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"ingress": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
}
},
"type": "object"
},
"labels": {
"type": "object"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"public_url": {
"type": "string"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"url": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"cloudProvider": {
"type": "string"
},
"clusterRole": {
"properties": {
"name": {
"description": "Name of cluster role",
"type": "string"
}
},
"type": "object"
},
"containerSecurityContext": {
"type": "object"
},
"contentSecurityPolicy": {
"properties": {
"directives": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"reportOnly": {
"type": "boolean"
},
"reportUri": {
"type": "string"
}
},
"type": "object"
},
"domain": {
"pattern": "^([a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,25}$",
"type": "string"
},
"ee": {
"properties": {
"billing": {
"properties": {
"stripe": {
"properties": {
"device_price": {
"type": "string"
},
"device_product": {
"type": "string"
},
"key": {
"type": "string"
},
"new_customer_free_credit": {
"type": "integer"
},
"project_price": {
"type": "string"
},
"project_product": {
"type": "string"
},
"team_price": {
"type": "string"
},
"team_product": {
"type": "string"
},
"teams": {
"type": "object"
},
"wh_secret": {
"type": "string"
}
},
"required": [
"key",
"wh_secret",
"team_price",
"team_product",
"project_price",
"project_product"
],
"type": "object"
}
},
"required": [
"stripe"
],
"type": "object"
}
},
"required": [
"billing"
],
"type": "object"
},
"email": {
"properties": {
"from": {
"type": "string"
},
"ses": {
"properties": {
"region": {
"type": "string"
}
},
"required": [
"region"
],
"type": "object"
},
"smtp": {
"properties": {
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"type": "integer"
},
"tls": {
"type": "boolean"
},
"user": {
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
}
},
"type": "object"
},
"entryPoint": {
"type": "string"
},
"fileStore": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"containerSecurityContext": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"image": {
"type": "string"
},
"labels": {
"type": "object"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"options": {
"type": "object"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"type",
"options"
]
},
"type": "object"
},
"https": {
"type": "boolean"
},
"image": {
"type": "string"
},
"labels": {
"type": "object"
},
"livenessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"localPostgresql": {
"type": "boolean"
},
"logPassthrough": {
"type": "boolean"
},
"managementSelector": {
"type": "object"
},
"podLabels": {
"type": "object"
},
"podSecurityContext": {
"properties": {
"fsGroup": {
"type": "integer"
},
"runAsGroup": {
"type": "integer"
},
"runAsUser": {
"type": "integer"
},
"seccompProfile": {
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"projectDeploymentTolerations": {
"default": [],
"items": {
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"effect",
"key",
"operator",
"value"
],
"type": "object"
},
"type": "array"
},
"projectNamespace": {
"type": "string"
},
"projectSelector": {
"type": "object"
},
"rateLimits": {
"properties": {
"enabled": {
"type": "boolean"
},
"global": {
"type": "boolean"
},
"max": {
"type": "integer"
},
"maxAnonymous": {
"type": "integer"
},
"timeWindow": {
"type": "integer"
}
},
"type": "object"
},
"readinessProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"registry": {
"type": "string"
},
"registrySecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"properties": {
"limits": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"type": [
"number",
"string"
]
},
"memory": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"support": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"enabled": {
"type": "boolean"
},
"hubspot": {
"type": "integer"
}
},
"then": {
"required": [
"hubspot"
]
},
"type": "object"
},
"telemetry": {
"properties": {
"backend": {
"properties": {
"prometheus": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"google": {
"properties": {
"events": {
"type": "object"
},
"tag": {
"type": "string"
}
},
"required": [
"tag"
],
"type": "object"
},
"plausible": {
"type": "string"
},
"posthog": {
"properties": {
"apikey": {
"type": "string"
},
"apiurl": {
"type": "string"
},
"capture_pageview": {
"type": "boolean"
}
},
"required": [
"apikey"
],
"type": "object"
},
"sentry": {
"properties": {
"backend_dsn": {
"type": "string"
},
"environment": {
"type": "string"
},
"frontend_dsn": {
"type": "string"
},
"production_mode": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"domain",
"localPostgresql"
],
"type": "object"
},
"ingress": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"certManagerIssuer": {
"type": "string"
},
"className": {
"type": "string"
}
},
"type": "object"
},
"postgresql": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"postgresPassword": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"username",
"password",
"database"
],
"type": "object"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"ssl": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"forge",
"postgresql"
],
"then": {
"properties": {
"postgresql": {
"required": [
"host",
"auth"
]
}
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
FlowFuse/helm | b2ff1411cc6dcd47e0ed9208ba882013bd8bf2eb | 2023-11-09T14:10:43 | helm/flowforge/values.schema.json | 5 | 2024-05-27T04:56:22.465614Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"editors": {
"properties": {
"serviceAccount": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"create": {
"type": "boolean"
},
"name": {
"description": "Name of service account (scope of uniqueness is a 'Projects' namespace)",
"type": "string"
}
},
"required": [
"annotations",
"name"
],
"type": "object"
}
},
"required": [
"serviceAccount"
],
"type": "object"
},
"forge": {
"if": {
"properties": {
"localPostgresql": {
"enum": [
false
]
}
}
},
"properties": {
"aws": {
"properties": {
"IAMRole": {
"type": "string"
}
},
"type": "object"
},
"baseURL": {
"type": "string"
},
"branding": {
"type": "object"
},
"broker": {
"properties": {
"enabled": {
"type": "boolean"
},
"public_url": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"cloudProvider": {
"type": "string"
},
"contentSecurityPolicy": {
"properties": {
"directives": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"reportOnly": {
"type": "boolean"
},
"reportUri": {
"type": "string"
}
},
"type": "object"
},
"dbName": {
"type": "string"
},
"dbPassword": {
"type": "string"
},
"dbUsername": {
"type": "string"
},
"domain": {
"type": "string"
},
"ee": {
"properties": {
"billing": {
"properties": {
"stripe": {
"properties": {
"device_price": {
"type": "string"
},
"device_product": {
"type": "string"
},
"key": {
"type": "string"
},
"new_customer_free_credit": {
"type": "integer"
},
"project_price": {
"type": "string"
},
"project_product": {
"type": "string"
},
"team_price": {
"type": "string"
},
"team_product": {
"type": "string"
},
"teams": {
"type": "object"
},
"wh_secret": {
"type": "string"
}
},
"required": [
"key",
"wh_secret",
"team_price",
"team_product",
"project_price",
"project_product"
],
"type": "object"
}
},
"required": [
"stripe"
],
"type": "object"
}
},
"required": [
"billing"
],
"type": "object"
},
"email": {
"properties": {
"from": {
"type": "string"
},
"ses": {
"properties": {
"region": {
"type": "string"
}
},
"required": [
"region"
],
"type": "object"
},
"smtp": {
"properties": {
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"type": "integer"
},
"tls": {
"type": "boolean"
},
"user": {
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
}
},
"type": "object"
},
"entryPoint": {
"type": "string"
},
"fileStore": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"enabled": {
"type": "boolean"
},
"options": {
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"type",
"options"
]
},
"type": "object"
},
"https": {
"type": "boolean"
},
"image": {
"type": "string"
},
"localPostgresql": {
"type": "boolean"
},
"managementSelector": {
"type": "object"
},
"postgres": {
"properties": {
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"ssl": {
"type": "boolean"
}
},
"required": [
"host"
],
"type": "object"
},
"projectDeploymentTolerations": {
"default": [],
"items": {
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"effect",
"key",
"operator",
"value"
],
"type": "object"
},
"type": "array"
},
"projectNamespace": {
"type": "string"
},
"projectSelector": {
"type": "object"
},
"rateLimits": {
"properties": {
"enabled": {
"type": "boolean"
},
"global": {
"type": "boolean"
},
"max": {
"type": "integer"
},
"maxAnonymous": {
"type": "integer"
},
"timeWindow": {
"type": "integer"
}
},
"type": "object"
},
"registry": {
"type": "string"
},
"registrySecrets": {
"items": {
"type": "string"
},
"type": "array"
},
"support": {
"if": {
"properties": {
"enabled": {
"enum": [
true
]
}
}
},
"properties": {
"enabled": {
"type": "boolean"
},
"hubspot": {
"type": "integer"
}
},
"then": {
"required": [
"hubspot"
]
},
"type": "object"
},
"telemetry": {
"properties": {
"backend": {
"properties": {
"prometheus": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"plausible": {
"type": "string"
},
"posthog": {
"properties": {
"apikey": {
"type": "string"
},
"apiurl": {
"type": "string"
},
"capture_pageview": {
"type": "boolean"
}
},
"required": [
"apikey"
],
"type": "object"
},
"sentry": {
"properties": {
"backend_dsn": {
"type": "string"
},
"environment": {
"type": "string"
},
"frontend_dsn": {
"type": "string"
},
"production_mode": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"domain",
"dbUsername",
"dbPassword"
],
"then": {
"required": [
"postgres"
]
},
"type": "object"
},
"ingress": {
"properties": {
"annotations": {
"minProperties": 0,
"type": "object"
},
"className": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"forge"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
jesseduffield/lazygit | 7d787afb2cd8f711b508fb63a7d097bffe9c9cb3 | 2024-05-19T12:07:51 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"autoWrapCommitMessage": {
"default": true,
"description": "Automatic WYSIWYG wrapping of the commit message as you type",
"type": "boolean"
},
"autoWrapWidth": {
"default": 72,
"description": "If autoWrapCommitMessage is true, the width to wrap to",
"type": "integer"
},
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefix": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1]"
],
"type": "string"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1]"
],
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/\n\nDeprecated: Configure this with `Log menu -> Commit sort order` (<c-l> in the commits window by default).",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "always",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'\n\nDeprecated: Configure this with `Log menu -> Show git graph` (<c-l> in the commits window by default).",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
},
"truncateCopiedCommitHashesTo": {
"default": 12,
"description": "When copying commit hashes to the clipboard, truncate them to this\nlength. Set to 40 to disable truncation.",
"type": "integer"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitHashLength": {
"default": 8,
"description": "Length of commit hash in commits view. 0 shows '*' if NF icons aren't on.",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"filterMode": {
"default": "substring",
"description": "How things are filtered when typing '/'.\nOne of 'substring' (default) | 'fuzzy'",
"enum": [
"substring",
"fuzzy"
],
"type": "string"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileIcons": {
"default": true,
"description": "If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"spinner": {
"additionalProperties": false,
"description": "Config relating to the spinner.",
"properties": {
"frames": {
"default": [
"|",
"/",
"-",
"\\"
],
"description": "The frames of the spinner animation.",
"items": {
"type": "string"
},
"type": "array"
},
"rate": {
"default": 50,
"description": "The \"speed\" of the spinner in milliseconds.",
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"statusPanelView": {
"default": "dashboard",
"description": "Status panel view.\nOne of 'dashboard' (default) | 'allBranchesLog'",
"enum": [
"dashboard",
"allBranchesLog"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"default": "normal",
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"amendAttribute": {
"additionalProperties": false,
"properties": {
"addCoAuthor": {
"default": "c",
"type": "string"
},
"resetAuthor": {
"default": "a",
"type": "string"
},
"setAuthor": {
"default": "A",
"type": "string"
}
},
"type": "object"
},
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"commitMenu": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "V",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | 01ff18dd925f68e7ebfd21b52803cf5fc05cf2d3 | 2024-05-01T17:03:12 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"autoWrapCommitMessage": {
"default": true,
"description": "Automatic WYSIWYG wrapping of the commit message as you type",
"type": "boolean"
},
"autoWrapWidth": {
"default": 72,
"description": "If autoWrapCommitMessage is true, the width to wrap to",
"type": "integer"
},
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefix": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/\n\nDeprecated: Configure this with `Log menu -> Commit sort order` (<c-l> in the commits window by default).",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "always",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'\n\nDeprecated: Configure this with `Log menu -> Show git graph` (<c-l> in the commits window by default).",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
},
"truncateCopiedCommitHashesTo": {
"default": 12,
"description": "When copying commit hashes to the clipboard, truncate them to this\nlength. Set to 40 to disable truncation.",
"type": "integer"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitHashLength": {
"default": 8,
"description": "Length of commit hash in commits view. 0 shows '*' if NF icons aren't on.",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"filterMode": {
"default": "substring",
"description": "How things are filtered when typing '/'.\nOne of 'substring' (default) | 'fuzzy'",
"enum": [
"substring",
"fuzzy"
],
"type": "string"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileIcons": {
"default": true,
"description": "If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"spinner": {
"additionalProperties": false,
"description": "Config relating to the spinner.",
"properties": {
"frames": {
"default": [
"|",
"/",
"-",
"\\"
],
"description": "The frames of the spinner animation.",
"items": {
"type": "string"
},
"type": "array"
},
"rate": {
"default": 50,
"description": "The \"speed\" of the spinner in milliseconds.",
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"statusPanelView": {
"default": "dashboard",
"description": "Status panel view.\nOne of 'dashboard' (default) | 'allBranchesLog'",
"enum": [
"dashboard",
"allBranchesLog"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"amendAttribute": {
"additionalProperties": false,
"properties": {
"addCoAuthor": {
"default": "c",
"type": "string"
},
"resetAuthor": {
"default": "a",
"type": "string"
},
"setAuthor": {
"default": "A",
"type": "string"
}
},
"type": "object"
},
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"commitMenu": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "V",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | 280b4d60f893a0e20897091ab02617c32180b45d | 2024-01-18T23:50:49 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order | default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "when-maximised",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"switchToEditor": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "V",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | 53a8bd2e3fbbc474bbd70564f38f6fe1e1d10079 | 2024-01-13T01:57:49 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order | default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "when-maximised",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedRangeBgColor": {
"default": [
"blue"
],
"description": "Background color of selected range\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"switchToEditor": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "c",
"type": "string"
},
"cherryPickCopyRange": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "v",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleDragSelect": {
"default": "v",
"type": "string"
},
"toggleDragSelect-alt": {
"default": "V",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | 79e04fad9a30e3068d2658f897213e55dc4631ec | 2023-12-15T04:29:48 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order | default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "when-maximised",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedRangeBgColor": {
"default": [
"blue"
],
"description": "Background color of selected range\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"switchToEditor": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "c",
"type": "string"
},
"cherryPickCopyRange": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "v",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleDragSelect": {
"default": "v",
"type": "string"
},
"toggleDragSelect-alt": {
"default": "V",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | a8797c72617b3ace7ce7c1c0eab469497e40b774 | 2024-03-17T10:55:09 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"autoWrapCommitMessage": {
"default": true,
"description": "Automatic WYSIWYG wrapping of the commit message as you type",
"type": "boolean"
},
"autoWrapWidth": {
"default": 72,
"description": "If autoWrapCommitMessage is true, the width to wrap to",
"type": "integer"
},
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/\n\nDeprecated: Configure this with `Log menu -> Commit sort order` (<c-l> in the commits window by default).",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "always",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'\n\nDeprecated: Configure this with `Log menu -> Show git graph` (<c-l> in the commits window by default).",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"filterMode": {
"default": "substring",
"description": "How things are filtered when typing '/'.\nOne of 'substring' (default) | 'fuzzy'",
"enum": [
"substring",
"fuzzy"
],
"type": "string"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileIcons": {
"default": true,
"description": "If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"amendAttribute": {
"additionalProperties": false,
"properties": {
"addCoAuthor": {
"default": "c",
"type": "string"
},
"resetAuthor": {
"default": "a",
"type": "string"
},
"setAuthor": {
"default": "A",
"type": "string"
}
},
"type": "object"
},
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"commitMenu": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "V",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | 3b29705a7876c13f47a6478e17ad7ee4fc78ff8c | 2024-03-22T08:58:54 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"autoWrapCommitMessage": {
"default": true,
"description": "Automatic WYSIWYG wrapping of the commit message as you type",
"type": "boolean"
},
"autoWrapWidth": {
"default": 72,
"description": "If autoWrapCommitMessage is true, the width to wrap to",
"type": "integer"
},
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/\n\nDeprecated: Configure this with `Log menu -> Commit sort order` (<c-l> in the commits window by default).",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "always",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'\n\nDeprecated: Configure this with `Log menu -> Show git graph` (<c-l> in the commits window by default).",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
},
"truncateCopiedCommitHashesTo": {
"default": 12,
"description": "When copying commit hashes to the clipboard, truncate them to this\nlength. Set to 40 to disable truncation.",
"type": "integer"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"filterMode": {
"default": "substring",
"description": "How things are filtered when typing '/'.\nOne of 'substring' (default) | 'fuzzy'",
"enum": [
"substring",
"fuzzy"
],
"type": "string"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileIcons": {
"default": true,
"description": "If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"amendAttribute": {
"additionalProperties": false,
"properties": {
"addCoAuthor": {
"default": "c",
"type": "string"
},
"resetAuthor": {
"default": "a",
"type": "string"
},
"setAuthor": {
"default": "A",
"type": "string"
}
},
"type": "object"
},
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"commitMenu": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "V",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | f3eb180f75496637719895902abf76af10b8425f | 2024-01-18T23:47:21 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order | default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "when-maximised",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"switchToEditor": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "c",
"type": "string"
},
"cherryPickCopyRange": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "v",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | b1d05b6371192bbbe54ea7e094594b17b92082f1 | 2024-02-13T13:34:40 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order | default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "always",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileIcons": {
"default": true,
"description": "If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"switchToEditor": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "V",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | 22a38c9f5026c4b23d8288ef194235dfe52b03e3 | 2024-05-20T19:02:49 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"outputTitle": {
"description": "The title to display in the popup panel if showOutput is true. If left unset, the command will be used as the title.",
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"autoWrapCommitMessage": {
"default": true,
"description": "Automatic WYSIWYG wrapping of the commit message as you type",
"type": "boolean"
},
"autoWrapWidth": {
"default": 72,
"description": "If autoWrapCommitMessage is true, the width to wrap to",
"type": "integer"
},
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefix": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1]"
],
"type": "string"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1]"
],
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/\n\nDeprecated: Configure this with `Log menu -> Commit sort order` (<c-l> in the commits window by default).",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "always",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'\n\nDeprecated: Configure this with `Log menu -> Show git graph` (<c-l> in the commits window by default).",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
},
"truncateCopiedCommitHashesTo": {
"default": 12,
"description": "When copying commit hashes to the clipboard, truncate them to this\nlength. Set to 40 to disable truncation.",
"type": "integer"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitHashLength": {
"default": 8,
"description": "Length of commit hash in commits view. 0 shows '*' if NF icons aren't on.",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"filterMode": {
"default": "substring",
"description": "How things are filtered when typing '/'.\nOne of 'substring' (default) | 'fuzzy'",
"enum": [
"substring",
"fuzzy"
],
"type": "string"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileIcons": {
"default": true,
"description": "If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"spinner": {
"additionalProperties": false,
"description": "Config relating to the spinner.",
"properties": {
"frames": {
"default": [
"|",
"/",
"-",
"\\"
],
"description": "The frames of the spinner animation.",
"items": {
"type": "string"
},
"type": "array"
},
"rate": {
"default": 50,
"description": "The \"speed\" of the spinner in milliseconds.",
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"statusPanelView": {
"default": "dashboard",
"description": "Status panel view.\nOne of 'dashboard' (default) | 'allBranchesLog'",
"enum": [
"dashboard",
"allBranchesLog"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"default": "normal",
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"amendAttribute": {
"additionalProperties": false,
"properties": {
"addCoAuthor": {
"default": "c",
"type": "string"
},
"resetAuthor": {
"default": "a",
"type": "string"
},
"setAuthor": {
"default": "A",
"type": "string"
}
},
"type": "object"
},
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"commitMenu": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "V",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | cede0214009888e32027beb212b63e30e77d29e7 | 2024-03-09T09:00:44 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"autoWrapCommitMessage": {
"default": true,
"description": "Automatic WYSIWYG wrapping of the commit message as you type",
"type": "boolean"
},
"autoWrapWidth": {
"default": 72,
"description": "If autoWrapCommitMessage is true, the width to wrap to",
"type": "integer"
},
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/\n\nDeprecated: Configure this with `Log menu -> Commit sort order` (<c-l> in the commits window by default).",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "always",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'\n\nDeprecated: Configure this with `Log menu -> Show git graph` (<c-l> in the commits window by default).",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileIcons": {
"default": true,
"description": "If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"switchToEditor": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "V",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | e354a9bb486842e8e9376d27ef72f405a2dba7b3 | 2024-02-16T12:23:35 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/\n\nDeprecated: Configure this with `Log menu -> Commit sort order` (<c-l> in the commits window by default).",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "always",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'\n\nDeprecated: Configure this with `Log menu -> Show git graph` (<c-l> in the commits window by default).",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileIcons": {
"default": true,
"description": "If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"switchToEditor": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "V",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | a6174271aa6830577fae9c35bb09608c64bd550b | 2024-01-09T13:27:33 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order | default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "when-maximised",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedRangeBgColor": {
"default": [
"blue"
],
"description": "Background color of selected range\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"switchToEditor": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "c",
"type": "string"
},
"cherryPickCopyRange": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "v",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleDragSelect": {
"default": "v",
"type": "string"
},
"toggleDragSelect-alt": {
"default": "V",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | 6907816af9db383840654b87f1c5cdf65d83f4d3 | 2023-12-07T07:30:03 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"Options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order | default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "when-maximised",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedRangeBgColor": {
"default": [
"blue"
],
"description": "Background color of selected range\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"switchToEditor": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "c",
"type": "string"
},
"cherryPickCopyRange": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "v",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleDragSelect": {
"default": "v",
"type": "string"
},
"toggleDragSelect-alt": {
"default": "V",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | 8ca78412acdc73526248ff10c332f98ceba39fd2 | 2024-01-10T08:11:40 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order | default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "when-maximised",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedRangeBgColor": {
"default": [
"blue"
],
"description": "Background color of selected range\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"switchToEditor": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "c",
"type": "string"
},
"cherryPickCopyRange": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "v",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleDragSelect": {
"default": "v",
"type": "string"
},
"toggleDragSelect-alt": {
"default": "V",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | f3dba743f04a7768a4d97ddcd9f9b6ce4acb9fed | 2024-04-06T11:46:15 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"autoWrapCommitMessage": {
"default": true,
"description": "Automatic WYSIWYG wrapping of the commit message as you type",
"type": "boolean"
},
"autoWrapWidth": {
"default": 72,
"description": "If autoWrapCommitMessage is true, the width to wrap to",
"type": "integer"
},
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/\n\nDeprecated: Configure this with `Log menu -> Commit sort order` (<c-l> in the commits window by default).",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "always",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'\n\nDeprecated: Configure this with `Log menu -> Show git graph` (<c-l> in the commits window by default).",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
},
"truncateCopiedCommitHashesTo": {
"default": 12,
"description": "When copying commit hashes to the clipboard, truncate them to this\nlength. Set to 40 to disable truncation.",
"type": "integer"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"filterMode": {
"default": "substring",
"description": "How things are filtered when typing '/'.\nOne of 'substring' (default) | 'fuzzy'",
"enum": [
"substring",
"fuzzy"
],
"type": "string"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileIcons": {
"default": true,
"description": "If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"spinner": {
"additionalProperties": false,
"description": "Config relating to the spinner.",
"properties": {
"frames": {
"default": [
"|",
"/",
"-",
"\\"
],
"description": "The frames of the spinner animation.",
"items": {
"type": "string"
},
"type": "array"
},
"rate": {
"default": 50,
"description": "The \"speed\" of the spinner in milliseconds.",
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"amendAttribute": {
"additionalProperties": false,
"properties": {
"addCoAuthor": {
"default": "c",
"type": "string"
},
"resetAuthor": {
"default": "a",
"type": "string"
},
"setAuthor": {
"default": "A",
"type": "string"
}
},
"type": "object"
},
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"commitMenu": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "V",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | af842e40d4d11aea8f9534e42d312fff2860c0ba | 2024-05-19T12:07:40 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"autoWrapCommitMessage": {
"default": true,
"description": "Automatic WYSIWYG wrapping of the commit message as you type",
"type": "boolean"
},
"autoWrapWidth": {
"default": 72,
"description": "If autoWrapCommitMessage is true, the width to wrap to",
"type": "integer"
},
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefix": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1]"
],
"type": "string"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1]"
],
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/\n\nDeprecated: Configure this with `Log menu -> Commit sort order` (<c-l> in the commits window by default).",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "always",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'\n\nDeprecated: Configure this with `Log menu -> Show git graph` (<c-l> in the commits window by default).",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
},
"truncateCopiedCommitHashesTo": {
"default": 12,
"description": "When copying commit hashes to the clipboard, truncate them to this\nlength. Set to 40 to disable truncation.",
"type": "integer"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitHashLength": {
"default": 8,
"description": "Length of commit hash in commits view. 0 shows '*' if NF icons aren't on.",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"filterMode": {
"default": "substring",
"description": "How things are filtered when typing '/'.\nOne of 'substring' (default) | 'fuzzy'",
"enum": [
"substring",
"fuzzy"
],
"type": "string"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileIcons": {
"default": true,
"description": "If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"spinner": {
"additionalProperties": false,
"description": "Config relating to the spinner.",
"properties": {
"frames": {
"default": [
"|",
"/",
"-",
"\\"
],
"description": "The frames of the spinner animation.",
"items": {
"type": "string"
},
"type": "array"
},
"rate": {
"default": 50,
"description": "The \"speed\" of the spinner in milliseconds.",
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"statusPanelView": {
"default": "dashboard",
"description": "Status panel view.\nOne of 'dashboard' (default) | 'allBranchesLog'",
"enum": [
"dashboard",
"allBranchesLog"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"amendAttribute": {
"additionalProperties": false,
"properties": {
"addCoAuthor": {
"default": "c",
"type": "string"
},
"resetAuthor": {
"default": "a",
"type": "string"
},
"setAuthor": {
"default": "A",
"type": "string"
}
},
"type": "object"
},
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"commitMenu": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "V",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | 9b152d7619327da442d733b45075e17b631775e7 | 2024-05-19T12:08:27 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"autoWrapCommitMessage": {
"default": true,
"description": "Automatic WYSIWYG wrapping of the commit message as you type",
"type": "boolean"
},
"autoWrapWidth": {
"default": 72,
"description": "If autoWrapCommitMessage is true, the width to wrap to",
"type": "integer"
},
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefix": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1]"
],
"type": "string"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1]"
],
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/\n\nDeprecated: Configure this with `Log menu -> Commit sort order` (<c-l> in the commits window by default).",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "always",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'\n\nDeprecated: Configure this with `Log menu -> Show git graph` (<c-l> in the commits window by default).",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
},
"truncateCopiedCommitHashesTo": {
"default": 12,
"description": "When copying commit hashes to the clipboard, truncate them to this\nlength. Set to 40 to disable truncation.",
"type": "integer"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitHashLength": {
"default": 8,
"description": "Length of commit hash in commits view. 0 shows '*' if NF icons aren't on.",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"filterMode": {
"default": "substring",
"description": "How things are filtered when typing '/'.\nOne of 'substring' (default) | 'fuzzy'",
"enum": [
"substring",
"fuzzy"
],
"type": "string"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileIcons": {
"default": true,
"description": "If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"spinner": {
"additionalProperties": false,
"description": "Config relating to the spinner.",
"properties": {
"frames": {
"default": [
"|",
"/",
"-",
"\\"
],
"description": "The frames of the spinner animation.",
"items": {
"type": "string"
},
"type": "array"
},
"rate": {
"default": 50,
"description": "The \"speed\" of the spinner in milliseconds.",
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"statusPanelView": {
"default": "dashboard",
"description": "Status panel view.\nOne of 'dashboard' (default) | 'allBranchesLog'",
"enum": [
"dashboard",
"allBranchesLog"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"default": "normal",
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"amendAttribute": {
"additionalProperties": false,
"properties": {
"addCoAuthor": {
"default": "c",
"type": "string"
},
"resetAuthor": {
"default": "a",
"type": "string"
},
"setAuthor": {
"default": "A",
"type": "string"
}
},
"type": "object"
},
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"commitMenu": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "V",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | a4354ccdfb25cac9f4928823dae86336c7571664 | 2024-04-27T09:30:49 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"autoWrapCommitMessage": {
"default": true,
"description": "Automatic WYSIWYG wrapping of the commit message as you type",
"type": "boolean"
},
"autoWrapWidth": {
"default": 72,
"description": "If autoWrapCommitMessage is true, the width to wrap to",
"type": "integer"
},
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/\n\nDeprecated: Configure this with `Log menu -> Commit sort order` (<c-l> in the commits window by default).",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "always",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'\n\nDeprecated: Configure this with `Log menu -> Show git graph` (<c-l> in the commits window by default).",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
},
"truncateCopiedCommitHashesTo": {
"default": 12,
"description": "When copying commit hashes to the clipboard, truncate them to this\nlength. Set to 40 to disable truncation.",
"type": "integer"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitHashLength": {
"default": 8,
"description": "Length of commit hash in commits view. 0 shows '*' if NF icons aren't on.",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"filterMode": {
"default": "substring",
"description": "How things are filtered when typing '/'.\nOne of 'substring' (default) | 'fuzzy'",
"enum": [
"substring",
"fuzzy"
],
"type": "string"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileIcons": {
"default": true,
"description": "If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"spinner": {
"additionalProperties": false,
"description": "Config relating to the spinner.",
"properties": {
"frames": {
"default": [
"|",
"/",
"-",
"\\"
],
"description": "The frames of the spinner animation.",
"items": {
"type": "string"
},
"type": "array"
},
"rate": {
"default": 50,
"description": "The \"speed\" of the spinner in milliseconds.",
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"statusPanelView": {
"default": "dashboard",
"description": "Status panel view.\nOne of 'dashboard' (default) | 'allBranchesLog'",
"enum": [
"dashboard",
"allBranchesLog"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"amendAttribute": {
"additionalProperties": false,
"properties": {
"addCoAuthor": {
"default": "c",
"type": "string"
},
"resetAuthor": {
"default": "a",
"type": "string"
},
"setAuthor": {
"default": "A",
"type": "string"
}
},
"type": "object"
},
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"commitMenu": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "V",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | 3fe491fcb25a31268a1dd428d9a00bdcd027d155 | 2023-12-22T07:30:20 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order | default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "when-maximised",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedRangeBgColor": {
"default": [
"blue"
],
"description": "Background color of selected range\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"switchToEditor": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "c",
"type": "string"
},
"cherryPickCopyRange": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "v",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleDragSelect": {
"default": "v",
"type": "string"
},
"toggleDragSelect-alt": {
"default": "V",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | 2b5c8140805ee11be798ff1ff919652e2f92a5e7 | 2024-04-10T15:38:57 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"autoWrapCommitMessage": {
"default": true,
"description": "Automatic WYSIWYG wrapping of the commit message as you type",
"type": "boolean"
},
"autoWrapWidth": {
"default": 72,
"description": "If autoWrapCommitMessage is true, the width to wrap to",
"type": "integer"
},
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/\n\nDeprecated: Configure this with `Log menu -> Commit sort order` (<c-l> in the commits window by default).",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "always",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'\n\nDeprecated: Configure this with `Log menu -> Show git graph` (<c-l> in the commits window by default).",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
},
"truncateCopiedCommitHashesTo": {
"default": 12,
"description": "When copying commit hashes to the clipboard, truncate them to this\nlength. Set to 40 to disable truncation.",
"type": "integer"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"filterMode": {
"default": "substring",
"description": "How things are filtered when typing '/'.\nOne of 'substring' (default) | 'fuzzy'",
"enum": [
"substring",
"fuzzy"
],
"type": "string"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileIcons": {
"default": true,
"description": "If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"spinner": {
"additionalProperties": false,
"description": "Config relating to the spinner.",
"properties": {
"frames": {
"default": [
"|",
"/",
"-",
"\\"
],
"description": "The frames of the spinner animation.",
"items": {
"type": "string"
},
"type": "array"
},
"rate": {
"default": 50,
"description": "The \"speed\" of the spinner in milliseconds.",
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"statusPanelView": {
"default": "dashboard",
"description": "Status panel view.\nOne of 'dashboard' (default) | 'allBranchesLog'",
"enum": [
"dashboard",
"allBranchesLog"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"amendAttribute": {
"additionalProperties": false,
"properties": {
"addCoAuthor": {
"default": "c",
"type": "string"
},
"resetAuthor": {
"default": "a",
"type": "string"
},
"setAuthor": {
"default": "A",
"type": "string"
}
},
"type": "object"
},
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"commitMenu": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "V",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | 24a4302c528e3a11b30855c006669de1adf9e1d4 | 2024-01-18T23:47:21 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order | default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "when-maximised",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedRangeBgColor": {
"default": [
"blue"
],
"description": "Background color of selected range\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"switchToEditor": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "c",
"type": "string"
},
"cherryPickCopyRange": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "v",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | 36134006c52269b1a80f2b42857f008b47db7e6c | 2024-01-22T07:40:03 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order | default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "when-maximised",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileIcons": {
"default": true,
"description": "If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"switchToEditor": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "V",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | 744519de6016e2d65ca28129e3ad9d6accc76fb8 | 2024-03-11T08:18:40 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"autoWrapCommitMessage": {
"default": true,
"description": "Automatic WYSIWYG wrapping of the commit message as you type",
"type": "boolean"
},
"autoWrapWidth": {
"default": 72,
"description": "If autoWrapCommitMessage is true, the width to wrap to",
"type": "integer"
},
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/\n\nDeprecated: Configure this with `Log menu -> Commit sort order` (<c-l> in the commits window by default).",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "always",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'\n\nDeprecated: Configure this with `Log menu -> Show git graph` (<c-l> in the commits window by default).",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileIcons": {
"default": true,
"description": "If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"amendAttribute": {
"additionalProperties": false,
"properties": {
"addCoAuthor": {
"default": "c",
"type": "string"
},
"resetAuthor": {
"default": "a",
"type": "string"
},
"setAuthor": {
"default": "A",
"type": "string"
}
},
"type": "object"
},
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"commitMenu": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "V",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | e1b341e174ef2dcb5b0abb4eead81397bee076cd | 2024-03-11T08:18:40 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"autoWrapCommitMessage": {
"default": true,
"description": "Automatic WYSIWYG wrapping of the commit message as you type",
"type": "boolean"
},
"autoWrapWidth": {
"default": 72,
"description": "If autoWrapCommitMessage is true, the width to wrap to",
"type": "integer"
},
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/\n\nDeprecated: Configure this with `Log menu -> Commit sort order` (<c-l> in the commits window by default).",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "always",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'\n\nDeprecated: Configure this with `Log menu -> Show git graph` (<c-l> in the commits window by default).",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileIcons": {
"default": true,
"description": "If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"amendAttribute": {
"additionalProperties": false,
"properties": {
"addCoAuthor": {
"default": "c",
"type": "string"
},
"resetAuthor": {
"default": "a",
"type": "string"
},
"setAuthor": {
"default": "A",
"type": "string"
}
},
"type": "object"
},
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"switchToEditor": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "V",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"startInteractiveRebase": {
"default": "i",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"findBaseCommitForFixup": {
"default": "<c-f>",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"rangeSelectDown": {
"default": "<s-down>",
"type": "string"
},
"rangeSelectUp": {
"default": "<s-up>",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleRangeSelect": {
"default": "v",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | d70dd5123dfca5248ab9f2396307c46eff96bcb4 | 2024-01-09T14:45:26 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order | default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "when-maximised",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"enlargedSideViewLocation": {
"default": "left",
"description": "How the window is split when in half screen mode (i.e. after hitting '+' once).\nPossible values:\n- 'left': split the window horizontally (side panel on the left, main view on the right)\n- 'top': split the window vertically (side panel on top, main view below)",
"type": "string"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedRangeBgColor": {
"default": [
"blue"
],
"description": "Background color of selected range\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"sortOrder": {
"default": "s",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"switchToEditor": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "c",
"type": "string"
},
"cherryPickCopyRange": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "v",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"copyFileInfoToClipboard": {
"default": "y",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleDragSelect": {
"default": "v",
"type": "string"
},
"toggleDragSelect-alt": {
"default": "V",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openDiffTool": {
"default": "<c-t>",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
jesseduffield/lazygit | 1a035db4c817ac07cd59f0f2aa4e1efd1a9b75b6 | 2023-12-02T09:46:24 | schema/config.json | 46,661 | 2024-05-29T11:28:42.911388Z | {
"$id": "https://github.com/jesseduffield/lazygit/pkg/config/user-config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirmOnQuit": {
"description": "If true, show a confirmation popup before quitting Lazygit",
"type": "boolean"
},
"customCommands": {
"description": "User-configured commands that can be invoked from within Lazygit",
"items": {
"additionalProperties": false,
"properties": {
"after": {
"additionalProperties": false,
"description": "Actions to take after the command has completed",
"properties": {
"checkForConflicts": {
"type": "boolean"
}
},
"type": "object"
},
"command": {
"description": "The command to run (using Go template syntax for placeholder values)",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"context": {
"description": "The context in which to listen for the key",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
],
"type": "string"
},
"description": {
"description": "Label for the custom command when displayed in the keybindings menu",
"type": "string"
},
"key": {
"description": "The key to trigger the command. Use a single letter or one of the values from https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
"type": "string"
},
"loadingText": {
"description": "Text to display while waiting for command to finish",
"examples": [
"Loading..."
],
"type": "string"
},
"prompts": {
"description": "A list of prompts that will request user input before running the final command",
"items": {
"additionalProperties": false,
"properties": {
"Options": {
"description": "Menu options.\nOnly for menu prompts.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "The second part of the label",
"type": "string"
},
"name": {
"description": "The first part of the label",
"type": "string"
},
"value": {
"description": "The value that will be used in the command",
"examples": [
"feature"
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"body": {
"description": "The message of the confirmation prompt.\nOnly for confirm prompts.",
"examples": [
"Are you sure you want to push to the remote?"
],
"type": "string"
},
"command": {
"description": "The command to run to generate menu options\nOnly for menuFromCommand prompts.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"filter": {
"description": "The regexp to run specifying groups which are going to be kept from the command's output.\nOnly for menuFromCommand prompts.",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
],
"type": "string"
},
"initialValue": {
"description": "The initial value to appear in the text box.\nOnly for input prompts.",
"type": "string"
},
"key": {
"description": "Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command",
"type": "string"
},
"labelFormat": {
"description": "Like valueFormat but for the labels. If `labelFormat` is not specified, `valueFormat` is shown instead.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch | green }}"
],
"type": "string"
},
"suggestions": {
"additionalProperties": false,
"description": "Shows suggestions as the input is entered\nOnly for input prompts.",
"properties": {
"command": {
"description": "Command to run such that each line in the output becomes a suggestion. Mutually exclusive with 'preset' field.",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
],
"type": "string"
},
"preset": {
"description": "Uses built-in logic to obtain the suggestions. One of 'authors' | 'branches' | 'files' | 'refs' | 'remotes' | 'remoteBranches' | 'tags'",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
],
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "The title to display in the popup panel",
"type": "string"
},
"type": {
"description": "One of: 'input' | 'menu' | 'confirm' | 'menuFromCommand'",
"type": "string"
},
"valueFormat": {
"description": "How to format matched groups from the filter to construct a menu item's value.\nOnly for menuFromCommand prompts.",
"examples": [
"{{ .branch }}"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"showOutput": {
"description": "If true, show the command's output in a popup within Lazygit",
"type": "boolean"
},
"stream": {
"description": "If true, stream the command's output to the Command Log panel",
"type": "boolean"
},
"subprocess": {
"description": "If true, run the command in a subprocess (e.g. if the command requires user input)",
"type": "boolean"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"disableStartupPopups": {
"description": "If true, don't display introductory popups upon opening Lazygit.\nLazygit sets this to true upon first runninng the program so that you don't see introductory popups every time you open the program.",
"type": "boolean"
},
"git": {
"additionalProperties": false,
"description": "Config relating to git",
"properties": {
"allBranchesLogCmd": {
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium",
"description": "Command used to display git log of all branches in the main window",
"type": "string"
},
"autoFetch": {
"default": true,
"description": "If true, periodically fetch from remote",
"type": "boolean"
},
"autoRefresh": {
"default": true,
"description": "If true, periodically refresh files and submodules",
"type": "boolean"
},
"branchLogCmd": {
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
"description": "Command used when displaying the current branch git log in the main window",
"type": "string"
},
"commit": {
"additionalProperties": false,
"description": "Config relating to committing",
"properties": {
"signOff": {
"description": "If true, pass '--signoff' flag when committing",
"type": "boolean"
}
},
"type": "object"
},
"commitPrefixes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"pattern": {
"description": "pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use \"^\\\\w+\\\\/(\\\\w+-\\\\w+).*\"",
"examples": [
"^\\w+\\/(\\w+-\\w+).*"
],
"minLength": 1,
"type": "string"
},
"replace": {
"description": "Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use \"[$1] \"",
"examples": [
"[$1] "
],
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object"
},
"disableForcePushing": {
"description": "If true, do not allow force pushes",
"type": "boolean"
},
"fetchAll": {
"default": true,
"description": "If true, pass the --all arg to git fetch",
"type": "boolean"
},
"log": {
"additionalProperties": false,
"description": "Config for showing the log in the commits view",
"properties": {
"order": {
"default": "topo-order",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order | default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"type": "string"
},
"showGraph": {
"default": "when-maximised",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'",
"enum": [
"always",
"never",
"when-maximised"
],
"type": "string"
},
"showWholeGraph": {
"description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
"type": "boolean"
}
},
"type": "object"
},
"mainBranches": {
"default": [
"master",
"main"
],
"description": "list of branches that are considered 'main' branches, used when displaying commits",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"merging": {
"additionalProperties": false,
"description": "Config relating to merging",
"properties": {
"args": {
"description": "Extra args passed to `git merge`, e.g. --no-ff",
"examples": [
"--no-ff"
],
"type": "string"
},
"manualCommit": {
"description": "If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang\nOnly applicable to unix users.",
"type": "boolean"
}
},
"type": "object"
},
"overrideGpg": {
"description": "If true, do not spawn a separate process when using GPG",
"type": "boolean"
},
"paging": {
"additionalProperties": false,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"properties": {
"colorArg": {
"default": "always",
"description": "Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'",
"enum": [
"always",
"never"
],
"type": "string"
},
"externalDiffCommand": {
"description": "e.g. 'difft --color=always'",
"type": "string"
},
"pager": {
"default": "",
"description": "e.g.\ndiff-so-fancy\ndelta --dark --paging=never\nydiff -p cat -s --wrap --width={{columnWidth}}",
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
],
"minLength": 1,
"type": "string"
},
"useConfig": {
"description": "If true, Lazygit will use whatever pager is specified in `$GIT_PAGER`, `$PAGER`, or your *git config*. If the pager ends with something like ` | less` we will strip that part out, because less doesn't play nice with our rendering approach. If the custom pager uses less under the hood, that will also break rendering (hence the `--paging=never` flag for the `delta` pager).",
"type": "boolean"
}
},
"type": "object"
},
"parseEmoji": {
"description": "If true, parse emoji strings in commit messages e.g. render :rocket: as \ud83d\ude80\n(This should really be under 'gui', not 'git')",
"type": "boolean"
},
"skipHookPrefix": {
"default": "WIP",
"description": "Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'",
"type": "string"
}
},
"type": "object"
},
"gui": {
"additionalProperties": false,
"description": "Config relating to the Lazygit UI",
"properties": {
"animateExplosion": {
"default": true,
"description": "If true, show a seriously epic explosion animation when nuking the working tree.",
"type": "boolean"
},
"authorColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object"
},
"border": {
"default": "rounded",
"description": "Window border style.\nOne of 'rounded' (default) | 'single' | 'double' | 'hidden'",
"enum": [
"single",
"double",
"rounded",
"hidden"
],
"type": "string"
},
"branchColors": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object"
},
"commandLogSize": {
"default": 8,
"description": "Height of the command log view",
"minimum": 0,
"type": "integer"
},
"commitLength": {
"additionalProperties": false,
"description": "Config relating to the commit length indicator",
"properties": {
"show": {
"default": true,
"description": "If true, show an indicator of commit message length",
"type": "boolean"
}
},
"type": "object"
},
"expandFocusedSidePanel": {
"description": "If true, increase the height of the focused side window; creating an accordion effect.",
"type": "boolean"
},
"language": {
"default": "auto",
"description": "One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'",
"enum": [
"auto",
"en",
"zh-TW",
"zh-CN",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"type": "string"
},
"mainPanelSplitMode": {
"default": "flexible",
"description": "Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.\nOptions are:\n- 'horizontal': split the window horizontally\n- 'vertical': split the window vertically\n- 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically",
"enum": [
"horizontal",
"flexible",
"vertical"
],
"type": "string"
},
"mouseEvents": {
"default": true,
"description": "If true, capture mouse events.\nWhen mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.",
"type": "boolean"
},
"nerdFontsVersion": {
"description": "Nerd fonts version to use.\nOne of: '2' | '3' | empty string (default)\nIf empty, do not show icons.",
"enum": [
"2",
"3",
""
],
"type": "string"
},
"portraitMode": {
"default": "auto",
"description": "Whether to stack UI components on top of each other.\nOne of 'auto' (default) | 'always' | 'never'",
"type": "string"
},
"scrollHeight": {
"default": 2,
"description": "The number of lines you scroll by when scrolling the main window",
"minimum": 1,
"type": "integer"
},
"scrollOffBehavior": {
"default": "margin",
"description": "One of: 'margin' (default) | 'jump'",
"type": "string"
},
"scrollOffMargin": {
"default": 2,
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#scroll-off-margin",
"type": "integer"
},
"scrollPastBottom": {
"default": true,
"description": "If true, allow scrolling past the bottom of the content in the main window",
"type": "boolean"
},
"shortTimeFormat": {
"default": "3:04PM",
"description": "Format used when displaying time if the time is less than 24 hours ago.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"showBottomLine": {
"default": true,
"description": "If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.",
"type": "boolean"
},
"showBranchCommitHash": {
"description": "If true, show commit hashes alongside branch names in the branches view.",
"type": "boolean"
},
"showCommandLog": {
"default": true,
"description": "If true, show the command log",
"type": "boolean"
},
"showFileTree": {
"default": true,
"description": "If true, display the files in the file views as a tree. If false, display the files as a flat list.\nThis can be toggled from within Lazygit with the '~' key, but that will not change the default.",
"type": "boolean"
},
"showIcons": {
"description": "Deprecated: use nerdFontsVersion instead",
"type": "boolean"
},
"showListFooter": {
"default": true,
"description": "If true, show the '5 of 20' footer at the bottom of list views",
"type": "boolean"
},
"showPanelJumps": {
"default": true,
"description": "If true, show jump-to-window keybindings in window titles.",
"type": "boolean"
},
"showRandomTip": {
"default": true,
"description": "If true, show a random tip in the command log when Lazygit starts",
"type": "boolean"
},
"sidePanelWidth": {
"default": 0.3333,
"description": "Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.\nNumber from 0 to 1.0.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"skipDiscardChangeWarning": {
"description": "If true, do not show a warning when discarding changes in the staging view.",
"type": "boolean"
},
"skipNoStagedFilesWarning": {
"description": "If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.",
"type": "boolean"
},
"skipRewordInEditorWarning": {
"description": "If true, do not show a warning when rewording a commit via an external editor",
"type": "boolean"
},
"skipStashWarning": {
"description": "If true, do not show warning when applying/popping the stash",
"type": "boolean"
},
"splitDiff": {
"default": "auto",
"description": "Whether to split the main window when viewing file changes.\nOne of: 'auto' | 'always'\nIf 'auto', only split the main window when a file has both staged and unstaged changes",
"enum": [
"auto",
"always"
],
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Config relating to colors and styles.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#color-attributes",
"properties": {
"activeBorderColor": {
"default": [
"green",
"bold"
],
"description": "Border color of focused window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitBgColor": {
"default": [
"cyan"
],
"description": "Background color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"cherryPickedCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of copied commit",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"defaultFgColor": {
"default": [
"default"
],
"description": "Default text color",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"inactiveBorderColor": {
"default": [
"default"
],
"description": "Border color of non-focused windows",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"markedBaseCommitBgColor": {
"default": [
"yellow"
],
"description": "Background color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"markedBaseCommitFgColor": {
"default": [
"blue"
],
"description": "Foreground color of marked base commit (for rebase)",
"items": {
"type": "string"
},
"type": "array"
},
"optionsTextColor": {
"default": [
"blue"
],
"description": "Color of keybindings help text in the bottom line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"searchingActiveBorderColor": {
"default": [
"cyan",
"bold"
],
"description": "Border color of focused window when searching in that window",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedLineBgColor": {
"default": [
"blue"
],
"description": "Background color of selected line.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"selectedRangeBgColor": {
"default": [
"blue"
],
"description": "Background color of selected range\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#highlighting-the-selected-line",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"unstagedChangesColor": {
"default": [
"red"
],
"description": "Color for file with unstaged changes",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"timeFormat": {
"default": "02 Jan 06",
"description": "Format used when displaying time e.g. commit time.\nUses Go's time format syntax: https://pkg.go.dev/time#Time.Format",
"type": "string"
},
"windowSize": {
"description": "Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).\nOne of: 'normal' (default) | 'half' | 'full'",
"enum": [
"normal",
"half",
"full"
],
"type": "string"
}
},
"type": "object"
},
"keybinding": {
"additionalProperties": false,
"description": "Keybindings",
"properties": {
"branches": {
"additionalProperties": false,
"properties": {
"checkoutBranchByName": {
"default": "c",
"type": "string"
},
"copyPullRequestURL": {
"default": "<c-y>",
"type": "string"
},
"createPullRequest": {
"default": "o",
"type": "string"
},
"createTag": {
"default": "T",
"type": "string"
},
"fastForward": {
"default": "f",
"type": "string"
},
"fetchRemote": {
"default": "f",
"type": "string"
},
"forceCheckoutBranch": {
"default": "F",
"type": "string"
},
"mergeIntoCurrentBranch": {
"default": "M",
"type": "string"
},
"pushTag": {
"default": "P",
"type": "string"
},
"rebaseBranch": {
"default": "r",
"type": "string"
},
"renameBranch": {
"default": "R",
"type": "string"
},
"setUpstream": {
"default": "u",
"type": "string"
},
"viewGitFlowOptions": {
"default": "i",
"type": "string"
},
"viewPullRequestOptions": {
"default": "O",
"type": "string"
}
},
"type": "object"
},
"commitFiles": {
"additionalProperties": false,
"properties": {
"checkoutCommitFile": {
"default": "c",
"type": "string"
}
},
"type": "object"
},
"commitMessage": {
"additionalProperties": false,
"properties": {
"switchToEditor": {
"default": "<c-o>",
"type": "string"
}
},
"type": "object"
},
"commits": {
"additionalProperties": false,
"properties": {
"amendToCommit": {
"default": "A",
"type": "string"
},
"checkoutCommit": {
"default": "<space>",
"type": "string"
},
"cherryPickCopy": {
"default": "c",
"type": "string"
},
"cherryPickCopyRange": {
"default": "C",
"type": "string"
},
"copyCommitAttributeToClipboard": {
"default": "y",
"type": "string"
},
"createFixupCommit": {
"default": "F",
"type": "string"
},
"markCommitAsBaseForRebase": {
"default": "B",
"type": "string"
},
"markCommitAsFixup": {
"default": "f",
"type": "string"
},
"moveDownCommit": {
"default": "<c-j>",
"type": "string"
},
"moveUpCommit": {
"default": "<c-k>",
"type": "string"
},
"openInBrowser": {
"default": "o",
"type": "string"
},
"openLogMenu": {
"default": "<c-l>",
"type": "string"
},
"pasteCommits": {
"default": "v",
"type": "string"
},
"pickCommit": {
"default": "p",
"type": "string"
},
"renameCommit": {
"default": "r",
"type": "string"
},
"renameCommitWithEditor": {
"default": "R",
"type": "string"
},
"resetCherryPick": {
"default": "<c-R>",
"type": "string"
},
"resetCommitAuthor": {
"default": "a",
"type": "string"
},
"revertCommit": {
"default": "t",
"type": "string"
},
"squashAboveCommits": {
"default": "S",
"type": "string"
},
"squashDown": {
"default": "s",
"type": "string"
},
"tagCommit": {
"default": "T",
"type": "string"
},
"viewBisectOptions": {
"default": "b",
"type": "string"
},
"viewResetOptions": {
"default": "g",
"type": "string"
}
},
"type": "object"
},
"files": {
"additionalProperties": false,
"properties": {
"amendLastCommit": {
"default": "A",
"type": "string"
},
"commitChanges": {
"default": "c",
"type": "string"
},
"commitChangesWithEditor": {
"default": "C",
"type": "string"
},
"commitChangesWithoutHook": {
"default": "w",
"type": "string"
},
"confirmDiscard": {
"default": "x",
"type": "string"
},
"fetch": {
"default": "f",
"type": "string"
},
"ignoreFile": {
"default": "i",
"type": "string"
},
"openMergeTool": {
"default": "M",
"type": "string"
},
"openStatusFilter": {
"default": "<c-b>",
"type": "string"
},
"refreshFiles": {
"default": "r",
"type": "string"
},
"stashAllChanges": {
"default": "s",
"type": "string"
},
"toggleStagedAll": {
"default": "a",
"type": "string"
},
"toggleTreeView": {
"default": "`",
"type": "string"
},
"viewResetOptions": {
"default": "D",
"type": "string"
},
"viewStashOptions": {
"default": "S",
"type": "string"
}
},
"type": "object"
},
"main": {
"additionalProperties": false,
"properties": {
"editSelectHunk": {
"default": "E",
"type": "string"
},
"pickBothHunks": {
"default": "b",
"type": "string"
},
"toggleDragSelect": {
"default": "v",
"type": "string"
},
"toggleDragSelect-alt": {
"default": "V",
"type": "string"
},
"toggleSelectHunk": {
"default": "a",
"type": "string"
}
},
"type": "object"
},
"stash": {
"additionalProperties": false,
"properties": {
"popStash": {
"default": "g",
"type": "string"
},
"renameStash": {
"default": "r",
"type": "string"
}
},
"type": "object"
},
"status": {
"additionalProperties": false,
"properties": {
"allBranchesLogGraph": {
"default": "a",
"type": "string"
},
"checkForUpdate": {
"default": "u",
"type": "string"
},
"recentRepos": {
"default": "<enter>",
"type": "string"
}
},
"type": "object"
},
"submodules": {
"additionalProperties": false,
"properties": {
"bulkMenu": {
"default": "b",
"type": "string"
},
"init": {
"default": "i",
"type": "string"
},
"update": {
"default": "u",
"type": "string"
}
},
"type": "object"
},
"universal": {
"additionalProperties": false,
"properties": {
"confirm": {
"default": "<enter>",
"type": "string"
},
"confirmInEditor": {
"default": "<a-enter>",
"type": "string"
},
"copyToClipboard": {
"default": "<c-o>",
"type": "string"
},
"createPatchOptionsMenu": {
"default": "<c-p>",
"type": "string"
},
"createRebaseOptionsMenu": {
"default": "m",
"type": "string"
},
"decreaseContextInDiffView": {
"default": "{",
"type": "string"
},
"diffingMenu": {
"default": "W",
"type": "string"
},
"diffingMenu-alt": {
"default": "<c-e>",
"type": "string"
},
"edit": {
"default": "e",
"type": "string"
},
"executeCustomCommand": {
"default": ":",
"type": "string"
},
"extrasMenu": {
"default": "@",
"type": "string"
},
"filteringMenu": {
"default": "<c-s>",
"type": "string"
},
"goInto": {
"default": "<enter>",
"type": "string"
},
"gotoBottom": {
"default": ">",
"type": "string"
},
"gotoTop": {
"default": "<",
"type": "string"
},
"increaseContextInDiffView": {
"default": "}",
"type": "string"
},
"jumpToBlock": {
"default": [
"1",
"2",
"3",
"4",
"5"
],
"items": {
"type": "string"
},
"type": "array"
},
"new": {
"default": "n",
"type": "string"
},
"nextBlock": {
"default": "<right>",
"type": "string"
},
"nextBlock-alt": {
"default": "l",
"type": "string"
},
"nextBlock-alt2": {
"default": "<tab>",
"type": "string"
},
"nextItem": {
"default": "<down>",
"type": "string"
},
"nextItem-alt": {
"default": "j",
"type": "string"
},
"nextMatch": {
"default": "n",
"type": "string"
},
"nextPage": {
"default": ".",
"type": "string"
},
"nextScreenMode": {
"default": "+",
"type": "string"
},
"nextTab": {
"default": "]",
"type": "string"
},
"openFile": {
"default": "o",
"type": "string"
},
"openRecentRepos": {
"default": "<c-r>",
"type": "string"
},
"optionMenu": {
"default": "<disabled>",
"type": "string"
},
"optionMenu-alt1": {
"default": "?",
"type": "string"
},
"prevBlock": {
"default": "<left>",
"type": "string"
},
"prevBlock-alt": {
"default": "h",
"type": "string"
},
"prevBlock-alt2": {
"default": "<backtab>",
"type": "string"
},
"prevItem": {
"default": "<up>",
"type": "string"
},
"prevItem-alt": {
"default": "k",
"type": "string"
},
"prevMatch": {
"default": "N",
"type": "string"
},
"prevPage": {
"default": ",",
"type": "string"
},
"prevScreenMode": {
"default": "_",
"type": "string"
},
"prevTab": {
"default": "[",
"type": "string"
},
"pullFiles": {
"default": "p",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"pushFiles": {
"default": "P",
"description": "'Files' appended for legacy reasons",
"type": "string"
},
"quit": {
"default": "q",
"type": "string"
},
"quit-alt1": {
"default": "<c-c>",
"type": "string"
},
"quitWithoutChangingDirectory": {
"default": "Q",
"type": "string"
},
"redo": {
"default": "<c-z>",
"type": "string"
},
"refresh": {
"default": "R",
"type": "string"
},
"remove": {
"default": "d",
"type": "string"
},
"return": {
"default": "<esc>",
"type": "string"
},
"scrollDownMain": {
"default": "<pgdown>",
"type": "string"
},
"scrollDownMain-alt1": {
"default": "J",
"type": "string"
},
"scrollDownMain-alt2": {
"default": "<c-d>",
"type": "string"
},
"scrollLeft": {
"default": "H",
"type": "string"
},
"scrollRight": {
"default": "L",
"type": "string"
},
"scrollUpMain": {
"default": "<pgup>",
"type": "string"
},
"scrollUpMain-alt1": {
"default": "K",
"type": "string"
},
"scrollUpMain-alt2": {
"default": "<c-u>",
"type": "string"
},
"select": {
"default": "<space>",
"type": "string"
},
"startSearch": {
"default": "/",
"type": "string"
},
"submitEditorText": {
"default": "<enter>",
"type": "string"
},
"togglePanel": {
"default": "<tab>",
"type": "string"
},
"toggleWhitespaceInDiffView": {
"default": "<c-w>",
"type": "string"
},
"undo": {
"default": "z",
"type": "string"
}
},
"type": "object"
},
"worktrees": {
"additionalProperties": false,
"properties": {
"viewWorktreeOptions": {
"default": "w",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"notARepository": {
"default": "prompt",
"description": "What to do when opening Lazygit outside of a git repo.\n- 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo\n- 'create': initialize a new repo\n- 'skip': open most recent repo\n- 'quit': exit Lazygit",
"enum": [
"prompt",
"create",
"skip",
"quit"
],
"type": "string"
},
"os": {
"additionalProperties": false,
"description": "Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc",
"properties": {
"copyToClipboardCmd": {
"description": "CopyToClipboardCmd is the command for copying to clipboard.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard",
"type": "string"
},
"edit": {
"description": "Command for editing a file. Should contain \"{{filename}}\".",
"type": "string"
},
"editAtLine": {
"description": "Command for editing a file at a given line number. Should contain\n\"{{filename}}\", and may optionally contain \"{{line}}\".",
"type": "string"
},
"editAtLineAndWait": {
"description": "Same as EditAtLine, except that the command needs to wait until the\nwindow is closed.",
"type": "string"
},
"editCommand": {
"description": "EditCommand is the command for editing a file.\nDeprecated: use Edit instead. Note that semantics are different:\nEditCommand is just the command itself, whereas Edit contains a\n\"{{filename}}\" variable.",
"type": "string"
},
"editCommandTemplate": {
"description": "EditCommandTemplate is the command template for editing a file\nDeprecated: use EditAtLine instead.",
"type": "string"
},
"editInTerminal": {
"description": "Whether lazygit suspends until an edit process returns\nPointer to bool so that we can distinguish unset (nil) from false.\nWe're naming this `editInTerminal` for backwards compatibility",
"type": "boolean"
},
"editPreset": {
"description": "A built-in preset that sets all of the above settings. Supported presets\nare defined in the getPreset function in editor_presets.go.",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"kakoune",
"helix",
"xcode"
],
"type": "string"
},
"open": {
"description": "Command for opening a file, as if the file is double-clicked. Should\ncontain \"{{filename}}\", but doesn't support \"{{line}}\".",
"type": "string"
},
"openCommand": {
"description": "OpenCommand is the command for opening a file\nDeprecated: use Open instead.",
"type": "string"
},
"openDirInEditor": {
"description": "For opening a directory in an editor",
"type": "string"
},
"openLink": {
"description": "Command for opening a link. Should contain \"{{link}}\".",
"type": "string"
},
"openLinkCommand": {
"description": "OpenLinkCommand is the command for opening a link\nDeprecated: use OpenLink instead.",
"type": "string"
}
},
"type": "object"
},
"promptToReturnFromSubprocess": {
"default": true,
"description": "If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.",
"type": "boolean"
},
"quitOnTopLevelReturn": {
"description": "If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close",
"type": "boolean"
},
"refresher": {
"additionalProperties": false,
"description": "Background refreshes",
"properties": {
"fetchInterval": {
"default": 60,
"description": "Re-fetch interval in seconds.\nAuto-fetch can be disabled via option 'git.autoFetch'.",
"minimum": 0,
"type": "integer"
},
"refreshInterval": {
"default": 10,
"description": "File/submodule refresh interval in seconds.\nAuto-refresh can be disabled via option 'git.autoRefresh'.",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"services": {
"additionalProperties": {
"type": "string"
},
"description": "See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Periodic update checks",
"properties": {
"days": {
"default": 14,
"description": "Period in days between update checks",
"minimum": 0,
"type": "integer"
},
"method": {
"default": "prompt",
"description": "One of: 'prompt' (default) | 'background' | 'never'",
"enum": [
"prompt",
"background",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
open-telemetry/oteps | d02a3e2e75dc934fb38c5db88eb41fbe85730af4 | 2023-03-30T13:00:05 | text/assets/0225-schema.json | 321 | 2024-05-29T15:24:41.977096Z | {
"$ref": "#/definitions/OpenTelemetryConfiguration",
"$schema": "https://json-schema.org/draft-06/schema",
"definitions": {
"Aggregation": {
"additionalProperties": false,
"properties": {
"args": {
"$ref": "#/definitions/AggregationArgs"
},
"type": {
"type": "string"
}
},
"required": [
"args",
"type"
],
"title": "Aggregation",
"type": "object"
},
"AggregationArgs": {
"additionalProperties": false,
"properties": {
"boundaries": {
"items": {
"type": "number"
},
"type": "array"
},
"max_size": {
"type": "integer"
},
"record_min_max": {
"type": "boolean"
}
},
"required": [
"boundaries",
"max_size",
"record_min_max"
],
"title": "AggregationArgs",
"type": "object"
},
"Attributes": {
"additionalProperties": true,
"properties": {
"service.name": {
"type": "string"
}
},
"required": [
"service.name"
],
"title": "Attributes",
"type": "object"
},
"Headers": {
"additionalProperties": true,
"title": "Headers",
"type": "object"
},
"Jaeger": {
"additionalProperties": false,
"properties": {
"agent_host": {
"type": "string"
},
"agent_port": {
"type": "integer"
},
"endpoint": {
"format": "uri",
"qt-uri-protocols": [
"http"
],
"type": "string"
},
"password": {
"type": "string"
},
"protocol": {
"pattern": "^http/thrift.binary$",
"type": "string"
},
"timeout": {
"type": "integer"
},
"user": {
"type": "string"
}
},
"required": [
"agent_host",
"agent_port",
"endpoint",
"password",
"protocol",
"timeout",
"user"
],
"title": "Jaeger",
"type": "object"
},
"JaegerRemote": {
"additionalProperties": false,
"properties": {
"endpoint": {
"format": "uri",
"qt-uri-protocols": [
"http"
],
"type": "string"
},
"initial_sampling_rate": {
"type": "number"
},
"polling_interval": {
"type": "integer"
}
},
"required": [
"endpoint",
"initial_sampling_rate",
"polling_interval"
],
"title": "JaegerRemote",
"type": "object"
},
"Limits": {
"additionalProperties": false,
"properties": {
"attribute_count_limit": {
"type": "integer"
},
"attribute_value_length_limit": {
"type": "integer"
}
},
"required": [
"attribute_count_limit",
"attribute_value_length_limit"
],
"title": "Limits",
"type": "object"
},
"LogRecordProcessorArgs": {
"additionalProperties": false,
"properties": {
"export_timeout": {
"type": "integer"
},
"exporter": {
"type": "string"
},
"max_export_batch_size": {
"type": "integer"
},
"max_queue_size": {
"type": "integer"
},
"schedule_delay": {
"type": "integer"
}
},
"required": [
"exporter"
],
"title": "LogRecordProcessorArgs",
"type": "object"
},
"LoggerProvider": {
"additionalProperties": false,
"properties": {
"exporters": {
"$ref": "#/definitions/LoggerProviderExporters"
},
"log_record_limits": {
"$ref": "#/definitions/Limits"
},
"log_record_processors": {
"items": {
"$ref": "#/definitions/Processor"
},
"type": "array"
}
},
"required": [
"exporters",
"log_record_limits",
"log_record_processors"
],
"title": "LoggerProvider",
"type": "object"
},
"LoggerProviderExporters": {
"additionalProperties": false,
"properties": {
"otlp": {
"$ref": "#/definitions/Otlp"
}
},
"required": [
"otlp"
],
"title": "LoggerProviderExporters",
"type": "object"
},
"MeterProvider": {
"additionalProperties": false,
"properties": {
"exporters": {
"$ref": "#/definitions/LoggerProviderExporters"
},
"metric_readers": {
"items": {
"$ref": "#/definitions/MetricReader"
},
"type": "array"
},
"views": {
"items": {
"$ref": "#/definitions/ViewElement"
},
"type": "array"
}
},
"required": [
"exporters",
"metric_readers",
"views"
],
"title": "MeterProvider",
"type": "object"
},
"MetricReader": {
"additionalProperties": false,
"properties": {
"args": {
"$ref": "#/definitions/MetricReaderArgs"
},
"type": {
"type": "string"
}
},
"required": [
"args",
"type"
],
"title": "MetricReader",
"type": "object"
},
"MetricReaderArgs": {
"additionalProperties": false,
"properties": {
"exporter": {
"type": "string"
},
"host": {
"type": "string"
},
"interval": {
"type": "integer"
},
"port": {
"type": "integer"
},
"timeout": {
"type": "integer"
}
},
"required": [],
"title": "MetricReaderArgs",
"type": "object"
},
"OpenTelemetryConfiguration": {
"additionalProperties": false,
"properties": {
"scheme_version": {
"type": "number"
},
"sdk": {
"$ref": "#/definitions/SDK"
}
},
"required": [
"scheme_version",
"sdk"
],
"title": "OpenTelemetryConfiguration",
"type": "object"
},
"Otlp": {
"additionalProperties": false,
"properties": {
"certificate": {
"type": "string"
},
"client_certificate": {
"type": "string"
},
"client_key": {
"type": "string"
},
"compression": {
"type": "string"
},
"default_histogram_aggregation": {
"type": "string"
},
"endpoint": {
"format": "uri",
"qt-uri-protocols": [
"http"
],
"type": "string"
},
"headers": {
"$ref": "#/definitions/Headers"
},
"protocol": {
"pattern": "^(http|grpc)\\/(protobuf|json)",
"type": "string"
},
"temporality_preference": {
"type": "string"
},
"timeout": {
"type": "integer"
}
},
"required": [
"endpoint",
"protocol"
],
"title": "Otlp",
"type": "object"
},
"ParentBased": {
"additionalProperties": false,
"properties": {
"local_parent_not_sampled": {
"type": "string"
},
"local_parent_sampled": {
"type": "string"
},
"remote_parent_not_sampled": {
"type": "string"
},
"remote_parent_sampled": {
"type": "string"
},
"root": {
"type": "string"
}
},
"required": [
"local_parent_not_sampled",
"local_parent_sampled",
"remote_parent_not_sampled",
"remote_parent_sampled",
"root"
],
"title": "ParentBased",
"type": "object"
},
"Processor": {
"additionalProperties": false,
"properties": {
"args": {
"$ref": "#/definitions/LogRecordProcessorArgs"
},
"type": {
"type": "string"
}
},
"required": [
"args",
"type"
],
"title": "Processor",
"type": "object"
},
"Resource": {
"additionalProperties": false,
"properties": {
"attributes": {
"$ref": "#/definitions/Attributes"
}
},
"required": [
"attributes"
],
"title": "Resource",
"type": "object"
},
"SDK": {
"additionalProperties": false,
"properties": {
"attribute_limits": {
"$ref": "#/definitions/Limits"
},
"disabled": {
"type": "boolean"
},
"logger_provider": {
"$ref": "#/definitions/LoggerProvider"
},
"meter_provider": {
"$ref": "#/definitions/MeterProvider"
},
"propagators": {
"items": {
"type": "string"
},
"type": "array"
},
"resource": {
"$ref": "#/definitions/Resource"
},
"tracer_provider": {
"$ref": "#/definitions/TracerProvider"
}
},
"required": [
"disabled"
],
"title": "SDK",
"type": "object"
},
"SamplerConfig": {
"additionalProperties": false,
"properties": {
"always_off": {
"type": "null"
},
"always_on": {
"type": "null"
},
"jaeger_remote": {
"$ref": "#/definitions/JaegerRemote"
},
"parent_based": {
"$ref": "#/definitions/ParentBased"
},
"trace_id_ratio_based": {
"$ref": "#/definitions/TraceIDRatioBased"
}
},
"required": [
"always_off",
"always_on",
"jaeger_remote",
"parent_based",
"trace_id_ratio_based"
],
"title": "SamplerConfig",
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"instrument_name": {
"type": "string"
},
"instrument_type": {
"type": "string"
},
"meter_name": {
"type": "string"
},
"meter_schema_url": {
"format": "uri",
"qt-uri-extensions": [
".0"
],
"qt-uri-protocols": [
"https"
],
"type": "string"
},
"meter_version": {
"type": "string"
}
},
"required": [
"instrument_name",
"instrument_type",
"meter_name",
"meter_schema_url",
"meter_version"
],
"title": "Selector",
"type": "object"
},
"SpanLimits": {
"additionalProperties": false,
"properties": {
"attribute_count_limit": {
"type": "integer"
},
"attribute_value_length_limit": {
"type": "integer"
},
"event_attribute_count_limit": {
"type": "integer"
},
"event_count_limit": {
"type": "integer"
},
"link_attribute_count_limit": {
"type": "integer"
},
"link_count_limit": {
"type": "integer"
}
},
"required": [
"attribute_count_limit",
"attribute_value_length_limit",
"event_attribute_count_limit",
"event_count_limit",
"link_attribute_count_limit",
"link_count_limit"
],
"title": "SpanLimits",
"type": "object"
},
"TraceIDRatioBased": {
"additionalProperties": false,
"properties": {
"ratio": {
"type": "number"
}
},
"required": [
"ratio"
],
"title": "TraceIDRatioBased",
"type": "object"
},
"TracerProvider": {
"additionalProperties": false,
"properties": {
"exporters": {
"$ref": "#/definitions/TracerProviderExporters"
},
"sampler": {
"type": "string"
},
"sampler_config": {
"$ref": "#/definitions/SamplerConfig"
},
"span_limits": {
"$ref": "#/definitions/SpanLimits"
},
"span_processors": {
"items": {
"$ref": "#/definitions/Processor"
},
"type": "array"
}
},
"required": [
"exporters",
"span_processors"
],
"title": "TracerProvider",
"type": "object"
},
"TracerProviderExporters": {
"additionalProperties": true,
"patternProperties": {
"^jaeger.*": {
"$ref": "#/definitions/Jaeger"
},
"^otlp.*": {
"$ref": "#/definitions/Otlp"
},
"^zipkin.*": {
"$ref": "#/definitions/Zipkin"
}
},
"title": "TracerProviderExporters",
"type": "object"
},
"ViewElement": {
"additionalProperties": false,
"properties": {
"selector": {
"$ref": "#/definitions/Selector"
},
"view": {
"$ref": "#/definitions/ViewView"
}
},
"required": [
"selector",
"view"
],
"title": "ViewElement",
"type": "object"
},
"ViewView": {
"additionalProperties": false,
"properties": {
"aggregation": {
"$ref": "#/definitions/Aggregation"
},
"attribute_keys": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"aggregation",
"attribute_keys",
"description",
"name"
],
"title": "ViewView",
"type": "object"
},
"Zipkin": {
"additionalProperties": false,
"properties": {
"endpoint": {
"format": "uri",
"qt-uri-protocols": [
"http"
],
"type": "string"
},
"timeout": {
"type": "integer"
}
},
"required": [
"endpoint",
"timeout"
],
"title": "Zipkin",
"type": "object"
}
}
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 0010abef2cf9b5c79be512a15a87c78474afdc18 | 2024-04-30T18:17:00 | charts/opentelemetry-kube-stack/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$defs": {
"AWSElasticBlockStoreVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"partition": {
"type": "integer"
},
"readOnly": {
"type": "boolean"
},
"volumeID": {
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"Affinity": {
"additionalProperties": false,
"properties": {
"nodeAffinity": {
"$ref": "#/$defs/NodeAffinity"
},
"podAffinity": {
"$ref": "#/$defs/PodAffinity"
},
"podAntiAffinity": {
"$ref": "#/$defs/PodAntiAffinity"
}
},
"type": "object"
},
"ApacheHttpd": {
"additionalProperties": false,
"properties": {
"attrs": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"configPath": {
"type": "string"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"version": {
"type": "string"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"AutoscalerSpec": {
"additionalProperties": false,
"properties": {
"behavior": {
"$ref": "#/$defs/HorizontalPodAutoscalerBehavior"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"items": {
"$ref": "#/$defs/MetricSpec"
},
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilization": {
"type": "integer"
},
"targetMemoryUtilization": {
"type": "integer"
}
},
"type": "object"
},
"AzureDiskVolumeSource": {
"additionalProperties": false,
"properties": {
"cachingMode": {
"type": "string"
},
"diskName": {
"type": "string"
},
"diskURI": {
"type": "string"
},
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"diskName",
"diskURI"
],
"type": "object"
},
"AzureFileVolumeSource": {
"additionalProperties": false,
"properties": {
"readOnly": {
"type": "boolean"
},
"secretName": {
"type": "string"
},
"shareName": {
"type": "string"
}
},
"required": [
"secretName",
"shareName"
],
"type": "object"
},
"CSIVolumeSource": {
"additionalProperties": false,
"properties": {
"driver": {
"type": "string"
},
"fsType": {
"type": "string"
},
"nodePublishSecretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"readOnly": {
"type": "boolean"
},
"volumeAttributes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"driver"
],
"type": "object"
},
"Capabilities": {
"additionalProperties": false,
"properties": {
"add": {
"items": {
"type": "string"
},
"type": "array"
},
"drop": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"CephFSVolumeSource": {
"additionalProperties": false,
"properties": {
"monitors": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretFile": {
"type": "string"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"user": {
"type": "string"
}
},
"required": [
"monitors"
],
"type": "object"
},
"CinderVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"volumeID": {
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"ClusterTrustBundleProjection": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"$ref": "#/$defs/LabelSelector"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
},
"path": {
"type": "string"
},
"signerName": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"ConfigMapEnvSource": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"ConfigMapKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"ConfigMapProjection": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/$defs/KeyToPath"
},
"type": "array"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"ConfigMapVolumeSource": {
"additionalProperties": false,
"properties": {
"defaultMode": {
"type": "integer"
},
"items": {
"items": {
"$ref": "#/$defs/KeyToPath"
},
"type": "array"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"ConfigMapsSpec": {
"additionalProperties": false,
"properties": {
"mountPath": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"Container": {
"additionalProperties": false,
"properties": {
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"envFrom": {
"items": {
"$ref": "#/$defs/EnvFromSource"
},
"type": "array"
},
"image": {
"type": "string"
},
"imagePullPolicy": {
"type": "string"
},
"lifecycle": {
"$ref": "#/$defs/Lifecycle"
},
"livenessProbe": {
"$ref": "#/$defs/Probe"
},
"name": {
"type": "string"
},
"ports": {
"items": {
"$ref": "#/$defs/ContainerPort"
},
"type": "array"
},
"readinessProbe": {
"$ref": "#/$defs/Probe"
},
"resizePolicy": {
"items": {
"$ref": "#/$defs/ContainerResizePolicy"
},
"type": "array"
},
"resources": {
"$ref": "#/$defs/ResourceRequirements"
},
"restartPolicy": {
"type": "string"
},
"securityContext": {
"$ref": "#/$defs/SecurityContext"
},
"startupProbe": {
"$ref": "#/$defs/Probe"
},
"stdin": {
"type": "boolean"
},
"stdinOnce": {
"type": "boolean"
},
"terminationMessagePath": {
"type": "string"
},
"terminationMessagePolicy": {
"type": "string"
},
"tty": {
"type": "boolean"
},
"volumeDevices": {
"items": {
"$ref": "#/$defs/VolumeDevice"
},
"type": "array"
},
"volumeMounts": {
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ContainerPort": {
"additionalProperties": false,
"properties": {
"containerPort": {
"type": "integer"
},
"hostIP": {
"type": "string"
},
"hostPort": {
"type": "integer"
},
"name": {
"type": "string"
},
"protocol": {
"type": "string"
}
},
"required": [
"containerPort"
],
"type": "object"
},
"ContainerResizePolicy": {
"additionalProperties": false,
"properties": {
"resourceName": {
"type": "string"
},
"restartPolicy": {
"type": "string"
}
},
"required": [
"resourceName",
"restartPolicy"
],
"type": "object"
},
"DaemonSetUpdateStrategy": {
"additionalProperties": false,
"properties": {
"rollingUpdate": {
"$ref": "#/$defs/RollingUpdateDaemonSet"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"DeploymentStrategy": {
"additionalProperties": false,
"properties": {
"rollingUpdate": {
"$ref": "#/$defs/RollingUpdateDeployment"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"DotNet": {
"additionalProperties": false,
"properties": {
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"DownwardAPIProjection": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/$defs/DownwardAPIVolumeFile"
},
"type": "array"
}
},
"type": "object"
},
"DownwardAPIVolumeFile": {
"additionalProperties": false,
"properties": {
"fieldRef": {
"$ref": "#/$defs/ObjectFieldSelector"
},
"mode": {
"type": "integer"
},
"path": {
"type": "string"
},
"resourceFieldRef": {
"$ref": "#/$defs/ResourceFieldSelector"
}
},
"required": [
"path"
],
"type": "object"
},
"DownwardAPIVolumeSource": {
"additionalProperties": false,
"properties": {
"defaultMode": {
"type": "integer"
},
"items": {
"items": {
"$ref": "#/$defs/DownwardAPIVolumeFile"
},
"type": "array"
}
},
"type": "object"
},
"EmptyDirVolumeSource": {
"additionalProperties": false,
"properties": {
"medium": {
"type": "string"
},
"sizeLimit": {
"$ref": "#/$defs/Quantity"
}
},
"type": "object"
},
"EnvFromSource": {
"additionalProperties": false,
"properties": {
"configMapRef": {
"$ref": "#/$defs/ConfigMapEnvSource"
},
"prefix": {
"type": "string"
},
"secretRef": {
"$ref": "#/$defs/SecretEnvSource"
}
},
"type": "object"
},
"EnvVar": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueFrom": {
"$ref": "#/$defs/EnvVarSource"
}
},
"required": [
"name"
],
"type": "object"
},
"EnvVarSource": {
"additionalProperties": false,
"properties": {
"configMapKeyRef": {
"$ref": "#/$defs/ConfigMapKeySelector"
},
"fieldRef": {
"$ref": "#/$defs/ObjectFieldSelector"
},
"resourceFieldRef": {
"$ref": "#/$defs/ResourceFieldSelector"
},
"secretKeyRef": {
"$ref": "#/$defs/SecretKeySelector"
}
},
"type": "object"
},
"EphemeralVolumeSource": {
"additionalProperties": false,
"properties": {
"volumeClaimTemplate": {
"$ref": "#/$defs/PersistentVolumeClaimTemplate"
}
},
"type": "object"
},
"ExecAction": {
"additionalProperties": false,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Exporter": {
"additionalProperties": false,
"properties": {
"endpoint": {
"type": "string"
}
},
"type": "object"
},
"FCVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"lun": {
"type": "integer"
},
"readOnly": {
"type": "boolean"
},
"targetWWNs": {
"items": {
"type": "string"
},
"type": "array"
},
"wwids": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"FieldsV1": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"FlexVolumeSource": {
"additionalProperties": false,
"properties": {
"driver": {
"type": "string"
},
"fsType": {
"type": "string"
},
"options": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
}
},
"required": [
"driver"
],
"type": "object"
},
"FlockerVolumeSource": {
"additionalProperties": false,
"properties": {
"datasetName": {
"type": "string"
},
"datasetUUID": {
"type": "string"
}
},
"type": "object"
},
"GCEPersistentDiskVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"partition": {
"type": "integer"
},
"pdName": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"pdName"
],
"type": "object"
},
"GitRepoVolumeSource": {
"additionalProperties": false,
"properties": {
"directory": {
"type": "string"
},
"repository": {
"type": "string"
},
"revision": {
"type": "string"
}
},
"required": [
"repository"
],
"type": "object"
},
"GlusterfsVolumeSource": {
"additionalProperties": false,
"properties": {
"endpoints": {
"type": "string"
},
"path": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"endpoints",
"path"
],
"type": "object"
},
"Go": {
"additionalProperties": false,
"properties": {
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"HPAScalingPolicy": {
"additionalProperties": false,
"properties": {
"periodSeconds": {
"type": "integer"
},
"type": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"type",
"value",
"periodSeconds"
],
"type": "object"
},
"HPAScalingRules": {
"additionalProperties": false,
"properties": {
"policies": {
"items": {
"$ref": "#/$defs/HPAScalingPolicy"
},
"type": "array"
},
"selectPolicy": {
"type": "string"
},
"stabilizationWindowSeconds": {
"type": "integer"
}
},
"type": "object"
},
"HTTPGetAction": {
"additionalProperties": false,
"properties": {
"host": {
"type": "string"
},
"httpHeaders": {
"items": {
"$ref": "#/$defs/HTTPHeader"
},
"type": "array"
},
"path": {
"type": "string"
},
"port": {
"type": [
"string",
"integer"
]
},
"scheme": {
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"HTTPHeader": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"HorizontalPodAutoscalerBehavior": {
"additionalProperties": false,
"properties": {
"scaleDown": {
"$ref": "#/$defs/HPAScalingRules"
},
"scaleUp": {
"$ref": "#/$defs/HPAScalingRules"
}
},
"type": "object"
},
"HostPathVolumeSource": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"ISCSIVolumeSource": {
"additionalProperties": false,
"properties": {
"chapAuthDiscovery": {
"type": "boolean"
},
"chapAuthSession": {
"type": "boolean"
},
"fsType": {
"type": "string"
},
"initiatorName": {
"type": "string"
},
"iqn": {
"type": "string"
},
"iscsiInterface": {
"type": "string"
},
"lun": {
"type": "integer"
},
"portals": {
"items": {
"type": "string"
},
"type": "array"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"targetPortal": {
"type": "string"
}
},
"required": [
"targetPortal",
"iqn",
"lun"
],
"type": "object"
},
"Ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"route": {
"$ref": "#/$defs/OpenShiftRoute"
},
"ruleType": {
"type": "string"
},
"tls": {
"items": {
"$ref": "#/$defs/IngressTLS"
},
"type": "array"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"IngressTLS": {
"additionalProperties": false,
"properties": {
"hosts": {
"items": {
"type": "string"
},
"type": "array"
},
"secretName": {
"type": "string"
}
},
"type": "object"
},
"InstrumentationSpec": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"apacheHttpd": {
"$ref": "#/$defs/ApacheHttpd"
},
"dotnet": {
"$ref": "#/$defs/DotNet"
},
"enabled": {
"type": "boolean"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"exporter": {
"$ref": "#/$defs/Exporter"
},
"go": {
"$ref": "#/$defs/Go"
},
"java": {
"$ref": "#/$defs/Java"
},
"labels": {
"type": "object"
},
"name": {
"type": "string"
},
"nginx": {
"$ref": "#/$defs/Nginx"
},
"nodejs": {
"$ref": "#/$defs/NodeJS"
},
"propagators": {
"items": {
"type": "string"
},
"type": "array"
},
"python": {
"$ref": "#/$defs/Python"
},
"resource": {
"$ref": "#/$defs/Resource"
},
"sampler": {
"$ref": "#/$defs/Sampler"
}
},
"type": "object"
},
"IntOrString": {
"additionalProperties": false,
"properties": {
"IntVal": {
"type": "integer"
},
"StrVal": {
"type": "string"
},
"Type": {
"type": "integer"
}
},
"required": [
"Type",
"IntVal",
"StrVal"
],
"type": "object"
},
"Java": {
"additionalProperties": false,
"properties": {
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resources": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"KeyToPath": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"mode": {
"type": "integer"
},
"path": {
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"LabelSelector": {
"additionalProperties": false,
"properties": {
"matchExpressions": {
"items": {
"$ref": "#/$defs/LabelSelectorRequirement"
},
"type": "array"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"LabelSelectorRequirement": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"Lifecycle": {
"additionalProperties": false,
"properties": {
"postStart": {
"$ref": "#/$defs/LifecycleHandler"
},
"preStop": {
"$ref": "#/$defs/LifecycleHandler"
}
},
"type": "object"
},
"LifecycleHandler": {
"additionalProperties": false,
"properties": {
"exec": {
"$ref": "#/$defs/ExecAction"
},
"httpGet": {
"$ref": "#/$defs/HTTPGetAction"
},
"sleep": {
"$ref": "#/$defs/SleepAction"
},
"tcpSocket": {
"$ref": "#/$defs/TCPSocketAction"
}
},
"type": "object"
},
"LocalObjectReference": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
},
"type": "object"
},
"ManagedFieldsEntry": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"fieldsType": {
"type": "string"
},
"fieldsV1": {
"$ref": "#/$defs/FieldsV1"
},
"manager": {
"type": "string"
},
"operation": {
"type": "string"
},
"subresource": {
"type": "string"
},
"time": {
"$ref": "#/$defs/Time"
}
},
"type": "object"
},
"MetricIdentifier": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"selector": {
"$ref": "#/$defs/LabelSelector"
}
},
"required": [
"name"
],
"type": "object"
},
"MetricSpec": {
"additionalProperties": false,
"properties": {
"pods": {
"$ref": "#/$defs/PodsMetricSource"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"MetricTarget": {
"additionalProperties": false,
"properties": {
"averageUtilization": {
"type": "integer"
},
"averageValue": {
"$ref": "#/$defs/Quantity"
},
"type": {
"type": "string"
},
"value": {
"$ref": "#/$defs/Quantity"
}
},
"required": [
"type"
],
"type": "object"
},
"MetricsConfigSpec": {
"additionalProperties": false,
"properties": {
"DisablePrometheusAnnotations": {
"type": "boolean"
},
"enableMetrics": {
"type": "boolean"
}
},
"type": "object"
},
"ModifyVolumeStatus": {
"additionalProperties": false,
"properties": {
"status": {
"type": "string"
},
"targetVolumeAttributesClassName": {
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
},
"NFSVolumeSource": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"server": {
"type": "string"
}
},
"required": [
"server",
"path"
],
"type": "object"
},
"Nginx": {
"additionalProperties": false,
"properties": {
"attrs": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"configFile": {
"type": "string"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"NodeAffinity": {
"additionalProperties": false,
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/PreferredSchedulingTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"$ref": "#/$defs/NodeSelector"
}
},
"type": "object"
},
"NodeJS": {
"additionalProperties": false,
"properties": {
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"NodeSelector": {
"additionalProperties": false,
"properties": {
"nodeSelectorTerms": {
"items": {
"$ref": "#/$defs/NodeSelectorTerm"
},
"type": "array"
}
},
"required": [
"nodeSelectorTerms"
],
"type": "object"
},
"NodeSelectorRequirement": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"NodeSelectorTerm": {
"additionalProperties": false,
"properties": {
"matchExpressions": {
"items": {
"$ref": "#/$defs/NodeSelectorRequirement"
},
"type": "array"
},
"matchFields": {
"items": {
"$ref": "#/$defs/NodeSelectorRequirement"
},
"type": "array"
}
},
"type": "object"
},
"ObjectFieldSelector": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"fieldPath": {
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"creationTimestamp": {
"$ref": "#/$defs/Time"
},
"deletionGracePeriodSeconds": {
"type": "integer"
},
"deletionTimestamp": {
"$ref": "#/$defs/Time"
},
"finalizers": {
"items": {
"type": "string"
},
"type": "array"
},
"generateName": {
"type": "string"
},
"generation": {
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"managedFields": {
"items": {
"$ref": "#/$defs/ManagedFieldsEntry"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"ownerReferences": {
"items": {
"$ref": "#/$defs/OwnerReference"
},
"type": "array"
},
"resourceVersion": {
"type": "string"
},
"selfLink": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
},
"ObservabilitySpec": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/MetricsConfigSpec"
}
},
"type": "object"
},
"OpAMPBridgeSpec": {
"additionalProperties": false,
"properties": {
"addManagedLabel": {
"type": "boolean"
},
"addReportingLabel": {
"type": "boolean"
},
"affinity": {
"$ref": "#/$defs/Affinity"
},
"annotations": {
"type": "object"
},
"capabilities": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"clusterRole": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"componentsAllowed": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"envFrom": {
"items": {
"$ref": "#/$defs/EnvFromSource"
},
"type": "array"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"hostNetwork": {
"type": "boolean"
},
"image": {
"additionalProperties": false,
"description": "Image use in both standalone and agent configs",
"properties": {
"digest": {
"type": "string"
},
"pullPolicy": {
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"type": "string"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"labels": {
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/PodSecurityContext"
},
"ports": {
"items": {
"$ref": "#/$defs/ServicePort"
},
"type": "array"
},
"priorityClassName": {
"type": "string"
},
"resources": {
"$ref": "#/$defs/ResourceRequirements"
},
"securityContext": {
"$ref": "#/$defs/SecurityContext"
},
"serviceAccount": {
"type": "string"
},
"tolerations": {
"items": {
"$ref": "#/$defs/Toleration"
},
"type": "array"
},
"topologySpreadConstraints": {
"items": {
"$ref": "#/$defs/TopologySpreadConstraint"
},
"type": "array"
},
"upgradeStrategy": {
"type": "string"
},
"volumeMounts": {
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"volumes": {
"items": {
"$ref": "#/$defs/Volume"
},
"type": "array"
}
},
"required": [
"endpoint",
"capabilities",
"upgradeStrategy"
],
"type": "object"
},
"OpenShiftRoute": {
"additionalProperties": false,
"properties": {
"termination": {
"type": "string"
}
},
"type": "object"
},
"OpenTelemetryCollectorSpec": {
"additionalProperties": true,
"properties": {
"additionalContainers": {
"items": {
"$ref": "#/$defs/Container"
},
"type": "array"
},
"affinity": {
"$ref": "#/$defs/Affinity"
},
"annotations": {
"type": "object"
},
"args": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"autoscaler": {
"$ref": "#/$defs/AutoscalerSpec"
},
"clusterRoleBinding": {
"properties": {
"clusterRoleName": {
"type": "string"
},
"enabled": {
"default": "true",
"type": "boolean"
}
},
"type": "object"
},
"config": {
"type": "object"
},
"configmaps": {
"items": {
"$ref": "#/$defs/ConfigMapsSpec"
},
"type": "array"
},
"deploymentUpdateStrategy": {
"$ref": "#/$defs/DeploymentStrategy"
},
"enabled": {
"type": "boolean"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"envFrom": {
"items": {
"$ref": "#/$defs/EnvFromSource"
},
"type": "array"
},
"hostNetwork": {
"type": "boolean"
},
"image": {
"additionalProperties": false,
"description": "Image use in both standalone and agent configs",
"properties": {
"digest": {
"type": "string"
},
"pullPolicy": {
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"type": "string"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"ingress": {
"$ref": "#/$defs/Ingress"
},
"initContainers": {
"items": {
"$ref": "#/$defs/Container"
},
"type": "array"
},
"labels": {
"type": "object"
},
"lifecycle": {
"$ref": "#/$defs/Lifecycle"
},
"livenessProbe": {
"$ref": "#/$defs/Probe"
},
"managementState": {
"type": "string"
},
"maxReplicas": {
"type": "integer"
},
"minReplicas": {
"type": "integer"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"observability": {
"$ref": "#/$defs/ObservabilitySpec"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podDisruptionBudget": {
"$ref": "#/$defs/PodDisruptionBudgetSpec"
},
"podSecurityContext": {
"$ref": "#/$defs/PodSecurityContext"
},
"ports": {
"items": {
"$ref": "#/$defs/ServicePort"
},
"type": "array"
},
"priorityClassName": {
"type": "string"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/$defs/ResourceRequirements"
},
"scrape_configs_file": {
"default": "",
"type": "string"
},
"securityContext": {
"$ref": "#/$defs/SecurityContext"
},
"serviceAccount": {
"type": "string"
},
"shareProcessNamespace": {
"type": "boolean"
},
"targetAllocator": {
"$ref": "#/$defs/OpenTelemetryTargetAllocator"
},
"terminationGracePeriodSeconds": {
"type": "integer"
},
"tolerations": {
"items": {
"$ref": "#/$defs/Toleration"
},
"type": "array"
},
"topologySpreadConstraints": {
"items": {
"$ref": "#/$defs/TopologySpreadConstraint"
},
"type": "array"
},
"updateStrategy": {
"$ref": "#/$defs/DaemonSetUpdateStrategy"
},
"upgradeStrategy": {
"type": "string"
},
"volumeClaimTemplates": {
"items": {
"$ref": "#/$defs/PersistentVolumeClaim"
},
"type": "array"
},
"volumeMounts": {
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"volumes": {
"items": {
"$ref": "#/$defs/Volume"
},
"type": "array"
}
},
"type": "object"
},
"OpenTelemetryTargetAllocator": {
"additionalProperties": false,
"properties": {
"affinity": {
"$ref": "#/$defs/Affinity"
},
"allocationStrategy": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"filterStrategy": {
"type": "string"
},
"image": {
"additionalProperties": false,
"description": "Image use in both standalone and agent configs",
"properties": {
"digest": {
"type": "string"
},
"pullPolicy": {
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"type": "string"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"observability": {
"$ref": "#/$defs/ObservabilitySpec"
},
"podDisruptionBudget": {
"$ref": "#/$defs/PodDisruptionBudgetSpec"
},
"podSecurityContext": {
"$ref": "#/$defs/PodSecurityContext"
},
"prometheusCR": {
"$ref": "#/$defs/OpenTelemetryTargetAllocatorPrometheusCR"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/$defs/ResourceRequirements"
},
"securityContext": {
"$ref": "#/$defs/SecurityContext"
},
"serviceAccount": {
"type": "string"
},
"tolerations": {
"items": {
"$ref": "#/$defs/Toleration"
},
"type": "array"
},
"topologySpreadConstraints": {
"items": {
"$ref": "#/$defs/TopologySpreadConstraint"
},
"type": "array"
}
},
"type": "object"
},
"OpenTelemetryTargetAllocatorPrometheusCR": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"podMonitorSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"scrapeInterval": {
"type": "string"
},
"serviceMonitorSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"OwnerReference": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"blockOwnerDeletion": {
"type": "boolean"
},
"controller": {
"type": "boolean"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"type": "object"
},
"PersistentVolumeClaim": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta"
},
"spec": {
"$ref": "#/$defs/PersistentVolumeClaimSpec"
},
"status": {
"$ref": "#/$defs/PersistentVolumeClaimStatus"
}
},
"type": "object"
},
"PersistentVolumeClaimCondition": {
"additionalProperties": false,
"properties": {
"lastProbeTime": {
"$ref": "#/$defs/Time"
},
"lastTransitionTime": {
"$ref": "#/$defs/Time"
},
"message": {
"type": "string"
},
"reason": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"status"
],
"type": "object"
},
"PersistentVolumeClaimSpec": {
"additionalProperties": false,
"properties": {
"accessModes": {
"items": {
"type": "string"
},
"type": "array"
},
"dataSource": {
"$ref": "#/$defs/TypedLocalObjectReference"
},
"dataSourceRef": {
"$ref": "#/$defs/TypedObjectReference"
},
"resources": {
"$ref": "#/$defs/VolumeResourceRequirements"
},
"selector": {
"$ref": "#/$defs/LabelSelector"
},
"storageClassName": {
"type": "string"
},
"volumeAttributesClassName": {
"type": "string"
},
"volumeMode": {
"type": "string"
},
"volumeName": {
"type": "string"
}
},
"type": "object"
},
"PersistentVolumeClaimStatus": {
"additionalProperties": false,
"properties": {
"accessModes": {
"items": {
"type": "string"
},
"type": "array"
},
"allocatedResourceStatuses": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"allocatedResources": {
"$ref": "#/$defs/ResourceList"
},
"capacity": {
"$ref": "#/$defs/ResourceList"
},
"conditions": {
"items": {
"$ref": "#/$defs/PersistentVolumeClaimCondition"
},
"type": "array"
},
"currentVolumeAttributesClassName": {
"type": "string"
},
"modifyVolumeStatus": {
"$ref": "#/$defs/ModifyVolumeStatus"
},
"phase": {
"type": "string"
}
},
"type": "object"
},
"PersistentVolumeClaimTemplate": {
"additionalProperties": false,
"properties": {
"metadata": {
"$ref": "#/$defs/ObjectMeta"
},
"spec": {
"$ref": "#/$defs/PersistentVolumeClaimSpec"
}
},
"required": [
"spec"
],
"type": "object"
},
"PersistentVolumeClaimVolumeSource": {
"additionalProperties": false,
"properties": {
"claimName": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"claimName"
],
"type": "object"
},
"PhotonPersistentDiskVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"pdID": {
"type": "string"
}
},
"required": [
"pdID"
],
"type": "object"
},
"PodAffinity": {
"additionalProperties": false,
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"PodAffinityTerm": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"$ref": "#/$defs/LabelSelector"
},
"matchLabelKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"mismatchLabelKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"namespaceSelector": {
"$ref": "#/$defs/LabelSelector"
},
"namespaces": {
"items": {
"type": "string"
},
"type": "array"
},
"topologyKey": {
"type": "string"
}
},
"required": [
"topologyKey"
],
"type": "object"
},
"PodAntiAffinity": {
"additionalProperties": false,
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"PodDisruptionBudgetSpec": {
"additionalProperties": false,
"properties": {
"maxUnavailable": {
"type": [
"string",
"integer"
]
},
"minAvailable": {
"type": [
"string",
"integer"
]
}
},
"type": "object"
},
"PodSecurityContext": {
"additionalProperties": false,
"properties": {
"fsGroup": {
"type": "integer"
},
"fsGroupChangePolicy": {
"type": "string"
},
"runAsGroup": {
"type": "integer"
},
"runAsNonRoot": {
"type": "boolean"
},
"runAsUser": {
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/$defs/SELinuxOptions"
},
"seccompProfile": {
"$ref": "#/$defs/SeccompProfile"
},
"supplementalGroups": {
"items": {
"type": "integer"
},
"type": "array"
},
"sysctls": {
"items": {
"$ref": "#/$defs/Sysctl"
},
"type": "array"
},
"windowsOptions": {
"$ref": "#/$defs/WindowsSecurityContextOptions"
}
},
"type": "object"
},
"PodsMetricSource": {
"additionalProperties": false,
"properties": {
"metric": {
"$ref": "#/$defs/MetricIdentifier"
},
"target": {
"$ref": "#/$defs/MetricTarget"
}
},
"required": [
"metric",
"target"
],
"type": "object"
},
"PortworxVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"volumeID": {
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"PreferredSchedulingTerm": {
"additionalProperties": false,
"properties": {
"preference": {
"$ref": "#/$defs/NodeSelectorTerm"
},
"weight": {
"type": "integer"
}
},
"required": [
"weight",
"preference"
],
"type": "object"
},
"Probe": {
"additionalProperties": false,
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"terminationGracePeriodSeconds": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"ProjectedVolumeSource": {
"additionalProperties": false,
"properties": {
"defaultMode": {
"type": "integer"
},
"sources": {
"items": {
"$ref": "#/$defs/VolumeProjection"
},
"type": "array"
}
},
"required": [
"sources"
],
"type": "object"
},
"Python": {
"additionalProperties": false,
"properties": {
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"Quantity": {
"additionalProperties": false,
"properties": {
"Format": {
"type": "string"
}
},
"required": [
"Format"
],
"type": "object"
},
"QuobyteVolumeSource": {
"additionalProperties": false,
"properties": {
"group": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"registry": {
"type": "string"
},
"tenant": {
"type": "string"
},
"user": {
"type": "string"
},
"volume": {
"type": "string"
}
},
"required": [
"registry",
"volume"
],
"type": "object"
},
"RBDVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"image": {
"type": "string"
},
"keyring": {
"type": "string"
},
"monitors": {
"items": {
"type": "string"
},
"type": "array"
},
"pool": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"user": {
"type": "string"
}
},
"required": [
"monitors",
"image"
],
"type": "object"
},
"Resource": {
"additionalProperties": false,
"properties": {
"addK8sUIDAttributes": {
"type": "boolean"
},
"resourceAttributes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"ResourceClaim": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ResourceFieldSelector": {
"additionalProperties": false,
"properties": {
"containerName": {
"type": "string"
},
"divisor": {
"$ref": "#/$defs/Quantity"
},
"resource": {
"type": "string"
}
},
"required": [
"resource"
],
"type": "object"
},
"ResourceList": {
"additionalProperties": {
"$ref": "#/$defs/Quantity"
},
"type": "object"
},
"ResourceRequirements": {
"additionalProperties": false,
"properties": {
"limits": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": [
"string",
"integer"
]
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": [
"string",
"integer"
]
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"RollingUpdateDaemonSet": {
"additionalProperties": false,
"properties": {
"maxSurge": {
"type": [
"string",
"integer"
]
},
"maxUnavailable": {
"type": [
"string",
"integer"
]
}
},
"type": "object"
},
"RollingUpdateDeployment": {
"additionalProperties": false,
"properties": {
"maxSurge": {
"type": [
"string",
"integer"
]
},
"maxUnavailable": {
"type": [
"string",
"integer"
]
}
},
"type": "object"
},
"SELinuxOptions": {
"additionalProperties": false,
"properties": {
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"type": {
"type": "string"
},
"user": {
"type": "string"
}
},
"type": "object"
},
"Sampler": {
"additionalProperties": false,
"properties": {
"argument": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"ScaleIOVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"gateway": {
"type": "string"
},
"protectionDomain": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"sslEnabled": {
"type": "boolean"
},
"storageMode": {
"type": "string"
},
"storagePool": {
"type": "string"
},
"system": {
"type": "string"
},
"volumeName": {
"type": "string"
}
},
"required": [
"gateway",
"system",
"secretRef"
],
"type": "object"
},
"SeccompProfile": {
"additionalProperties": false,
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"SecretEnvSource": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"SecretKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"SecretProjection": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/$defs/KeyToPath"
},
"type": "array"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"SecretVolumeSource": {
"additionalProperties": false,
"properties": {
"defaultMode": {
"type": "integer"
},
"items": {
"items": {
"$ref": "#/$defs/KeyToPath"
},
"type": "array"
},
"optional": {
"type": "boolean"
},
"secretName": {
"type": "string"
}
},
"type": "object"
},
"SecurityContext": {
"additionalProperties": false,
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"capabilities": {
"$ref": "#/$defs/Capabilities"
},
"privileged": {
"type": "boolean"
},
"procMount": {
"type": "string"
},
"readOnlyRootFilesystem": {
"type": "boolean"
},
"runAsGroup": {
"type": "integer"
},
"runAsNonRoot": {
"type": "boolean"
},
"runAsUser": {
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/$defs/SELinuxOptions"
},
"seccompProfile": {
"$ref": "#/$defs/SeccompProfile"
},
"windowsOptions": {
"$ref": "#/$defs/WindowsSecurityContextOptions"
}
},
"type": "object"
},
"ServiceAccountTokenProjection": {
"additionalProperties": false,
"properties": {
"audience": {
"type": "string"
},
"expirationSeconds": {
"type": "integer"
},
"path": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"ServicePort": {
"additionalProperties": false,
"properties": {
"appProtocol": {
"type": "string"
},
"name": {
"type": "string"
},
"nodePort": {
"type": "integer"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": [
"string",
"integer"
]
}
},
"required": [
"port"
],
"type": "object"
},
"SleepAction": {
"additionalProperties": false,
"properties": {
"seconds": {
"type": "integer"
}
},
"required": [
"seconds"
],
"type": "object"
},
"StorageOSVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"volumeName": {
"type": "string"
},
"volumeNamespace": {
"type": "string"
}
},
"type": "object"
},
"Sysctl": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"TCPSocketAction": {
"additionalProperties": false,
"properties": {
"host": {
"type": "string"
},
"port": {
"type": [
"string",
"integer"
]
}
},
"required": [
"port"
],
"type": "object"
},
"Time": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"Toleration": {
"additionalProperties": false,
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"tolerationSeconds": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"TopologySpreadConstraint": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"$ref": "#/$defs/LabelSelector"
},
"matchLabelKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"maxSkew": {
"type": "integer"
},
"minDomains": {
"type": "integer"
},
"nodeAffinityPolicy": {
"type": "string"
},
"nodeTaintsPolicy": {
"type": "string"
},
"topologyKey": {
"type": "string"
},
"whenUnsatisfiable": {
"type": "string"
}
},
"required": [
"maxSkew",
"topologyKey",
"whenUnsatisfiable"
],
"type": "object"
},
"TypedLocalObjectReference": {
"additionalProperties": false,
"properties": {
"apiGroup": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiGroup",
"kind",
"name"
],
"type": "object"
},
"TypedObjectReference": {
"additionalProperties": false,
"properties": {
"apiGroup": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
}
},
"required": [
"apiGroup",
"kind",
"name"
],
"type": "object"
},
"Volume": {
"additionalProperties": false,
"properties": {
"awsElasticBlockStore": {
"$ref": "#/$defs/AWSElasticBlockStoreVolumeSource"
},
"azureDisk": {
"$ref": "#/$defs/AzureDiskVolumeSource"
},
"azureFile": {
"$ref": "#/$defs/AzureFileVolumeSource"
},
"cephfs": {
"$ref": "#/$defs/CephFSVolumeSource"
},
"cinder": {
"$ref": "#/$defs/CinderVolumeSource"
},
"configMap": {
"$ref": "#/$defs/ConfigMapVolumeSource"
},
"csi": {
"$ref": "#/$defs/CSIVolumeSource"
},
"downwardAPI": {
"$ref": "#/$defs/DownwardAPIVolumeSource"
},
"emptyDir": {
"$ref": "#/$defs/EmptyDirVolumeSource"
},
"ephemeral": {
"$ref": "#/$defs/EphemeralVolumeSource"
},
"fc": {
"$ref": "#/$defs/FCVolumeSource"
},
"flexVolume": {
"$ref": "#/$defs/FlexVolumeSource"
},
"flocker": {
"$ref": "#/$defs/FlockerVolumeSource"
},
"gcePersistentDisk": {
"$ref": "#/$defs/GCEPersistentDiskVolumeSource"
},
"gitRepo": {
"$ref": "#/$defs/GitRepoVolumeSource"
},
"glusterfs": {
"$ref": "#/$defs/GlusterfsVolumeSource"
},
"hostPath": {
"$ref": "#/$defs/HostPathVolumeSource"
},
"iscsi": {
"$ref": "#/$defs/ISCSIVolumeSource"
},
"name": {
"type": "string"
},
"nfs": {
"$ref": "#/$defs/NFSVolumeSource"
},
"persistentVolumeClaim": {
"$ref": "#/$defs/PersistentVolumeClaimVolumeSource"
},
"photonPersistentDisk": {
"$ref": "#/$defs/PhotonPersistentDiskVolumeSource"
},
"portworxVolume": {
"$ref": "#/$defs/PortworxVolumeSource"
},
"projected": {
"$ref": "#/$defs/ProjectedVolumeSource"
},
"quobyte": {
"$ref": "#/$defs/QuobyteVolumeSource"
},
"rbd": {
"$ref": "#/$defs/RBDVolumeSource"
},
"scaleIO": {
"$ref": "#/$defs/ScaleIOVolumeSource"
},
"secret": {
"$ref": "#/$defs/SecretVolumeSource"
},
"storageos": {
"$ref": "#/$defs/StorageOSVolumeSource"
},
"vsphereVolume": {
"$ref": "#/$defs/VsphereVirtualDiskVolumeSource"
}
},
"required": [
"name"
],
"type": "object"
},
"VolumeDevice": {
"additionalProperties": false,
"properties": {
"devicePath": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"devicePath"
],
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"properties": {
"mountPath": {
"type": "string"
},
"mountPropagation": {
"type": "string"
},
"name": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"subPath": {
"type": "string"
},
"subPathExpr": {
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"VolumeProjection": {
"additionalProperties": false,
"properties": {
"clusterTrustBundle": {
"$ref": "#/$defs/ClusterTrustBundleProjection"
},
"configMap": {
"$ref": "#/$defs/ConfigMapProjection"
},
"downwardAPI": {
"$ref": "#/$defs/DownwardAPIProjection"
},
"secret": {
"$ref": "#/$defs/SecretProjection"
},
"serviceAccountToken": {
"$ref": "#/$defs/ServiceAccountTokenProjection"
}
},
"type": "object"
},
"VolumeResourceRequirements": {
"additionalProperties": false,
"properties": {
"limits": {
"type": "object"
},
"requests": {
"type": "object"
}
},
"type": "object"
},
"VsphereVirtualDiskVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"storagePolicyID": {
"type": "string"
},
"storagePolicyName": {
"type": "string"
},
"volumePath": {
"type": "string"
}
},
"required": [
"volumePath"
],
"type": "object"
},
"WeightedPodAffinityTerm": {
"additionalProperties": false,
"properties": {
"podAffinityTerm": {
"$ref": "#/$defs/PodAffinityTerm"
},
"weight": {
"type": "integer"
}
},
"required": [
"weight",
"podAffinityTerm"
],
"type": "object"
},
"WindowsSecurityContextOptions": {
"additionalProperties": false,
"properties": {
"gmsaCredentialSpec": {
"type": "string"
},
"gmsaCredentialSpecName": {
"type": "string"
},
"hostProcess": {
"type": "boolean"
},
"runAsUserName": {
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://github.com/open-telemetry/opentelemetry-operator/apis/v1alpha1/open-telemetry-collector-spec",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"clusterName": {
"type": "string"
},
"clusterRole": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"collectors": {
"patternProperties": {
"^[a-z]+[a-zA-Z0-9]+$": {
"$ref": "#/$defs/OpenTelemetryCollectorSpec"
}
},
"type": "object"
},
"defaultCRConfig": {
"$ref": "#/$defs/OpenTelemetryCollectorSpec"
},
"extraEnvs": {
"items": {
"type": "object"
},
"type": "array"
},
"fullnameOverride": {
"type": "string"
},
"instrumentation": {
"$ref": "#/$defs/InstrumentationSpec"
},
"namespaceOverride": {
"type": "string"
},
"opAMPBridge": {
"$ref": "#/$defs/OpAMPBridgeSpec"
},
"opentelemetry-operator": {
"type": "object"
}
}
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 258b11dfa9afc70ff38efb97ed8a5979423646e0 | 2023-05-23T14:55:51 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": true,
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretAnnotations": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.77.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"default": {},
"examples": [
{
"autoGenerateCert": true,
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretAnnotations": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"default": true,
"examples": [
true
],
"title": "The autoGenerateCert schema",
"type": "boolean"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"secretAnnotations",
"cert_file",
"key_file",
"ca_file"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.14.1"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.77.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The Go Schema",
"type": "object"
},
"java": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.77.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "operator.autoinstrumentation.go",
"examples": [
"-operator.autoinstrumentation.go,-operator.autoinstrumentation.go"
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.77.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.77.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 2,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 30763a710227621137966281d2a17b55521083d5 | 2024-03-22T18:59:56 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"additionalProperties": false,
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"servicePort": {
"default": 443,
"examples": [
9443
],
"title": "The port for the webhook service",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"cert_file",
"key_file",
"ca_file",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Kubernetes cluster domain suffix",
"type": "string"
},
"clusterRole": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"enabled": {
"description": "Usually used when using Opentelemetry-operator as a subchart.",
"type": "boolean"
},
"global": {
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"additionalProperties": false,
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"additionalProperties": false,
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"additionalProperties": false,
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"clusterDomain",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | f32c273700d3c718f5db0cfd0ae4bc78f4205cd9 | 2024-05-16T16:58:39 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"caFile": "",
"certFile": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"create": true,
"failurePolicy": "Fail",
"keyFile": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"admissionWebhooks": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"caFile": "",
"certFile": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"create": true,
"failurePolicy": "Fail",
"keyFile": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"caFile": {
"default": "",
"examples": [
""
],
"title": "File path to self-managed CA bundle.",
"type": "string"
},
"certFile": {
"default": "",
"examples": [
""
],
"title": "File path to self-managed TLS certificate.",
"type": "string"
},
"certManager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"keyFile": {
"default": "",
"examples": [
""
],
"title": "File path to self-managed TLS key.",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"additionalProperties": false,
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"servicePort": {
"default": 443,
"examples": [
9443
],
"title": "The port for the webhook service",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"certFile",
"keyFile",
"caFile",
"serviceAnnotations",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Kubernetes cluster domain suffix",
"type": "string"
},
"clusterRole": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"crds": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "Create CRDs",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The CRDs Schema",
"type": "object"
},
"enabled": {
"description": "Usually used when using Opentelemetry-operator as a subchart.",
"type": "boolean"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"global": {
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"createRbacPermissions": {
"default": false,
"examples": [
false
],
"title": "Whether the operator should create RBAC permissions for collector deployments",
"type": "boolean"
},
"deploymentAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The deploymentAnnotations Schema",
"type": "object"
},
"env": {
"additionalProperties": {
"type": "string"
},
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"ephemeral-storage": {
"default": "",
"examples": [
"50Mi"
],
"title": "The ephemeral-storage Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"ephemeral-storage": {
"default": "",
"examples": [
"50Mi"
],
"title": "The ephemeral-storage Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
"opentelemetry-operator"
],
"title": "The name of the service account",
"type": "string"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"additionalProperties": false,
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"deploymentAnnotations",
"serviceAnnotations",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"additionalProperties": false,
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"clusterDomain",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"crds",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework",
"additionalLabels"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 87f04373eda314ba9d3e8d5f06e10dc532563fdd | 2023-12-04T17:20:02 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.89.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.89.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"servicePort": {
"default": 443,
"examples": [
9443
],
"title": "The port for the webhook service",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"cert_file",
"key_file",
"ca_file",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.89.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.89.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.89.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.89.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.89.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.89.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | b97500c0d2d0c5f31f3d109102fad160f735ddef | 2023-08-23T14:43:51 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": true,
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretAnnotations": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.83.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"default": {},
"examples": [
{
"autoGenerateCert": true,
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretAnnotations": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"default": true,
"examples": [
true
],
"title": "The autoGenerateCert schema",
"type": "boolean"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"default": {},
"properties": {
"failurePolicy": {
"default": "Ignore",
"examples": [
"Ignore",
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"secretAnnotations",
"cert_file",
"key_file",
"ca_file"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.14.1"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.83.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The Go Schema",
"type": "object"
},
"java": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.77.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "operator.autoinstrumentation.go",
"examples": [
"-operator.autoinstrumentation.go,-operator.autoinstrumentation.go"
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.83.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.83.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 2,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 45f7defe5b39e109e0a460f87ccf4f51d2ecb025 | 2024-04-19T19:31:22 | charts/opentelemetry-kube-stack/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$defs": {
"AWSElasticBlockStoreVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"partition": {
"type": "integer"
},
"readOnly": {
"type": "boolean"
},
"volumeID": {
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"Affinity": {
"additionalProperties": false,
"properties": {
"nodeAffinity": {
"$ref": "#/$defs/NodeAffinity"
},
"podAffinity": {
"$ref": "#/$defs/PodAffinity"
},
"podAntiAffinity": {
"$ref": "#/$defs/PodAntiAffinity"
}
},
"type": "object"
},
"ApacheHttpd": {
"additionalProperties": false,
"properties": {
"attrs": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"configPath": {
"type": "string"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"version": {
"type": "string"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"AutoscalerSpec": {
"additionalProperties": false,
"properties": {
"behavior": {
"$ref": "#/$defs/HorizontalPodAutoscalerBehavior"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"items": {
"$ref": "#/$defs/MetricSpec"
},
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilization": {
"type": "integer"
},
"targetMemoryUtilization": {
"type": "integer"
}
},
"type": "object"
},
"AzureDiskVolumeSource": {
"additionalProperties": false,
"properties": {
"cachingMode": {
"type": "string"
},
"diskName": {
"type": "string"
},
"diskURI": {
"type": "string"
},
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"diskName",
"diskURI"
],
"type": "object"
},
"AzureFileVolumeSource": {
"additionalProperties": false,
"properties": {
"readOnly": {
"type": "boolean"
},
"secretName": {
"type": "string"
},
"shareName": {
"type": "string"
}
},
"required": [
"secretName",
"shareName"
],
"type": "object"
},
"CSIVolumeSource": {
"additionalProperties": false,
"properties": {
"driver": {
"type": "string"
},
"fsType": {
"type": "string"
},
"nodePublishSecretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"readOnly": {
"type": "boolean"
},
"volumeAttributes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"driver"
],
"type": "object"
},
"Capabilities": {
"additionalProperties": false,
"properties": {
"add": {
"items": {
"type": "string"
},
"type": "array"
},
"drop": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"CephFSVolumeSource": {
"additionalProperties": false,
"properties": {
"monitors": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretFile": {
"type": "string"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"user": {
"type": "string"
}
},
"required": [
"monitors"
],
"type": "object"
},
"CinderVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"volumeID": {
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"ClusterTrustBundleProjection": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"$ref": "#/$defs/LabelSelector"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
},
"path": {
"type": "string"
},
"signerName": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"ConfigMapEnvSource": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"ConfigMapKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"ConfigMapProjection": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/$defs/KeyToPath"
},
"type": "array"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"ConfigMapVolumeSource": {
"additionalProperties": false,
"properties": {
"defaultMode": {
"type": "integer"
},
"items": {
"items": {
"$ref": "#/$defs/KeyToPath"
},
"type": "array"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"ConfigMapsSpec": {
"additionalProperties": false,
"properties": {
"mountPath": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"Container": {
"additionalProperties": false,
"properties": {
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"envFrom": {
"items": {
"$ref": "#/$defs/EnvFromSource"
},
"type": "array"
},
"image": {
"type": "string"
},
"imagePullPolicy": {
"type": "string"
},
"lifecycle": {
"$ref": "#/$defs/Lifecycle"
},
"livenessProbe": {
"$ref": "#/$defs/Probe"
},
"name": {
"type": "string"
},
"ports": {
"items": {
"$ref": "#/$defs/ContainerPort"
},
"type": "array"
},
"readinessProbe": {
"$ref": "#/$defs/Probe"
},
"resizePolicy": {
"items": {
"$ref": "#/$defs/ContainerResizePolicy"
},
"type": "array"
},
"resources": {
"$ref": "#/$defs/ResourceRequirements"
},
"restartPolicy": {
"type": "string"
},
"securityContext": {
"$ref": "#/$defs/SecurityContext"
},
"startupProbe": {
"$ref": "#/$defs/Probe"
},
"stdin": {
"type": "boolean"
},
"stdinOnce": {
"type": "boolean"
},
"terminationMessagePath": {
"type": "string"
},
"terminationMessagePolicy": {
"type": "string"
},
"tty": {
"type": "boolean"
},
"volumeDevices": {
"items": {
"$ref": "#/$defs/VolumeDevice"
},
"type": "array"
},
"volumeMounts": {
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ContainerPort": {
"additionalProperties": false,
"properties": {
"containerPort": {
"type": "integer"
},
"hostIP": {
"type": "string"
},
"hostPort": {
"type": "integer"
},
"name": {
"type": "string"
},
"protocol": {
"type": "string"
}
},
"required": [
"containerPort"
],
"type": "object"
},
"ContainerResizePolicy": {
"additionalProperties": false,
"properties": {
"resourceName": {
"type": "string"
},
"restartPolicy": {
"type": "string"
}
},
"required": [
"resourceName",
"restartPolicy"
],
"type": "object"
},
"DaemonSetUpdateStrategy": {
"additionalProperties": false,
"properties": {
"rollingUpdate": {
"$ref": "#/$defs/RollingUpdateDaemonSet"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"DeploymentStrategy": {
"additionalProperties": false,
"properties": {
"rollingUpdate": {
"$ref": "#/$defs/RollingUpdateDeployment"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"DotNet": {
"additionalProperties": false,
"properties": {
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"DownwardAPIProjection": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/$defs/DownwardAPIVolumeFile"
},
"type": "array"
}
},
"type": "object"
},
"DownwardAPIVolumeFile": {
"additionalProperties": false,
"properties": {
"fieldRef": {
"$ref": "#/$defs/ObjectFieldSelector"
},
"mode": {
"type": "integer"
},
"path": {
"type": "string"
},
"resourceFieldRef": {
"$ref": "#/$defs/ResourceFieldSelector"
}
},
"required": [
"path"
],
"type": "object"
},
"DownwardAPIVolumeSource": {
"additionalProperties": false,
"properties": {
"defaultMode": {
"type": "integer"
},
"items": {
"items": {
"$ref": "#/$defs/DownwardAPIVolumeFile"
},
"type": "array"
}
},
"type": "object"
},
"EmptyDirVolumeSource": {
"additionalProperties": false,
"properties": {
"medium": {
"type": "string"
},
"sizeLimit": {
"$ref": "#/$defs/Quantity"
}
},
"type": "object"
},
"EnvFromSource": {
"additionalProperties": false,
"properties": {
"configMapRef": {
"$ref": "#/$defs/ConfigMapEnvSource"
},
"prefix": {
"type": "string"
},
"secretRef": {
"$ref": "#/$defs/SecretEnvSource"
}
},
"type": "object"
},
"EnvVar": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueFrom": {
"$ref": "#/$defs/EnvVarSource"
}
},
"required": [
"name"
],
"type": "object"
},
"EnvVarSource": {
"additionalProperties": false,
"properties": {
"configMapKeyRef": {
"$ref": "#/$defs/ConfigMapKeySelector"
},
"fieldRef": {
"$ref": "#/$defs/ObjectFieldSelector"
},
"resourceFieldRef": {
"$ref": "#/$defs/ResourceFieldSelector"
},
"secretKeyRef": {
"$ref": "#/$defs/SecretKeySelector"
}
},
"type": "object"
},
"EphemeralVolumeSource": {
"additionalProperties": false,
"properties": {
"volumeClaimTemplate": {
"$ref": "#/$defs/PersistentVolumeClaimTemplate"
}
},
"type": "object"
},
"ExecAction": {
"additionalProperties": false,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Exporter": {
"additionalProperties": false,
"properties": {
"endpoint": {
"type": "string"
}
},
"type": "object"
},
"FCVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"lun": {
"type": "integer"
},
"readOnly": {
"type": "boolean"
},
"targetWWNs": {
"items": {
"type": "string"
},
"type": "array"
},
"wwids": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"FieldsV1": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"FlexVolumeSource": {
"additionalProperties": false,
"properties": {
"driver": {
"type": "string"
},
"fsType": {
"type": "string"
},
"options": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
}
},
"required": [
"driver"
],
"type": "object"
},
"FlockerVolumeSource": {
"additionalProperties": false,
"properties": {
"datasetName": {
"type": "string"
},
"datasetUUID": {
"type": "string"
}
},
"type": "object"
},
"GCEPersistentDiskVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"partition": {
"type": "integer"
},
"pdName": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"pdName"
],
"type": "object"
},
"GitRepoVolumeSource": {
"additionalProperties": false,
"properties": {
"directory": {
"type": "string"
},
"repository": {
"type": "string"
},
"revision": {
"type": "string"
}
},
"required": [
"repository"
],
"type": "object"
},
"GlusterfsVolumeSource": {
"additionalProperties": false,
"properties": {
"endpoints": {
"type": "string"
},
"path": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"endpoints",
"path"
],
"type": "object"
},
"Go": {
"additionalProperties": false,
"properties": {
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"HPAScalingPolicy": {
"additionalProperties": false,
"properties": {
"periodSeconds": {
"type": "integer"
},
"type": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"type",
"value",
"periodSeconds"
],
"type": "object"
},
"HPAScalingRules": {
"additionalProperties": false,
"properties": {
"policies": {
"items": {
"$ref": "#/$defs/HPAScalingPolicy"
},
"type": "array"
},
"selectPolicy": {
"type": "string"
},
"stabilizationWindowSeconds": {
"type": "integer"
}
},
"type": "object"
},
"HTTPGetAction": {
"additionalProperties": false,
"properties": {
"host": {
"type": "string"
},
"httpHeaders": {
"items": {
"$ref": "#/$defs/HTTPHeader"
},
"type": "array"
},
"path": {
"type": "string"
},
"port": {
"type": [
"string",
"integer"
]
},
"scheme": {
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"HTTPHeader": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"HorizontalPodAutoscalerBehavior": {
"additionalProperties": false,
"properties": {
"scaleDown": {
"$ref": "#/$defs/HPAScalingRules"
},
"scaleUp": {
"$ref": "#/$defs/HPAScalingRules"
}
},
"type": "object"
},
"HostPathVolumeSource": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"ISCSIVolumeSource": {
"additionalProperties": false,
"properties": {
"chapAuthDiscovery": {
"type": "boolean"
},
"chapAuthSession": {
"type": "boolean"
},
"fsType": {
"type": "string"
},
"initiatorName": {
"type": "string"
},
"iqn": {
"type": "string"
},
"iscsiInterface": {
"type": "string"
},
"lun": {
"type": "integer"
},
"portals": {
"items": {
"type": "string"
},
"type": "array"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"targetPortal": {
"type": "string"
}
},
"required": [
"targetPortal",
"iqn",
"lun"
],
"type": "object"
},
"Ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"route": {
"$ref": "#/$defs/OpenShiftRoute"
},
"ruleType": {
"type": "string"
},
"tls": {
"items": {
"$ref": "#/$defs/IngressTLS"
},
"type": "array"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"IngressTLS": {
"additionalProperties": false,
"properties": {
"hosts": {
"items": {
"type": "string"
},
"type": "array"
},
"secretName": {
"type": "string"
}
},
"type": "object"
},
"InstrumentationSpec": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"apacheHttpd": {
"$ref": "#/$defs/ApacheHttpd"
},
"dotnet": {
"$ref": "#/$defs/DotNet"
},
"enabled": {
"type": "boolean"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"exporter": {
"$ref": "#/$defs/Exporter"
},
"go": {
"$ref": "#/$defs/Go"
},
"java": {
"$ref": "#/$defs/Java"
},
"labels": {
"type": "object"
},
"name": {
"type": "string"
},
"nginx": {
"$ref": "#/$defs/Nginx"
},
"nodejs": {
"$ref": "#/$defs/NodeJS"
},
"propagators": {
"items": {
"type": "string"
},
"type": "array"
},
"python": {
"$ref": "#/$defs/Python"
},
"resource": {
"$ref": "#/$defs/Resource"
},
"sampler": {
"$ref": "#/$defs/Sampler"
}
},
"type": "object"
},
"IntOrString": {
"additionalProperties": false,
"properties": {
"IntVal": {
"type": "integer"
},
"StrVal": {
"type": "string"
},
"Type": {
"type": "integer"
}
},
"required": [
"Type",
"IntVal",
"StrVal"
],
"type": "object"
},
"Java": {
"additionalProperties": false,
"properties": {
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resources": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"KeyToPath": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"mode": {
"type": "integer"
},
"path": {
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"LabelSelector": {
"additionalProperties": false,
"properties": {
"matchExpressions": {
"items": {
"$ref": "#/$defs/LabelSelectorRequirement"
},
"type": "array"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"LabelSelectorRequirement": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"Lifecycle": {
"additionalProperties": false,
"properties": {
"postStart": {
"$ref": "#/$defs/LifecycleHandler"
},
"preStop": {
"$ref": "#/$defs/LifecycleHandler"
}
},
"type": "object"
},
"LifecycleHandler": {
"additionalProperties": false,
"properties": {
"exec": {
"$ref": "#/$defs/ExecAction"
},
"httpGet": {
"$ref": "#/$defs/HTTPGetAction"
},
"sleep": {
"$ref": "#/$defs/SleepAction"
},
"tcpSocket": {
"$ref": "#/$defs/TCPSocketAction"
}
},
"type": "object"
},
"LocalObjectReference": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
},
"type": "object"
},
"ManagedFieldsEntry": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"fieldsType": {
"type": "string"
},
"fieldsV1": {
"$ref": "#/$defs/FieldsV1"
},
"manager": {
"type": "string"
},
"operation": {
"type": "string"
},
"subresource": {
"type": "string"
},
"time": {
"$ref": "#/$defs/Time"
}
},
"type": "object"
},
"MetricIdentifier": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"selector": {
"$ref": "#/$defs/LabelSelector"
}
},
"required": [
"name"
],
"type": "object"
},
"MetricSpec": {
"additionalProperties": false,
"properties": {
"pods": {
"$ref": "#/$defs/PodsMetricSource"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"MetricTarget": {
"additionalProperties": false,
"properties": {
"averageUtilization": {
"type": "integer"
},
"averageValue": {
"$ref": "#/$defs/Quantity"
},
"type": {
"type": "string"
},
"value": {
"$ref": "#/$defs/Quantity"
}
},
"required": [
"type"
],
"type": "object"
},
"MetricsConfigSpec": {
"additionalProperties": false,
"properties": {
"DisablePrometheusAnnotations": {
"type": "boolean"
},
"enableMetrics": {
"type": "boolean"
}
},
"type": "object"
},
"ModifyVolumeStatus": {
"additionalProperties": false,
"properties": {
"status": {
"type": "string"
},
"targetVolumeAttributesClassName": {
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
},
"NFSVolumeSource": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"server": {
"type": "string"
}
},
"required": [
"server",
"path"
],
"type": "object"
},
"Nginx": {
"additionalProperties": false,
"properties": {
"attrs": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"configFile": {
"type": "string"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"NodeAffinity": {
"additionalProperties": false,
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/PreferredSchedulingTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"$ref": "#/$defs/NodeSelector"
}
},
"type": "object"
},
"NodeJS": {
"additionalProperties": false,
"properties": {
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"NodeSelector": {
"additionalProperties": false,
"properties": {
"nodeSelectorTerms": {
"items": {
"$ref": "#/$defs/NodeSelectorTerm"
},
"type": "array"
}
},
"required": [
"nodeSelectorTerms"
],
"type": "object"
},
"NodeSelectorRequirement": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"NodeSelectorTerm": {
"additionalProperties": false,
"properties": {
"matchExpressions": {
"items": {
"$ref": "#/$defs/NodeSelectorRequirement"
},
"type": "array"
},
"matchFields": {
"items": {
"$ref": "#/$defs/NodeSelectorRequirement"
},
"type": "array"
}
},
"type": "object"
},
"ObjectFieldSelector": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"fieldPath": {
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"creationTimestamp": {
"$ref": "#/$defs/Time"
},
"deletionGracePeriodSeconds": {
"type": "integer"
},
"deletionTimestamp": {
"$ref": "#/$defs/Time"
},
"finalizers": {
"items": {
"type": "string"
},
"type": "array"
},
"generateName": {
"type": "string"
},
"generation": {
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"managedFields": {
"items": {
"$ref": "#/$defs/ManagedFieldsEntry"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"ownerReferences": {
"items": {
"$ref": "#/$defs/OwnerReference"
},
"type": "array"
},
"resourceVersion": {
"type": "string"
},
"selfLink": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
},
"ObservabilitySpec": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/MetricsConfigSpec"
}
},
"type": "object"
},
"OpAMPBridgeSpec": {
"additionalProperties": false,
"properties": {
"addManagedLabel": {
"type": "boolean"
},
"addReportingLabel": {
"type": "boolean"
},
"affinity": {
"$ref": "#/$defs/Affinity"
},
"annotations": {
"type": "object"
},
"capabilities": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"clusterRole": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"componentsAllowed": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"enabled": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"envFrom": {
"items": {
"$ref": "#/$defs/EnvFromSource"
},
"type": "array"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"hostNetwork": {
"type": "boolean"
},
"image": {
"additionalProperties": false,
"description": "Image use in both standalone and agent configs",
"properties": {
"digest": {
"type": "string"
},
"pullPolicy": {
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"type": "string"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"labels": {
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podSecurityContext": {
"$ref": "#/$defs/PodSecurityContext"
},
"ports": {
"items": {
"$ref": "#/$defs/ServicePort"
},
"type": "array"
},
"priorityClassName": {
"type": "string"
},
"resources": {
"$ref": "#/$defs/ResourceRequirements"
},
"securityContext": {
"$ref": "#/$defs/SecurityContext"
},
"serviceAccount": {
"type": "string"
},
"tolerations": {
"items": {
"$ref": "#/$defs/Toleration"
},
"type": "array"
},
"topologySpreadConstraints": {
"items": {
"$ref": "#/$defs/TopologySpreadConstraint"
},
"type": "array"
},
"upgradeStrategy": {
"type": "string"
},
"volumeMounts": {
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"volumes": {
"items": {
"$ref": "#/$defs/Volume"
},
"type": "array"
}
},
"required": [
"endpoint",
"capabilities",
"upgradeStrategy"
],
"type": "object"
},
"OpenShiftRoute": {
"additionalProperties": false,
"properties": {
"termination": {
"type": "string"
}
},
"type": "object"
},
"OpenTelemetryCollectorSpec": {
"additionalProperties": true,
"properties": {
"additionalContainers": {
"items": {
"$ref": "#/$defs/Container"
},
"type": "array"
},
"affinity": {
"$ref": "#/$defs/Affinity"
},
"annotations": {
"type": "object"
},
"args": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"autoscaler": {
"$ref": "#/$defs/AutoscalerSpec"
},
"clusterRoleBinding": {
"properties": {
"clusterRoleName": {
"type": "string"
},
"enabled": {
"default": "true",
"type": "boolean"
}
},
"type": "object"
},
"config": {
"type": "object"
},
"configmaps": {
"items": {
"$ref": "#/$defs/ConfigMapsSpec"
},
"type": "array"
},
"deploymentUpdateStrategy": {
"$ref": "#/$defs/DeploymentStrategy"
},
"enabled": {
"type": "boolean"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"envFrom": {
"items": {
"$ref": "#/$defs/EnvFromSource"
},
"type": "array"
},
"hostNetwork": {
"type": "boolean"
},
"image": {
"additionalProperties": false,
"description": "Image use in both standalone and agent configs",
"properties": {
"digest": {
"type": "string"
},
"pullPolicy": {
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"type": "string"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"ingress": {
"$ref": "#/$defs/Ingress"
},
"initContainers": {
"items": {
"$ref": "#/$defs/Container"
},
"type": "array"
},
"labels": {
"type": "object"
},
"lifecycle": {
"$ref": "#/$defs/Lifecycle"
},
"livenessProbe": {
"$ref": "#/$defs/Probe"
},
"managementState": {
"type": "string"
},
"maxReplicas": {
"type": "integer"
},
"minReplicas": {
"type": "integer"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"observability": {
"$ref": "#/$defs/ObservabilitySpec"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podDisruptionBudget": {
"$ref": "#/$defs/PodDisruptionBudgetSpec"
},
"podSecurityContext": {
"$ref": "#/$defs/PodSecurityContext"
},
"ports": {
"items": {
"$ref": "#/$defs/ServicePort"
},
"type": "array"
},
"priorityClassName": {
"type": "string"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/$defs/ResourceRequirements"
},
"scrape_configs_file": {
"default": "",
"type": "string"
},
"securityContext": {
"$ref": "#/$defs/SecurityContext"
},
"serviceAccount": {
"type": "string"
},
"shareProcessNamespace": {
"type": "boolean"
},
"targetAllocator": {
"$ref": "#/$defs/OpenTelemetryTargetAllocator"
},
"terminationGracePeriodSeconds": {
"type": "integer"
},
"tolerations": {
"items": {
"$ref": "#/$defs/Toleration"
},
"type": "array"
},
"topologySpreadConstraints": {
"items": {
"$ref": "#/$defs/TopologySpreadConstraint"
},
"type": "array"
},
"updateStrategy": {
"$ref": "#/$defs/DaemonSetUpdateStrategy"
},
"upgradeStrategy": {
"type": "string"
},
"volumeClaimTemplates": {
"items": {
"$ref": "#/$defs/PersistentVolumeClaim"
},
"type": "array"
},
"volumeMounts": {
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"volumes": {
"items": {
"$ref": "#/$defs/Volume"
},
"type": "array"
}
},
"type": "object"
},
"OpenTelemetryTargetAllocator": {
"additionalProperties": false,
"properties": {
"affinity": {
"$ref": "#/$defs/Affinity"
},
"allocationStrategy": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"filterStrategy": {
"type": "string"
},
"image": {
"additionalProperties": false,
"description": "Image use in both standalone and agent configs",
"properties": {
"digest": {
"type": "string"
},
"pullPolicy": {
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"type": "string"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"observability": {
"$ref": "#/$defs/ObservabilitySpec"
},
"podDisruptionBudget": {
"$ref": "#/$defs/PodDisruptionBudgetSpec"
},
"podSecurityContext": {
"$ref": "#/$defs/PodSecurityContext"
},
"prometheusCR": {
"$ref": "#/$defs/OpenTelemetryTargetAllocatorPrometheusCR"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/$defs/ResourceRequirements"
},
"securityContext": {
"$ref": "#/$defs/SecurityContext"
},
"serviceAccount": {
"type": "string"
},
"tolerations": {
"items": {
"$ref": "#/$defs/Toleration"
},
"type": "array"
},
"topologySpreadConstraints": {
"items": {
"$ref": "#/$defs/TopologySpreadConstraint"
},
"type": "array"
}
},
"type": "object"
},
"OpenTelemetryTargetAllocatorPrometheusCR": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"podMonitorSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"scrapeInterval": {
"type": "string"
},
"serviceMonitorSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"OwnerReference": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"blockOwnerDeletion": {
"type": "boolean"
},
"controller": {
"type": "boolean"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"type": "object"
},
"PersistentVolumeClaim": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta"
},
"spec": {
"$ref": "#/$defs/PersistentVolumeClaimSpec"
},
"status": {
"$ref": "#/$defs/PersistentVolumeClaimStatus"
}
},
"type": "object"
},
"PersistentVolumeClaimCondition": {
"additionalProperties": false,
"properties": {
"lastProbeTime": {
"$ref": "#/$defs/Time"
},
"lastTransitionTime": {
"$ref": "#/$defs/Time"
},
"message": {
"type": "string"
},
"reason": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"status"
],
"type": "object"
},
"PersistentVolumeClaimSpec": {
"additionalProperties": false,
"properties": {
"accessModes": {
"items": {
"type": "string"
},
"type": "array"
},
"dataSource": {
"$ref": "#/$defs/TypedLocalObjectReference"
},
"dataSourceRef": {
"$ref": "#/$defs/TypedObjectReference"
},
"resources": {
"$ref": "#/$defs/VolumeResourceRequirements"
},
"selector": {
"$ref": "#/$defs/LabelSelector"
},
"storageClassName": {
"type": "string"
},
"volumeAttributesClassName": {
"type": "string"
},
"volumeMode": {
"type": "string"
},
"volumeName": {
"type": "string"
}
},
"type": "object"
},
"PersistentVolumeClaimStatus": {
"additionalProperties": false,
"properties": {
"accessModes": {
"items": {
"type": "string"
},
"type": "array"
},
"allocatedResourceStatuses": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"allocatedResources": {
"$ref": "#/$defs/ResourceList"
},
"capacity": {
"$ref": "#/$defs/ResourceList"
},
"conditions": {
"items": {
"$ref": "#/$defs/PersistentVolumeClaimCondition"
},
"type": "array"
},
"currentVolumeAttributesClassName": {
"type": "string"
},
"modifyVolumeStatus": {
"$ref": "#/$defs/ModifyVolumeStatus"
},
"phase": {
"type": "string"
}
},
"type": "object"
},
"PersistentVolumeClaimTemplate": {
"additionalProperties": false,
"properties": {
"metadata": {
"$ref": "#/$defs/ObjectMeta"
},
"spec": {
"$ref": "#/$defs/PersistentVolumeClaimSpec"
}
},
"required": [
"spec"
],
"type": "object"
},
"PersistentVolumeClaimVolumeSource": {
"additionalProperties": false,
"properties": {
"claimName": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"claimName"
],
"type": "object"
},
"PhotonPersistentDiskVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"pdID": {
"type": "string"
}
},
"required": [
"pdID"
],
"type": "object"
},
"PodAffinity": {
"additionalProperties": false,
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"PodAffinityTerm": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"$ref": "#/$defs/LabelSelector"
},
"matchLabelKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"mismatchLabelKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"namespaceSelector": {
"$ref": "#/$defs/LabelSelector"
},
"namespaces": {
"items": {
"type": "string"
},
"type": "array"
},
"topologyKey": {
"type": "string"
}
},
"required": [
"topologyKey"
],
"type": "object"
},
"PodAntiAffinity": {
"additionalProperties": false,
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"PodDisruptionBudgetSpec": {
"additionalProperties": false,
"properties": {
"maxUnavailable": {
"type": [
"string",
"integer"
]
},
"minAvailable": {
"type": [
"string",
"integer"
]
}
},
"type": "object"
},
"PodSecurityContext": {
"additionalProperties": false,
"properties": {
"fsGroup": {
"type": "integer"
},
"fsGroupChangePolicy": {
"type": "string"
},
"runAsGroup": {
"type": "integer"
},
"runAsNonRoot": {
"type": "boolean"
},
"runAsUser": {
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/$defs/SELinuxOptions"
},
"seccompProfile": {
"$ref": "#/$defs/SeccompProfile"
},
"supplementalGroups": {
"items": {
"type": "integer"
},
"type": "array"
},
"sysctls": {
"items": {
"$ref": "#/$defs/Sysctl"
},
"type": "array"
},
"windowsOptions": {
"$ref": "#/$defs/WindowsSecurityContextOptions"
}
},
"type": "object"
},
"PodsMetricSource": {
"additionalProperties": false,
"properties": {
"metric": {
"$ref": "#/$defs/MetricIdentifier"
},
"target": {
"$ref": "#/$defs/MetricTarget"
}
},
"required": [
"metric",
"target"
],
"type": "object"
},
"PortworxVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"volumeID": {
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"PreferredSchedulingTerm": {
"additionalProperties": false,
"properties": {
"preference": {
"$ref": "#/$defs/NodeSelectorTerm"
},
"weight": {
"type": "integer"
}
},
"required": [
"weight",
"preference"
],
"type": "object"
},
"Probe": {
"additionalProperties": false,
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"terminationGracePeriodSeconds": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"ProjectedVolumeSource": {
"additionalProperties": false,
"properties": {
"defaultMode": {
"type": "integer"
},
"sources": {
"items": {
"$ref": "#/$defs/VolumeProjection"
},
"type": "array"
}
},
"required": [
"sources"
],
"type": "object"
},
"Python": {
"additionalProperties": false,
"properties": {
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"Quantity": {
"additionalProperties": false,
"properties": {
"Format": {
"type": "string"
}
},
"required": [
"Format"
],
"type": "object"
},
"QuobyteVolumeSource": {
"additionalProperties": false,
"properties": {
"group": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"registry": {
"type": "string"
},
"tenant": {
"type": "string"
},
"user": {
"type": "string"
},
"volume": {
"type": "string"
}
},
"required": [
"registry",
"volume"
],
"type": "object"
},
"RBDVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"image": {
"type": "string"
},
"keyring": {
"type": "string"
},
"monitors": {
"items": {
"type": "string"
},
"type": "array"
},
"pool": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"user": {
"type": "string"
}
},
"required": [
"monitors",
"image"
],
"type": "object"
},
"Resource": {
"additionalProperties": false,
"properties": {
"addK8sUIDAttributes": {
"type": "boolean"
},
"resourceAttributes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"ResourceClaim": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ResourceFieldSelector": {
"additionalProperties": false,
"properties": {
"containerName": {
"type": "string"
},
"divisor": {
"$ref": "#/$defs/Quantity"
},
"resource": {
"type": "string"
}
},
"required": [
"resource"
],
"type": "object"
},
"ResourceList": {
"additionalProperties": {
"$ref": "#/$defs/Quantity"
},
"type": "object"
},
"ResourceRequirements": {
"additionalProperties": false,
"properties": {
"limits": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": [
"string",
"integer"
]
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": [
"string",
"integer"
]
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"RollingUpdateDaemonSet": {
"additionalProperties": false,
"properties": {
"maxSurge": {
"type": [
"string",
"integer"
]
},
"maxUnavailable": {
"type": [
"string",
"integer"
]
}
},
"type": "object"
},
"RollingUpdateDeployment": {
"additionalProperties": false,
"properties": {
"maxSurge": {
"type": [
"string",
"integer"
]
},
"maxUnavailable": {
"type": [
"string",
"integer"
]
}
},
"type": "object"
},
"SELinuxOptions": {
"additionalProperties": false,
"properties": {
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"type": {
"type": "string"
},
"user": {
"type": "string"
}
},
"type": "object"
},
"Sampler": {
"additionalProperties": false,
"properties": {
"argument": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"ScaleIOVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"gateway": {
"type": "string"
},
"protectionDomain": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"sslEnabled": {
"type": "boolean"
},
"storageMode": {
"type": "string"
},
"storagePool": {
"type": "string"
},
"system": {
"type": "string"
},
"volumeName": {
"type": "string"
}
},
"required": [
"gateway",
"system",
"secretRef"
],
"type": "object"
},
"SeccompProfile": {
"additionalProperties": false,
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"SecretEnvSource": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"SecretKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"SecretProjection": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/$defs/KeyToPath"
},
"type": "array"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"SecretVolumeSource": {
"additionalProperties": false,
"properties": {
"defaultMode": {
"type": "integer"
},
"items": {
"items": {
"$ref": "#/$defs/KeyToPath"
},
"type": "array"
},
"optional": {
"type": "boolean"
},
"secretName": {
"type": "string"
}
},
"type": "object"
},
"SecurityContext": {
"additionalProperties": false,
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"capabilities": {
"$ref": "#/$defs/Capabilities"
},
"privileged": {
"type": "boolean"
},
"procMount": {
"type": "string"
},
"readOnlyRootFilesystem": {
"type": "boolean"
},
"runAsGroup": {
"type": "integer"
},
"runAsNonRoot": {
"type": "boolean"
},
"runAsUser": {
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/$defs/SELinuxOptions"
},
"seccompProfile": {
"$ref": "#/$defs/SeccompProfile"
},
"windowsOptions": {
"$ref": "#/$defs/WindowsSecurityContextOptions"
}
},
"type": "object"
},
"ServiceAccountTokenProjection": {
"additionalProperties": false,
"properties": {
"audience": {
"type": "string"
},
"expirationSeconds": {
"type": "integer"
},
"path": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"ServicePort": {
"additionalProperties": false,
"properties": {
"appProtocol": {
"type": "string"
},
"name": {
"type": "string"
},
"nodePort": {
"type": "integer"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": [
"string",
"integer"
]
}
},
"required": [
"port"
],
"type": "object"
},
"SleepAction": {
"additionalProperties": false,
"properties": {
"seconds": {
"type": "integer"
}
},
"required": [
"seconds"
],
"type": "object"
},
"StorageOSVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"volumeName": {
"type": "string"
},
"volumeNamespace": {
"type": "string"
}
},
"type": "object"
},
"Sysctl": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"TCPSocketAction": {
"additionalProperties": false,
"properties": {
"host": {
"type": "string"
},
"port": {
"type": [
"string",
"integer"
]
}
},
"required": [
"port"
],
"type": "object"
},
"Time": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"Toleration": {
"additionalProperties": false,
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"tolerationSeconds": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"TopologySpreadConstraint": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"$ref": "#/$defs/LabelSelector"
},
"matchLabelKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"maxSkew": {
"type": "integer"
},
"minDomains": {
"type": "integer"
},
"nodeAffinityPolicy": {
"type": "string"
},
"nodeTaintsPolicy": {
"type": "string"
},
"topologyKey": {
"type": "string"
},
"whenUnsatisfiable": {
"type": "string"
}
},
"required": [
"maxSkew",
"topologyKey",
"whenUnsatisfiable"
],
"type": "object"
},
"TypedLocalObjectReference": {
"additionalProperties": false,
"properties": {
"apiGroup": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiGroup",
"kind",
"name"
],
"type": "object"
},
"TypedObjectReference": {
"additionalProperties": false,
"properties": {
"apiGroup": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
}
},
"required": [
"apiGroup",
"kind",
"name"
],
"type": "object"
},
"Volume": {
"additionalProperties": false,
"properties": {
"awsElasticBlockStore": {
"$ref": "#/$defs/AWSElasticBlockStoreVolumeSource"
},
"azureDisk": {
"$ref": "#/$defs/AzureDiskVolumeSource"
},
"azureFile": {
"$ref": "#/$defs/AzureFileVolumeSource"
},
"cephfs": {
"$ref": "#/$defs/CephFSVolumeSource"
},
"cinder": {
"$ref": "#/$defs/CinderVolumeSource"
},
"configMap": {
"$ref": "#/$defs/ConfigMapVolumeSource"
},
"csi": {
"$ref": "#/$defs/CSIVolumeSource"
},
"downwardAPI": {
"$ref": "#/$defs/DownwardAPIVolumeSource"
},
"emptyDir": {
"$ref": "#/$defs/EmptyDirVolumeSource"
},
"ephemeral": {
"$ref": "#/$defs/EphemeralVolumeSource"
},
"fc": {
"$ref": "#/$defs/FCVolumeSource"
},
"flexVolume": {
"$ref": "#/$defs/FlexVolumeSource"
},
"flocker": {
"$ref": "#/$defs/FlockerVolumeSource"
},
"gcePersistentDisk": {
"$ref": "#/$defs/GCEPersistentDiskVolumeSource"
},
"gitRepo": {
"$ref": "#/$defs/GitRepoVolumeSource"
},
"glusterfs": {
"$ref": "#/$defs/GlusterfsVolumeSource"
},
"hostPath": {
"$ref": "#/$defs/HostPathVolumeSource"
},
"iscsi": {
"$ref": "#/$defs/ISCSIVolumeSource"
},
"name": {
"type": "string"
},
"nfs": {
"$ref": "#/$defs/NFSVolumeSource"
},
"persistentVolumeClaim": {
"$ref": "#/$defs/PersistentVolumeClaimVolumeSource"
},
"photonPersistentDisk": {
"$ref": "#/$defs/PhotonPersistentDiskVolumeSource"
},
"portworxVolume": {
"$ref": "#/$defs/PortworxVolumeSource"
},
"projected": {
"$ref": "#/$defs/ProjectedVolumeSource"
},
"quobyte": {
"$ref": "#/$defs/QuobyteVolumeSource"
},
"rbd": {
"$ref": "#/$defs/RBDVolumeSource"
},
"scaleIO": {
"$ref": "#/$defs/ScaleIOVolumeSource"
},
"secret": {
"$ref": "#/$defs/SecretVolumeSource"
},
"storageos": {
"$ref": "#/$defs/StorageOSVolumeSource"
},
"vsphereVolume": {
"$ref": "#/$defs/VsphereVirtualDiskVolumeSource"
}
},
"required": [
"name"
],
"type": "object"
},
"VolumeDevice": {
"additionalProperties": false,
"properties": {
"devicePath": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"devicePath"
],
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"properties": {
"mountPath": {
"type": "string"
},
"mountPropagation": {
"type": "string"
},
"name": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"subPath": {
"type": "string"
},
"subPathExpr": {
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"VolumeProjection": {
"additionalProperties": false,
"properties": {
"clusterTrustBundle": {
"$ref": "#/$defs/ClusterTrustBundleProjection"
},
"configMap": {
"$ref": "#/$defs/ConfigMapProjection"
},
"downwardAPI": {
"$ref": "#/$defs/DownwardAPIProjection"
},
"secret": {
"$ref": "#/$defs/SecretProjection"
},
"serviceAccountToken": {
"$ref": "#/$defs/ServiceAccountTokenProjection"
}
},
"type": "object"
},
"VolumeResourceRequirements": {
"additionalProperties": false,
"properties": {
"limits": {
"type": "object"
},
"requests": {
"type": "object"
}
},
"type": "object"
},
"VsphereVirtualDiskVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"storagePolicyID": {
"type": "string"
},
"storagePolicyName": {
"type": "string"
},
"volumePath": {
"type": "string"
}
},
"required": [
"volumePath"
],
"type": "object"
},
"WeightedPodAffinityTerm": {
"additionalProperties": false,
"properties": {
"podAffinityTerm": {
"$ref": "#/$defs/PodAffinityTerm"
},
"weight": {
"type": "integer"
}
},
"required": [
"weight",
"podAffinityTerm"
],
"type": "object"
},
"WindowsSecurityContextOptions": {
"additionalProperties": false,
"properties": {
"gmsaCredentialSpec": {
"type": "string"
},
"gmsaCredentialSpecName": {
"type": "string"
},
"hostProcess": {
"type": "boolean"
},
"runAsUserName": {
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://github.com/open-telemetry/opentelemetry-operator/apis/v1alpha1/open-telemetry-collector-spec",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"clusterName": {
"type": "string"
},
"clusterRole": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"collectors": {
"patternProperties": {
"^[a-z]+[a-zA-Z0-9]+$": {
"$ref": "#/$defs/OpenTelemetryCollectorSpec"
}
},
"type": "object"
},
"defaultCRConfig": {
"$ref": "#/$defs/OpenTelemetryCollectorSpec"
},
"extraEnvs": {
"items": {
"type": "object"
},
"type": "array"
},
"fullnameOverride": {
"type": "string"
},
"instrumentation": {
"$ref": "#/$defs/InstrumentationSpec"
},
"namespaceOverride": {
"type": "string"
},
"opAMPBridge": {
"$ref": "#/$defs/OpAMPBridgeSpec"
}
}
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 3b82d8f262721493a4762bf9aa2c8eb5142887e9 | 2024-04-19T17:29:27 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"caFile": "",
"certFile": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"create": true,
"failurePolicy": "Fail",
"keyFile": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"admissionWebhooks": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"caFile": "",
"certFile": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"create": true,
"failurePolicy": "Fail",
"keyFile": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"caFile": {
"default": "",
"examples": [
""
],
"title": "File path to self-managed CA bundle.",
"type": "string"
},
"certFile": {
"default": "",
"examples": [
""
],
"title": "File path to self-managed TLS certificate.",
"type": "string"
},
"certManager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"keyFile": {
"default": "",
"examples": [
""
],
"title": "File path to self-managed TLS key.",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"additionalProperties": false,
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"servicePort": {
"default": 443,
"examples": [
9443
],
"title": "The port for the webhook service",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"certFile",
"keyFile",
"caFile",
"serviceAnnotations",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Kubernetes cluster domain suffix",
"type": "string"
},
"clusterRole": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"enabled": {
"description": "Usually used when using Opentelemetry-operator as a subchart.",
"type": "boolean"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"global": {
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"createRbacPermissions": {
"default": false,
"examples": [
false
],
"title": "Whether the operator should create RBAC permissions for collector deployments",
"type": "boolean"
},
"deploymentAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The deploymentAnnotations Schema",
"type": "object"
},
"env": {
"additionalProperties": {
"type": "string"
},
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
"opentelemetry-operator"
],
"title": "The name of the service account",
"type": "string"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"additionalProperties": false,
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"deploymentAnnotations",
"serviceAnnotations",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"additionalProperties": false,
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"clusterDomain",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework",
"additionalLabels"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | abe4c7dc5a5f384d5f847a0aa7bfeb12dca9ef90 | 2024-04-10T20:44:38 | charts/opentelemetry-kube-stack/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$defs": {
"AWSElasticBlockStoreVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"partition": {
"type": "integer"
},
"readOnly": {
"type": "boolean"
},
"volumeID": {
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"Affinity": {
"additionalProperties": false,
"properties": {
"nodeAffinity": {
"$ref": "#/$defs/NodeAffinity"
},
"podAffinity": {
"$ref": "#/$defs/PodAffinity"
},
"podAntiAffinity": {
"$ref": "#/$defs/PodAntiAffinity"
}
},
"type": "object"
},
"ApacheHttpd": {
"additionalProperties": false,
"properties": {
"attrs": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"configPath": {
"type": "string"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"version": {
"type": "string"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"AutoscalerSpec": {
"additionalProperties": false,
"properties": {
"behavior": {
"$ref": "#/$defs/HorizontalPodAutoscalerBehavior"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"items": {
"$ref": "#/$defs/MetricSpec"
},
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilization": {
"type": "integer"
},
"targetMemoryUtilization": {
"type": "integer"
}
},
"type": "object"
},
"AzureDiskVolumeSource": {
"additionalProperties": false,
"properties": {
"cachingMode": {
"type": "string"
},
"diskName": {
"type": "string"
},
"diskURI": {
"type": "string"
},
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"diskName",
"diskURI"
],
"type": "object"
},
"AzureFileVolumeSource": {
"additionalProperties": false,
"properties": {
"readOnly": {
"type": "boolean"
},
"secretName": {
"type": "string"
},
"shareName": {
"type": "string"
}
},
"required": [
"secretName",
"shareName"
],
"type": "object"
},
"CSIVolumeSource": {
"additionalProperties": false,
"properties": {
"driver": {
"type": "string"
},
"fsType": {
"type": "string"
},
"nodePublishSecretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"readOnly": {
"type": "boolean"
},
"volumeAttributes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"driver"
],
"type": "object"
},
"Capabilities": {
"additionalProperties": false,
"properties": {
"add": {
"items": {
"type": "string"
},
"type": "array"
},
"drop": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"CephFSVolumeSource": {
"additionalProperties": false,
"properties": {
"monitors": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretFile": {
"type": "string"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"user": {
"type": "string"
}
},
"required": [
"monitors"
],
"type": "object"
},
"CinderVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"volumeID": {
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"ClusterTrustBundleProjection": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"$ref": "#/$defs/LabelSelector"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
},
"path": {
"type": "string"
},
"signerName": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"ConfigMapEnvSource": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"ConfigMapKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"ConfigMapProjection": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/$defs/KeyToPath"
},
"type": "array"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"ConfigMapVolumeSource": {
"additionalProperties": false,
"properties": {
"defaultMode": {
"type": "integer"
},
"items": {
"items": {
"$ref": "#/$defs/KeyToPath"
},
"type": "array"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"ConfigMapsSpec": {
"additionalProperties": false,
"properties": {
"mountPath": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"Container": {
"additionalProperties": false,
"properties": {
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"envFrom": {
"items": {
"$ref": "#/$defs/EnvFromSource"
},
"type": "array"
},
"image": {
"type": "string"
},
"imagePullPolicy": {
"type": "string"
},
"lifecycle": {
"$ref": "#/$defs/Lifecycle"
},
"livenessProbe": {
"$ref": "#/$defs/Probe"
},
"name": {
"type": "string"
},
"ports": {
"items": {
"$ref": "#/$defs/ContainerPort"
},
"type": "array"
},
"readinessProbe": {
"$ref": "#/$defs/Probe"
},
"resizePolicy": {
"items": {
"$ref": "#/$defs/ContainerResizePolicy"
},
"type": "array"
},
"resources": {
"$ref": "#/$defs/ResourceRequirements"
},
"restartPolicy": {
"type": "string"
},
"securityContext": {
"$ref": "#/$defs/SecurityContext"
},
"startupProbe": {
"$ref": "#/$defs/Probe"
},
"stdin": {
"type": "boolean"
},
"stdinOnce": {
"type": "boolean"
},
"terminationMessagePath": {
"type": "string"
},
"terminationMessagePolicy": {
"type": "string"
},
"tty": {
"type": "boolean"
},
"volumeDevices": {
"items": {
"$ref": "#/$defs/VolumeDevice"
},
"type": "array"
},
"volumeMounts": {
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ContainerPort": {
"additionalProperties": false,
"properties": {
"containerPort": {
"type": "integer"
},
"hostIP": {
"type": "string"
},
"hostPort": {
"type": "integer"
},
"name": {
"type": "string"
},
"protocol": {
"type": "string"
}
},
"required": [
"containerPort"
],
"type": "object"
},
"ContainerResizePolicy": {
"additionalProperties": false,
"properties": {
"resourceName": {
"type": "string"
},
"restartPolicy": {
"type": "string"
}
},
"required": [
"resourceName",
"restartPolicy"
],
"type": "object"
},
"DaemonSetUpdateStrategy": {
"additionalProperties": false,
"properties": {
"rollingUpdate": {
"$ref": "#/$defs/RollingUpdateDaemonSet"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"DeploymentStrategy": {
"additionalProperties": false,
"properties": {
"rollingUpdate": {
"$ref": "#/$defs/RollingUpdateDeployment"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"DotNet": {
"additionalProperties": false,
"properties": {
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"DownwardAPIProjection": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/$defs/DownwardAPIVolumeFile"
},
"type": "array"
}
},
"type": "object"
},
"DownwardAPIVolumeFile": {
"additionalProperties": false,
"properties": {
"fieldRef": {
"$ref": "#/$defs/ObjectFieldSelector"
},
"mode": {
"type": "integer"
},
"path": {
"type": "string"
},
"resourceFieldRef": {
"$ref": "#/$defs/ResourceFieldSelector"
}
},
"required": [
"path"
],
"type": "object"
},
"DownwardAPIVolumeSource": {
"additionalProperties": false,
"properties": {
"defaultMode": {
"type": "integer"
},
"items": {
"items": {
"$ref": "#/$defs/DownwardAPIVolumeFile"
},
"type": "array"
}
},
"type": "object"
},
"EmptyDirVolumeSource": {
"additionalProperties": false,
"properties": {
"medium": {
"type": "string"
},
"sizeLimit": {
"$ref": "#/$defs/Quantity"
}
},
"type": "object"
},
"EnvFromSource": {
"additionalProperties": false,
"properties": {
"configMapRef": {
"$ref": "#/$defs/ConfigMapEnvSource"
},
"prefix": {
"type": "string"
},
"secretRef": {
"$ref": "#/$defs/SecretEnvSource"
}
},
"type": "object"
},
"EnvVar": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueFrom": {
"$ref": "#/$defs/EnvVarSource"
}
},
"required": [
"name"
],
"type": "object"
},
"EnvVarSource": {
"additionalProperties": false,
"properties": {
"configMapKeyRef": {
"$ref": "#/$defs/ConfigMapKeySelector"
},
"fieldRef": {
"$ref": "#/$defs/ObjectFieldSelector"
},
"resourceFieldRef": {
"$ref": "#/$defs/ResourceFieldSelector"
},
"secretKeyRef": {
"$ref": "#/$defs/SecretKeySelector"
}
},
"type": "object"
},
"EphemeralVolumeSource": {
"additionalProperties": false,
"properties": {
"volumeClaimTemplate": {
"$ref": "#/$defs/PersistentVolumeClaimTemplate"
}
},
"type": "object"
},
"ExecAction": {
"additionalProperties": false,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Exporter": {
"additionalProperties": false,
"properties": {
"endpoint": {
"type": "string"
}
},
"type": "object"
},
"FCVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"lun": {
"type": "integer"
},
"readOnly": {
"type": "boolean"
},
"targetWWNs": {
"items": {
"type": "string"
},
"type": "array"
},
"wwids": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"FieldsV1": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"FlexVolumeSource": {
"additionalProperties": false,
"properties": {
"driver": {
"type": "string"
},
"fsType": {
"type": "string"
},
"options": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
}
},
"required": [
"driver"
],
"type": "object"
},
"FlockerVolumeSource": {
"additionalProperties": false,
"properties": {
"datasetName": {
"type": "string"
},
"datasetUUID": {
"type": "string"
}
},
"type": "object"
},
"GCEPersistentDiskVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"partition": {
"type": "integer"
},
"pdName": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"pdName"
],
"type": "object"
},
"GitRepoVolumeSource": {
"additionalProperties": false,
"properties": {
"directory": {
"type": "string"
},
"repository": {
"type": "string"
},
"revision": {
"type": "string"
}
},
"required": [
"repository"
],
"type": "object"
},
"GlusterfsVolumeSource": {
"additionalProperties": false,
"properties": {
"endpoints": {
"type": "string"
},
"path": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"endpoints",
"path"
],
"type": "object"
},
"Go": {
"additionalProperties": false,
"properties": {
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"HPAScalingPolicy": {
"additionalProperties": false,
"properties": {
"periodSeconds": {
"type": "integer"
},
"type": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"type",
"value",
"periodSeconds"
],
"type": "object"
},
"HPAScalingRules": {
"additionalProperties": false,
"properties": {
"policies": {
"items": {
"$ref": "#/$defs/HPAScalingPolicy"
},
"type": "array"
},
"selectPolicy": {
"type": "string"
},
"stabilizationWindowSeconds": {
"type": "integer"
}
},
"type": "object"
},
"HTTPGetAction": {
"additionalProperties": false,
"properties": {
"host": {
"type": "string"
},
"httpHeaders": {
"items": {
"$ref": "#/$defs/HTTPHeader"
},
"type": "array"
},
"path": {
"type": "string"
},
"port": {
"type": [
"string",
"integer"
]
},
"scheme": {
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"HTTPHeader": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"HorizontalPodAutoscalerBehavior": {
"additionalProperties": false,
"properties": {
"scaleDown": {
"$ref": "#/$defs/HPAScalingRules"
},
"scaleUp": {
"$ref": "#/$defs/HPAScalingRules"
}
},
"type": "object"
},
"HostPathVolumeSource": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"ISCSIVolumeSource": {
"additionalProperties": false,
"properties": {
"chapAuthDiscovery": {
"type": "boolean"
},
"chapAuthSession": {
"type": "boolean"
},
"fsType": {
"type": "string"
},
"initiatorName": {
"type": "string"
},
"iqn": {
"type": "string"
},
"iscsiInterface": {
"type": "string"
},
"lun": {
"type": "integer"
},
"portals": {
"items": {
"type": "string"
},
"type": "array"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"targetPortal": {
"type": "string"
}
},
"required": [
"targetPortal",
"iqn",
"lun"
],
"type": "object"
},
"Ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"route": {
"$ref": "#/$defs/OpenShiftRoute"
},
"ruleType": {
"type": "string"
},
"tls": {
"items": {
"$ref": "#/$defs/IngressTLS"
},
"type": "array"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"IngressTLS": {
"additionalProperties": false,
"properties": {
"hosts": {
"items": {
"type": "string"
},
"type": "array"
},
"secretName": {
"type": "string"
}
},
"type": "object"
},
"InstrumentationSpec": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"apacheHttpd": {
"$ref": "#/$defs/ApacheHttpd"
},
"dotnet": {
"$ref": "#/$defs/DotNet"
},
"enabled": {
"type": "boolean"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"exporter": {
"$ref": "#/$defs/Exporter"
},
"go": {
"$ref": "#/$defs/Go"
},
"java": {
"$ref": "#/$defs/Java"
},
"labels": {
"type": "object"
},
"name": {
"type": "string"
},
"nginx": {
"$ref": "#/$defs/Nginx"
},
"nodejs": {
"$ref": "#/$defs/NodeJS"
},
"propagators": {
"items": {
"type": "string"
},
"type": "array"
},
"python": {
"$ref": "#/$defs/Python"
},
"resource": {
"$ref": "#/$defs/Resource"
},
"sampler": {
"$ref": "#/$defs/Sampler"
}
},
"type": "object"
},
"IntOrString": {
"additionalProperties": false,
"properties": {
"IntVal": {
"type": "integer"
},
"StrVal": {
"type": "string"
},
"Type": {
"type": "integer"
}
},
"required": [
"Type",
"IntVal",
"StrVal"
],
"type": "object"
},
"Java": {
"additionalProperties": false,
"properties": {
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resources": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"KeyToPath": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"mode": {
"type": "integer"
},
"path": {
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"LabelSelector": {
"additionalProperties": false,
"properties": {
"matchExpressions": {
"items": {
"$ref": "#/$defs/LabelSelectorRequirement"
},
"type": "array"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"LabelSelectorRequirement": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"Lifecycle": {
"additionalProperties": false,
"properties": {
"postStart": {
"$ref": "#/$defs/LifecycleHandler"
},
"preStop": {
"$ref": "#/$defs/LifecycleHandler"
}
},
"type": "object"
},
"LifecycleHandler": {
"additionalProperties": false,
"properties": {
"exec": {
"$ref": "#/$defs/ExecAction"
},
"httpGet": {
"$ref": "#/$defs/HTTPGetAction"
},
"sleep": {
"$ref": "#/$defs/SleepAction"
},
"tcpSocket": {
"$ref": "#/$defs/TCPSocketAction"
}
},
"type": "object"
},
"LocalObjectReference": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
},
"type": "object"
},
"ManagedFieldsEntry": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"fieldsType": {
"type": "string"
},
"fieldsV1": {
"$ref": "#/$defs/FieldsV1"
},
"manager": {
"type": "string"
},
"operation": {
"type": "string"
},
"subresource": {
"type": "string"
},
"time": {
"$ref": "#/$defs/Time"
}
},
"type": "object"
},
"MetricIdentifier": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"selector": {
"$ref": "#/$defs/LabelSelector"
}
},
"required": [
"name"
],
"type": "object"
},
"MetricSpec": {
"additionalProperties": false,
"properties": {
"pods": {
"$ref": "#/$defs/PodsMetricSource"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"MetricTarget": {
"additionalProperties": false,
"properties": {
"averageUtilization": {
"type": "integer"
},
"averageValue": {
"$ref": "#/$defs/Quantity"
},
"type": {
"type": "string"
},
"value": {
"$ref": "#/$defs/Quantity"
}
},
"required": [
"type"
],
"type": "object"
},
"MetricsConfigSpec": {
"additionalProperties": false,
"properties": {
"DisablePrometheusAnnotations": {
"type": "boolean"
},
"enableMetrics": {
"type": "boolean"
}
},
"type": "object"
},
"ModifyVolumeStatus": {
"additionalProperties": false,
"properties": {
"status": {
"type": "string"
},
"targetVolumeAttributesClassName": {
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
},
"NFSVolumeSource": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"server": {
"type": "string"
}
},
"required": [
"server",
"path"
],
"type": "object"
},
"Nginx": {
"additionalProperties": false,
"properties": {
"attrs": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"configFile": {
"type": "string"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"NodeAffinity": {
"additionalProperties": false,
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/PreferredSchedulingTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"$ref": "#/$defs/NodeSelector"
}
},
"type": "object"
},
"NodeJS": {
"additionalProperties": false,
"properties": {
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"NodeSelector": {
"additionalProperties": false,
"properties": {
"nodeSelectorTerms": {
"items": {
"$ref": "#/$defs/NodeSelectorTerm"
},
"type": "array"
}
},
"required": [
"nodeSelectorTerms"
],
"type": "object"
},
"NodeSelectorRequirement": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"NodeSelectorTerm": {
"additionalProperties": false,
"properties": {
"matchExpressions": {
"items": {
"$ref": "#/$defs/NodeSelectorRequirement"
},
"type": "array"
},
"matchFields": {
"items": {
"$ref": "#/$defs/NodeSelectorRequirement"
},
"type": "array"
}
},
"type": "object"
},
"ObjectFieldSelector": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"fieldPath": {
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"creationTimestamp": {
"$ref": "#/$defs/Time"
},
"deletionGracePeriodSeconds": {
"type": "integer"
},
"deletionTimestamp": {
"$ref": "#/$defs/Time"
},
"finalizers": {
"items": {
"type": "string"
},
"type": "array"
},
"generateName": {
"type": "string"
},
"generation": {
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"managedFields": {
"items": {
"$ref": "#/$defs/ManagedFieldsEntry"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"ownerReferences": {
"items": {
"$ref": "#/$defs/OwnerReference"
},
"type": "array"
},
"resourceVersion": {
"type": "string"
},
"selfLink": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
},
"ObservabilitySpec": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/MetricsConfigSpec"
}
},
"type": "object"
},
"OpenShiftRoute": {
"additionalProperties": false,
"properties": {
"termination": {
"type": "string"
}
},
"type": "object"
},
"OpenTelemetryCollectorSpec": {
"additionalProperties": true,
"properties": {
"additionalContainers": {
"items": {
"$ref": "#/$defs/Container"
},
"type": "array"
},
"affinity": {
"$ref": "#/$defs/Affinity"
},
"annotations": {
"type": "object"
},
"args": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"autoscaler": {
"$ref": "#/$defs/AutoscalerSpec"
},
"clusterRoleBinding": {
"properties": {
"clusterRoleName": {
"type": "string"
},
"enabled": {
"default": "true",
"type": "boolean"
}
},
"type": "object"
},
"config": {
"type": "object"
},
"configmaps": {
"items": {
"$ref": "#/$defs/ConfigMapsSpec"
},
"type": "array"
},
"deploymentUpdateStrategy": {
"$ref": "#/$defs/DeploymentStrategy"
},
"enabled": {
"type": "boolean"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"envFrom": {
"items": {
"$ref": "#/$defs/EnvFromSource"
},
"type": "array"
},
"hostNetwork": {
"type": "boolean"
},
"image": {
"additionalProperties": false,
"description": "Image use in both standalone and agent configs",
"properties": {
"digest": {
"type": "string"
},
"pullPolicy": {
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"type": "string"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"ingress": {
"$ref": "#/$defs/Ingress"
},
"initContainers": {
"items": {
"$ref": "#/$defs/Container"
},
"type": "array"
},
"labels": {
"type": "object"
},
"lifecycle": {
"$ref": "#/$defs/Lifecycle"
},
"livenessProbe": {
"$ref": "#/$defs/Probe"
},
"managementState": {
"type": "string"
},
"maxReplicas": {
"type": "integer"
},
"minReplicas": {
"type": "integer"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"observability": {
"$ref": "#/$defs/ObservabilitySpec"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podDisruptionBudget": {
"$ref": "#/$defs/PodDisruptionBudgetSpec"
},
"podSecurityContext": {
"$ref": "#/$defs/PodSecurityContext"
},
"ports": {
"items": {
"$ref": "#/$defs/ServicePort"
},
"type": "array"
},
"priorityClassName": {
"type": "string"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/$defs/ResourceRequirements"
},
"scrape_configs_file": {
"default": "",
"type": "string"
},
"securityContext": {
"$ref": "#/$defs/SecurityContext"
},
"serviceAccount": {
"type": "string"
},
"shareProcessNamespace": {
"type": "boolean"
},
"targetAllocator": {
"$ref": "#/$defs/OpenTelemetryTargetAllocator"
},
"terminationGracePeriodSeconds": {
"type": "integer"
},
"tolerations": {
"items": {
"$ref": "#/$defs/Toleration"
},
"type": "array"
},
"topologySpreadConstraints": {
"items": {
"$ref": "#/$defs/TopologySpreadConstraint"
},
"type": "array"
},
"updateStrategy": {
"$ref": "#/$defs/DaemonSetUpdateStrategy"
},
"upgradeStrategy": {
"type": "string"
},
"volumeClaimTemplates": {
"items": {
"$ref": "#/$defs/PersistentVolumeClaim"
},
"type": "array"
},
"volumeMounts": {
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"volumes": {
"items": {
"$ref": "#/$defs/Volume"
},
"type": "array"
}
},
"type": "object"
},
"OpenTelemetryTargetAllocator": {
"additionalProperties": false,
"properties": {
"affinity": {
"$ref": "#/$defs/Affinity"
},
"allocationStrategy": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"filterStrategy": {
"type": "string"
},
"image": {
"additionalProperties": false,
"description": "Image use in both standalone and agent configs",
"properties": {
"digest": {
"type": "string"
},
"pullPolicy": {
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"type": "string"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"observability": {
"$ref": "#/$defs/ObservabilitySpec"
},
"podDisruptionBudget": {
"$ref": "#/$defs/PodDisruptionBudgetSpec"
},
"podSecurityContext": {
"$ref": "#/$defs/PodSecurityContext"
},
"prometheusCR": {
"$ref": "#/$defs/OpenTelemetryTargetAllocatorPrometheusCR"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/$defs/ResourceRequirements"
},
"securityContext": {
"$ref": "#/$defs/SecurityContext"
},
"serviceAccount": {
"type": "string"
},
"tolerations": {
"items": {
"$ref": "#/$defs/Toleration"
},
"type": "array"
},
"topologySpreadConstraints": {
"items": {
"$ref": "#/$defs/TopologySpreadConstraint"
},
"type": "array"
}
},
"type": "object"
},
"OpenTelemetryTargetAllocatorPrometheusCR": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"podMonitorSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"scrapeInterval": {
"type": "string"
},
"serviceMonitorSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"OwnerReference": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"blockOwnerDeletion": {
"type": "boolean"
},
"controller": {
"type": "boolean"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"type": "object"
},
"PersistentVolumeClaim": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta"
},
"spec": {
"$ref": "#/$defs/PersistentVolumeClaimSpec"
},
"status": {
"$ref": "#/$defs/PersistentVolumeClaimStatus"
}
},
"type": "object"
},
"PersistentVolumeClaimCondition": {
"additionalProperties": false,
"properties": {
"lastProbeTime": {
"$ref": "#/$defs/Time"
},
"lastTransitionTime": {
"$ref": "#/$defs/Time"
},
"message": {
"type": "string"
},
"reason": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"status"
],
"type": "object"
},
"PersistentVolumeClaimSpec": {
"additionalProperties": false,
"properties": {
"accessModes": {
"items": {
"type": "string"
},
"type": "array"
},
"dataSource": {
"$ref": "#/$defs/TypedLocalObjectReference"
},
"dataSourceRef": {
"$ref": "#/$defs/TypedObjectReference"
},
"resources": {
"$ref": "#/$defs/VolumeResourceRequirements"
},
"selector": {
"$ref": "#/$defs/LabelSelector"
},
"storageClassName": {
"type": "string"
},
"volumeAttributesClassName": {
"type": "string"
},
"volumeMode": {
"type": "string"
},
"volumeName": {
"type": "string"
}
},
"type": "object"
},
"PersistentVolumeClaimStatus": {
"additionalProperties": false,
"properties": {
"accessModes": {
"items": {
"type": "string"
},
"type": "array"
},
"allocatedResourceStatuses": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"allocatedResources": {
"$ref": "#/$defs/ResourceList"
},
"capacity": {
"$ref": "#/$defs/ResourceList"
},
"conditions": {
"items": {
"$ref": "#/$defs/PersistentVolumeClaimCondition"
},
"type": "array"
},
"currentVolumeAttributesClassName": {
"type": "string"
},
"modifyVolumeStatus": {
"$ref": "#/$defs/ModifyVolumeStatus"
},
"phase": {
"type": "string"
}
},
"type": "object"
},
"PersistentVolumeClaimTemplate": {
"additionalProperties": false,
"properties": {
"metadata": {
"$ref": "#/$defs/ObjectMeta"
},
"spec": {
"$ref": "#/$defs/PersistentVolumeClaimSpec"
}
},
"required": [
"spec"
],
"type": "object"
},
"PersistentVolumeClaimVolumeSource": {
"additionalProperties": false,
"properties": {
"claimName": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"claimName"
],
"type": "object"
},
"PhotonPersistentDiskVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"pdID": {
"type": "string"
}
},
"required": [
"pdID"
],
"type": "object"
},
"PodAffinity": {
"additionalProperties": false,
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"PodAffinityTerm": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"$ref": "#/$defs/LabelSelector"
},
"matchLabelKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"mismatchLabelKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"namespaceSelector": {
"$ref": "#/$defs/LabelSelector"
},
"namespaces": {
"items": {
"type": "string"
},
"type": "array"
},
"topologyKey": {
"type": "string"
}
},
"required": [
"topologyKey"
],
"type": "object"
},
"PodAntiAffinity": {
"additionalProperties": false,
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"PodDisruptionBudgetSpec": {
"additionalProperties": false,
"properties": {
"maxUnavailable": {
"type": [
"string",
"integer"
]
},
"minAvailable": {
"type": [
"string",
"integer"
]
}
},
"type": "object"
},
"PodSecurityContext": {
"additionalProperties": false,
"properties": {
"fsGroup": {
"type": "integer"
},
"fsGroupChangePolicy": {
"type": "string"
},
"runAsGroup": {
"type": "integer"
},
"runAsNonRoot": {
"type": "boolean"
},
"runAsUser": {
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/$defs/SELinuxOptions"
},
"seccompProfile": {
"$ref": "#/$defs/SeccompProfile"
},
"supplementalGroups": {
"items": {
"type": "integer"
},
"type": "array"
},
"sysctls": {
"items": {
"$ref": "#/$defs/Sysctl"
},
"type": "array"
},
"windowsOptions": {
"$ref": "#/$defs/WindowsSecurityContextOptions"
}
},
"type": "object"
},
"PodsMetricSource": {
"additionalProperties": false,
"properties": {
"metric": {
"$ref": "#/$defs/MetricIdentifier"
},
"target": {
"$ref": "#/$defs/MetricTarget"
}
},
"required": [
"metric",
"target"
],
"type": "object"
},
"PortworxVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"volumeID": {
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"PreferredSchedulingTerm": {
"additionalProperties": false,
"properties": {
"preference": {
"$ref": "#/$defs/NodeSelectorTerm"
},
"weight": {
"type": "integer"
}
},
"required": [
"weight",
"preference"
],
"type": "object"
},
"Probe": {
"additionalProperties": false,
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"terminationGracePeriodSeconds": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"ProjectedVolumeSource": {
"additionalProperties": false,
"properties": {
"defaultMode": {
"type": "integer"
},
"sources": {
"items": {
"$ref": "#/$defs/VolumeProjection"
},
"type": "array"
}
},
"required": [
"sources"
],
"type": "object"
},
"Python": {
"additionalProperties": false,
"properties": {
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"image": {
"type": "string"
},
"resourceRequirements": {
"$ref": "#/$defs/ResourceRequirements"
},
"volumeLimitSize": {
"type": "string"
}
},
"type": "object"
},
"Quantity": {
"additionalProperties": false,
"properties": {
"Format": {
"type": "string"
}
},
"required": [
"Format"
],
"type": "object"
},
"QuobyteVolumeSource": {
"additionalProperties": false,
"properties": {
"group": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"registry": {
"type": "string"
},
"tenant": {
"type": "string"
},
"user": {
"type": "string"
},
"volume": {
"type": "string"
}
},
"required": [
"registry",
"volume"
],
"type": "object"
},
"RBDVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"image": {
"type": "string"
},
"keyring": {
"type": "string"
},
"monitors": {
"items": {
"type": "string"
},
"type": "array"
},
"pool": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"user": {
"type": "string"
}
},
"required": [
"monitors",
"image"
],
"type": "object"
},
"Resource": {
"additionalProperties": false,
"properties": {
"addK8sUIDAttributes": {
"type": "boolean"
},
"resourceAttributes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"ResourceClaim": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ResourceFieldSelector": {
"additionalProperties": false,
"properties": {
"containerName": {
"type": "string"
},
"divisor": {
"$ref": "#/$defs/Quantity"
},
"resource": {
"type": "string"
}
},
"required": [
"resource"
],
"type": "object"
},
"ResourceList": {
"additionalProperties": {
"$ref": "#/$defs/Quantity"
},
"type": "object"
},
"ResourceRequirements": {
"additionalProperties": false,
"properties": {
"limits": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": [
"string",
"integer"
]
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": [
"string",
"integer"
]
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"RollingUpdateDaemonSet": {
"additionalProperties": false,
"properties": {
"maxSurge": {
"type": [
"string",
"integer"
]
},
"maxUnavailable": {
"type": [
"string",
"integer"
]
}
},
"type": "object"
},
"RollingUpdateDeployment": {
"additionalProperties": false,
"properties": {
"maxSurge": {
"type": [
"string",
"integer"
]
},
"maxUnavailable": {
"type": [
"string",
"integer"
]
}
},
"type": "object"
},
"SELinuxOptions": {
"additionalProperties": false,
"properties": {
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"type": {
"type": "string"
},
"user": {
"type": "string"
}
},
"type": "object"
},
"Sampler": {
"additionalProperties": false,
"properties": {
"argument": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"ScaleIOVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"gateway": {
"type": "string"
},
"protectionDomain": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"sslEnabled": {
"type": "boolean"
},
"storageMode": {
"type": "string"
},
"storagePool": {
"type": "string"
},
"system": {
"type": "string"
},
"volumeName": {
"type": "string"
}
},
"required": [
"gateway",
"system",
"secretRef"
],
"type": "object"
},
"SeccompProfile": {
"additionalProperties": false,
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"SecretEnvSource": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"SecretKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"SecretProjection": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/$defs/KeyToPath"
},
"type": "array"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"SecretVolumeSource": {
"additionalProperties": false,
"properties": {
"defaultMode": {
"type": "integer"
},
"items": {
"items": {
"$ref": "#/$defs/KeyToPath"
},
"type": "array"
},
"optional": {
"type": "boolean"
},
"secretName": {
"type": "string"
}
},
"type": "object"
},
"SecurityContext": {
"additionalProperties": false,
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"capabilities": {
"$ref": "#/$defs/Capabilities"
},
"privileged": {
"type": "boolean"
},
"procMount": {
"type": "string"
},
"readOnlyRootFilesystem": {
"type": "boolean"
},
"runAsGroup": {
"type": "integer"
},
"runAsNonRoot": {
"type": "boolean"
},
"runAsUser": {
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/$defs/SELinuxOptions"
},
"seccompProfile": {
"$ref": "#/$defs/SeccompProfile"
},
"windowsOptions": {
"$ref": "#/$defs/WindowsSecurityContextOptions"
}
},
"type": "object"
},
"ServiceAccountTokenProjection": {
"additionalProperties": false,
"properties": {
"audience": {
"type": "string"
},
"expirationSeconds": {
"type": "integer"
},
"path": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"ServicePort": {
"additionalProperties": false,
"properties": {
"appProtocol": {
"type": "string"
},
"name": {
"type": "string"
},
"nodePort": {
"type": "integer"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": [
"string",
"integer"
]
}
},
"required": [
"port"
],
"type": "object"
},
"SleepAction": {
"additionalProperties": false,
"properties": {
"seconds": {
"type": "integer"
}
},
"required": [
"seconds"
],
"type": "object"
},
"StorageOSVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"volumeName": {
"type": "string"
},
"volumeNamespace": {
"type": "string"
}
},
"type": "object"
},
"Sysctl": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"TCPSocketAction": {
"additionalProperties": false,
"properties": {
"host": {
"type": "string"
},
"port": {
"type": [
"string",
"integer"
]
}
},
"required": [
"port"
],
"type": "object"
},
"Time": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"Toleration": {
"additionalProperties": false,
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"tolerationSeconds": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"TopologySpreadConstraint": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"$ref": "#/$defs/LabelSelector"
},
"matchLabelKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"maxSkew": {
"type": "integer"
},
"minDomains": {
"type": "integer"
},
"nodeAffinityPolicy": {
"type": "string"
},
"nodeTaintsPolicy": {
"type": "string"
},
"topologyKey": {
"type": "string"
},
"whenUnsatisfiable": {
"type": "string"
}
},
"required": [
"maxSkew",
"topologyKey",
"whenUnsatisfiable"
],
"type": "object"
},
"TypedLocalObjectReference": {
"additionalProperties": false,
"properties": {
"apiGroup": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiGroup",
"kind",
"name"
],
"type": "object"
},
"TypedObjectReference": {
"additionalProperties": false,
"properties": {
"apiGroup": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
}
},
"required": [
"apiGroup",
"kind",
"name"
],
"type": "object"
},
"Volume": {
"additionalProperties": false,
"properties": {
"awsElasticBlockStore": {
"$ref": "#/$defs/AWSElasticBlockStoreVolumeSource"
},
"azureDisk": {
"$ref": "#/$defs/AzureDiskVolumeSource"
},
"azureFile": {
"$ref": "#/$defs/AzureFileVolumeSource"
},
"cephfs": {
"$ref": "#/$defs/CephFSVolumeSource"
},
"cinder": {
"$ref": "#/$defs/CinderVolumeSource"
},
"configMap": {
"$ref": "#/$defs/ConfigMapVolumeSource"
},
"csi": {
"$ref": "#/$defs/CSIVolumeSource"
},
"downwardAPI": {
"$ref": "#/$defs/DownwardAPIVolumeSource"
},
"emptyDir": {
"$ref": "#/$defs/EmptyDirVolumeSource"
},
"ephemeral": {
"$ref": "#/$defs/EphemeralVolumeSource"
},
"fc": {
"$ref": "#/$defs/FCVolumeSource"
},
"flexVolume": {
"$ref": "#/$defs/FlexVolumeSource"
},
"flocker": {
"$ref": "#/$defs/FlockerVolumeSource"
},
"gcePersistentDisk": {
"$ref": "#/$defs/GCEPersistentDiskVolumeSource"
},
"gitRepo": {
"$ref": "#/$defs/GitRepoVolumeSource"
},
"glusterfs": {
"$ref": "#/$defs/GlusterfsVolumeSource"
},
"hostPath": {
"$ref": "#/$defs/HostPathVolumeSource"
},
"iscsi": {
"$ref": "#/$defs/ISCSIVolumeSource"
},
"name": {
"type": "string"
},
"nfs": {
"$ref": "#/$defs/NFSVolumeSource"
},
"persistentVolumeClaim": {
"$ref": "#/$defs/PersistentVolumeClaimVolumeSource"
},
"photonPersistentDisk": {
"$ref": "#/$defs/PhotonPersistentDiskVolumeSource"
},
"portworxVolume": {
"$ref": "#/$defs/PortworxVolumeSource"
},
"projected": {
"$ref": "#/$defs/ProjectedVolumeSource"
},
"quobyte": {
"$ref": "#/$defs/QuobyteVolumeSource"
},
"rbd": {
"$ref": "#/$defs/RBDVolumeSource"
},
"scaleIO": {
"$ref": "#/$defs/ScaleIOVolumeSource"
},
"secret": {
"$ref": "#/$defs/SecretVolumeSource"
},
"storageos": {
"$ref": "#/$defs/StorageOSVolumeSource"
},
"vsphereVolume": {
"$ref": "#/$defs/VsphereVirtualDiskVolumeSource"
}
},
"required": [
"name"
],
"type": "object"
},
"VolumeDevice": {
"additionalProperties": false,
"properties": {
"devicePath": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"devicePath"
],
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"properties": {
"mountPath": {
"type": "string"
},
"mountPropagation": {
"type": "string"
},
"name": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"subPath": {
"type": "string"
},
"subPathExpr": {
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"VolumeProjection": {
"additionalProperties": false,
"properties": {
"clusterTrustBundle": {
"$ref": "#/$defs/ClusterTrustBundleProjection"
},
"configMap": {
"$ref": "#/$defs/ConfigMapProjection"
},
"downwardAPI": {
"$ref": "#/$defs/DownwardAPIProjection"
},
"secret": {
"$ref": "#/$defs/SecretProjection"
},
"serviceAccountToken": {
"$ref": "#/$defs/ServiceAccountTokenProjection"
}
},
"type": "object"
},
"VolumeResourceRequirements": {
"additionalProperties": false,
"properties": {
"limits": {
"type": "object"
},
"requests": {
"type": "object"
}
},
"type": "object"
},
"VsphereVirtualDiskVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"storagePolicyID": {
"type": "string"
},
"storagePolicyName": {
"type": "string"
},
"volumePath": {
"type": "string"
}
},
"required": [
"volumePath"
],
"type": "object"
},
"WeightedPodAffinityTerm": {
"additionalProperties": false,
"properties": {
"podAffinityTerm": {
"$ref": "#/$defs/PodAffinityTerm"
},
"weight": {
"type": "integer"
}
},
"required": [
"weight",
"podAffinityTerm"
],
"type": "object"
},
"WindowsSecurityContextOptions": {
"additionalProperties": false,
"properties": {
"gmsaCredentialSpec": {
"type": "string"
},
"gmsaCredentialSpecName": {
"type": "string"
},
"hostProcess": {
"type": "boolean"
},
"runAsUserName": {
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://github.com/open-telemetry/opentelemetry-operator/apis/v1alpha1/open-telemetry-collector-spec",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"clusterName": {
"type": "string"
},
"clusterRole": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"collectors": {
"patternProperties": {
"^[a-z]+[a-zA-Z0-9]+$": {
"$ref": "#/$defs/OpenTelemetryCollectorSpec"
}
},
"type": "object"
},
"defaultCRConfig": {
"$ref": "#/$defs/OpenTelemetryCollectorSpec"
},
"extraEnvs": {
"items": {
"type": "object"
},
"type": "array"
},
"fullnameOverride": {
"type": "string"
},
"instrumentation": {
"$ref": "#/$defs/InstrumentationSpec"
},
"namespaceOverride": {
"type": "string"
}
}
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 842212dffec9da5e5692934b83da8d8d72e91d6b | 2024-02-06T18:47:19 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"servicePort": {
"default": 443,
"examples": [
9443
],
"title": "The port for the webhook service",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"cert_file",
"key_file",
"ca_file",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 7c633605a7f81919a9ce0171ff43cc411608b127 | 2023-05-04T15:02:39 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": true,
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretAnnotations": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.75.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.75.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"default": {},
"examples": [
{
"autoGenerateCert": true,
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretAnnotations": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"default": true,
"examples": [
true
],
"title": "The autoGenerateCert schema",
"type": "boolean"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"secretAnnotations",
"cert_file",
"key_file",
"ca_file"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.14.1"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.75.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.75.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"java": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.75.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.75.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.75.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.75.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 2,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 0b52cf3d0ba9e90e6b47e84c5352f39e9dfe5104 | 2024-03-25T14:41:30 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"admissionWebhooks": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"additionalProperties": false,
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"servicePort": {
"default": 443,
"examples": [
9443
],
"title": "The port for the webhook service",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"cert_file",
"key_file",
"ca_file",
"serviceAnnotations",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Kubernetes cluster domain suffix",
"type": "string"
},
"clusterRole": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"enabled": {
"description": "Usually used when using Opentelemetry-operator as a subchart.",
"type": "boolean"
},
"global": {
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"deploymentAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The deploymentAnnotations Schema",
"type": "object"
},
"env": {
"additionalProperties": false,
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"additionalProperties": false,
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"deploymentAnnotations",
"serviceAnnotations",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"additionalProperties": false,
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"clusterDomain",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework",
"additionalLabels"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | c778c2fa66b88f22a4b534a41903eee39d2d4520 | 2024-04-16T20:40:57 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"caFile": "",
"certFile": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"create": true,
"failurePolicy": "Fail",
"keyFile": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"admissionWebhooks": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"caFile": "",
"certFile": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"create": true,
"failurePolicy": "Fail",
"keyFile": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"caFile": {
"default": "",
"examples": [
""
],
"title": "File path to self-managed CA bundle.",
"type": "string"
},
"certFile": {
"default": "",
"examples": [
""
],
"title": "File path to self-managed TLS certificate.",
"type": "string"
},
"certManager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"keyFile": {
"default": "",
"examples": [
""
],
"title": "File path to self-managed TLS key.",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"additionalProperties": false,
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"servicePort": {
"default": 443,
"examples": [
9443
],
"title": "The port for the webhook service",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"certFile",
"keyFile",
"caFile",
"serviceAnnotations",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Kubernetes cluster domain suffix",
"type": "string"
},
"clusterRole": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"enabled": {
"description": "Usually used when using Opentelemetry-operator as a subchart.",
"type": "boolean"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"global": {
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"createRbacPermissions": {
"default": false,
"examples": [
false
],
"title": "Whether the operator should create RBAC permissions for collector deployments",
"type": "boolean"
},
"deploymentAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The deploymentAnnotations Schema",
"type": "object"
},
"env": {
"additionalProperties": {
"type": "string"
},
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"additionalProperties": false,
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"deploymentAnnotations",
"serviceAnnotations",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"additionalProperties": false,
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"clusterDomain",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework",
"additionalLabels"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 6b932a8a66331064947138df44d770ea66e45ef8 | 2023-11-03T13:05:08 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": true,
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretAnnotations": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.83.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"default": {},
"examples": [
{
"autoGenerateCert": true,
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretAnnotations": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"default": true,
"examples": [
true
],
"title": "The autoGenerateCert schema",
"type": "boolean"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"default": {},
"properties": {
"failurePolicy": {
"default": "Ignore",
"examples": [
"Ignore",
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"secretAnnotations",
"cert_file",
"key_file",
"ca_file"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.14.1"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.83.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The Go Schema",
"type": "object"
},
"java": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.77.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "operator.autoinstrumentation.go",
"examples": [
"-operator.autoinstrumentation.go,-operator.autoinstrumentation.go"
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.83.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.83.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 2,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 89e420f6ff255ac6fab30b35b7981555e9aeb0af | 2024-05-09T21:41:24 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"caFile": "",
"certFile": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"create": true,
"failurePolicy": "Fail",
"keyFile": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"admissionWebhooks": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"caFile": "",
"certFile": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"create": true,
"failurePolicy": "Fail",
"keyFile": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"caFile": {
"default": "",
"examples": [
""
],
"title": "File path to self-managed CA bundle.",
"type": "string"
},
"certFile": {
"default": "",
"examples": [
""
],
"title": "File path to self-managed TLS certificate.",
"type": "string"
},
"certManager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"keyFile": {
"default": "",
"examples": [
""
],
"title": "File path to self-managed TLS key.",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"additionalProperties": false,
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"servicePort": {
"default": 443,
"examples": [
9443
],
"title": "The port for the webhook service",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"certFile",
"keyFile",
"caFile",
"serviceAnnotations",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Kubernetes cluster domain suffix",
"type": "string"
},
"clusterRole": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"crds": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": true,
"examples": [
true
],
"title": "Create CRDs",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The CRDs Schema",
"type": "object"
},
"enabled": {
"description": "Usually used when using Opentelemetry-operator as a subchart.",
"type": "boolean"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"global": {
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"createRbacPermissions": {
"default": false,
"examples": [
false
],
"title": "Whether the operator should create RBAC permissions for collector deployments",
"type": "boolean"
},
"deploymentAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The deploymentAnnotations Schema",
"type": "object"
},
"env": {
"additionalProperties": {
"type": "string"
},
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
"opentelemetry-operator"
],
"title": "The name of the service account",
"type": "string"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"additionalProperties": false,
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"deploymentAnnotations",
"serviceAnnotations",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"additionalProperties": false,
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"clusterDomain",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"crds",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework",
"additionalLabels"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | fd654ad53aa122bc3ab924a67182085e144b7ecd | 2024-03-27T16:20:49 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"admissionWebhooks": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"additionalProperties": false,
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"servicePort": {
"default": 443,
"examples": [
9443
],
"title": "The port for the webhook service",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"cert_file",
"key_file",
"ca_file",
"serviceAnnotations",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Kubernetes cluster domain suffix",
"type": "string"
},
"clusterRole": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"enabled": {
"description": "Usually used when using Opentelemetry-operator as a subchart.",
"type": "boolean"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"global": {
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"deploymentAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The deploymentAnnotations Schema",
"type": "object"
},
"env": {
"additionalProperties": {
"type": "string"
},
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"additionalProperties": false,
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"deploymentAnnotations",
"serviceAnnotations",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"additionalProperties": false,
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"clusterDomain",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework",
"additionalLabels"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 5712c1281923abbe313b2b49bc0015d64d420cac | 2024-03-20T22:58:04 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"additionalProperties": false,
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"servicePort": {
"default": 443,
"examples": [
9443
],
"title": "The port for the webhook service",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"cert_file",
"key_file",
"ca_file",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"additionalProperties": false,
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"additionalProperties": false,
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"additionalProperties": false,
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 7d3e3e4587f42ff36aea4836e15417cfa88b3fad | 2024-03-25T15:20:39 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"admissionWebhooks": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"additionalProperties": false,
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"servicePort": {
"default": 443,
"examples": [
9443
],
"title": "The port for the webhook service",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"cert_file",
"key_file",
"ca_file",
"serviceAnnotations",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Kubernetes cluster domain suffix",
"type": "string"
},
"clusterRole": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"enabled": {
"description": "Usually used when using Opentelemetry-operator as a subchart.",
"type": "boolean"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"global": {
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"deploymentAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The deploymentAnnotations Schema",
"type": "object"
},
"env": {
"additionalProperties": false,
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"additionalProperties": false,
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"deploymentAnnotations",
"serviceAnnotations",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"additionalProperties": false,
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"clusterDomain",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework",
"additionalLabels"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 3d6af4297ebba1a855f45cba23a1bd7fd68a416b | 2024-04-05T20:06:00 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"admissionWebhooks": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"additionalProperties": false,
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"servicePort": {
"default": 443,
"examples": [
9443
],
"title": "The port for the webhook service",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"cert_file",
"key_file",
"ca_file",
"serviceAnnotations",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Kubernetes cluster domain suffix",
"type": "string"
},
"clusterRole": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"enabled": {
"description": "Usually used when using Opentelemetry-operator as a subchart.",
"type": "boolean"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"global": {
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"createRbacPermissions": {
"default": false,
"examples": [
false
],
"title": "Whether the operator should create RBAC permissions for collector deployments",
"type": "boolean"
},
"deploymentAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The deploymentAnnotations Schema",
"type": "object"
},
"env": {
"additionalProperties": {
"type": "string"
},
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"additionalProperties": false,
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"deploymentAnnotations",
"serviceAnnotations",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"additionalProperties": false,
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"clusterDomain",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework",
"additionalLabels"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 75f4606c5ac0fa76cf2a856d2c83c4f1edae732d | 2024-01-18T17:50:26 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.92.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.92.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"servicePort": {
"default": 443,
"examples": [
9443
],
"title": "The port for the webhook service",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"cert_file",
"key_file",
"ca_file",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.92.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.92.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.92.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.92.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.92.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.92.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 764920aac4d1fe1147ba187dd86631e021c2e297 | 2023-12-15T16:23:55 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.89.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.89.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"servicePort": {
"default": 443,
"examples": [
9443
],
"title": "The port for the webhook service",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"cert_file",
"key_file",
"ca_file",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.89.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.89.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.89.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.89.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.89.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.89.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 2bd5575b217432126fffd4c8a76b3a258b31399b | 2023-04-08T06:15:27 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"admissionWebhooks": {
"certManager": {
"enabled": true,
"issuerRef": {}
},
"create": true,
"failurePolicy": "Fail",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.75.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.74.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"default": {},
"examples": [
{
"certManager": {
"enabled": true,
"issuerRef": {}
},
"create": true,
"failurePolicy": "Fail",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"certManager": {
"default": {},
"examples": [
{
"enabled": true,
"issuerRef": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef"
],
"title": "The certManager Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.14.1"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.75.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.74.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"java": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.75.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.75.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.74.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.74.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"updateMode": "Auto"
}
],
"properties": {
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 49f0427733defd2336ec7f69b92de61eb995b45e | 2024-03-22T17:08:39 | charts/opentelemetry-kube-stack/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [],
"properties": {},
"required": [],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 456375de1ea1011c47d9f0e22f07bc6bbabe2359 | 2023-11-16T21:43:14 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": true,
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretAnnotations": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.83.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"default": {},
"examples": [
{
"autoGenerateCert": true,
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretAnnotations": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": true,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"default": {},
"properties": {
"failurePolicy": {
"default": "Ignore",
"examples": [
"Ignore",
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"secretAnnotations",
"cert_file",
"key_file",
"ca_file"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.14.1"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.83.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The Go Schema",
"type": "object"
},
"java": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.77.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "operator.autoinstrumentation.go",
"examples": [
"-operator.autoinstrumentation.go,-operator.autoinstrumentation.go"
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.83.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.83.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 2,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 7c8987a778d7eadc26b138eb69fd52a7291e855e | 2024-03-28T14:06:46 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"admissionWebhooks": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"additionalProperties": false,
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"servicePort": {
"default": 443,
"examples": [
9443
],
"title": "The port for the webhook service",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"cert_file",
"key_file",
"ca_file",
"serviceAnnotations",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Kubernetes cluster domain suffix",
"type": "string"
},
"clusterRole": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"enabled": {
"description": "Usually used when using Opentelemetry-operator as a subchart.",
"type": "boolean"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"global": {
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"deploymentAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The deploymentAnnotations Schema",
"type": "object"
},
"env": {
"additionalProperties": {
"type": "string"
},
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"additionalProperties": false,
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"deploymentAnnotations",
"serviceAnnotations",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"additionalProperties": false,
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"clusterDomain",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework",
"additionalLabels"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 80875158707dab4fb36b3ad736b4f2a5bea5a42c | 2023-06-29T14:48:45 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": true,
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretAnnotations": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.80.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"default": {},
"examples": [
{
"autoGenerateCert": true,
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretAnnotations": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"default": true,
"examples": [
true
],
"title": "The autoGenerateCert schema",
"type": "boolean"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"default": {},
"properties": {
"failurePolicy": {
"default": "Ignore",
"examples": [
"Ignore",
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"secretAnnotations",
"cert_file",
"key_file",
"ca_file"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.14.1"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.80.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The Go Schema",
"type": "object"
},
"java": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.77.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "operator.autoinstrumentation.go",
"examples": [
"-operator.autoinstrumentation.go,-operator.autoinstrumentation.go"
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.80.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.80.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 2,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | a3398565edf339afd7de9c869e2ba094f2335664 | 2023-07-12T18:56:02 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": true,
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretAnnotations": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.81.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"default": {},
"examples": [
{
"autoGenerateCert": true,
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretAnnotations": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"default": true,
"examples": [
true
],
"title": "The autoGenerateCert schema",
"type": "boolean"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"default": {},
"properties": {
"failurePolicy": {
"default": "Ignore",
"examples": [
"Ignore",
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"secretAnnotations",
"cert_file",
"key_file",
"ca_file"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.14.1"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.81.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The Go Schema",
"type": "object"
},
"java": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.77.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "operator.autoinstrumentation.go",
"examples": [
"-operator.autoinstrumentation.go,-operator.autoinstrumentation.go"
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.81.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.81.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 2,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 19657516dbde9840d48a1dd5ec77a2c080cd307d | 2023-04-11T20:40:30 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"admissionWebhooks": {
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"create": true,
"failurePolicy": "Fail",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.75.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.74.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"default": {},
"examples": [
{
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"create": true,
"failurePolicy": "Fail",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"certManager": {
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.14.1"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.75.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.74.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"java": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.75.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.75.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.74.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.74.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"updateMode": "Auto"
}
],
"properties": {
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | fb571378376b9917999853523816ef12ba9ce4ff | 2024-03-22T02:51:13 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"additionalProperties": false,
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"servicePort": {
"default": 443,
"examples": [
9443
],
"title": "The port for the webhook service",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"cert_file",
"key_file",
"ca_file",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"enabled": {
"description": "Usually used when using Opentelemetry-operator as a subchart.",
"type": "boolean"
},
"global": {
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"additionalProperties": false,
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"additionalProperties": false,
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"additionalProperties": false,
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"additionalProperties": false,
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 7252934f33a67697fd04558da3ce750fc70f25eb | 2023-04-24T14:52:54 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"admissionWebhooks": {
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"create": true,
"failurePolicy": "Fail",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.75.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.75.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"default": {},
"examples": [
{
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"create": true,
"failurePolicy": "Fail",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"certManager": {
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.14.1"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.75.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.75.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"java": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.75.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.75.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.75.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.75.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 2,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | c175a2612207255945df5136ac69c144a6609395 | 2024-04-03T19:49:29 | charts/opentelemetry-kube-stack/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$defs": {
"AWSElasticBlockStoreVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"partition": {
"type": "integer"
},
"readOnly": {
"type": "boolean"
},
"volumeID": {
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"Affinity": {
"additionalProperties": false,
"properties": {
"nodeAffinity": {
"$ref": "#/$defs/NodeAffinity"
},
"podAffinity": {
"$ref": "#/$defs/PodAffinity"
},
"podAntiAffinity": {
"$ref": "#/$defs/PodAntiAffinity"
}
},
"type": "object"
},
"AutoscalerSpec": {
"additionalProperties": false,
"properties": {
"behavior": {
"$ref": "#/$defs/HorizontalPodAutoscalerBehavior"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"items": {
"$ref": "#/$defs/MetricSpec"
},
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilization": {
"type": "integer"
},
"targetMemoryUtilization": {
"type": "integer"
}
},
"type": "object"
},
"AzureDiskVolumeSource": {
"additionalProperties": false,
"properties": {
"cachingMode": {
"type": "string"
},
"diskName": {
"type": "string"
},
"diskURI": {
"type": "string"
},
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"diskName",
"diskURI"
],
"type": "object"
},
"AzureFileVolumeSource": {
"additionalProperties": false,
"properties": {
"readOnly": {
"type": "boolean"
},
"secretName": {
"type": "string"
},
"shareName": {
"type": "string"
}
},
"required": [
"secretName",
"shareName"
],
"type": "object"
},
"CSIVolumeSource": {
"additionalProperties": false,
"properties": {
"driver": {
"type": "string"
},
"fsType": {
"type": "string"
},
"nodePublishSecretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"readOnly": {
"type": "boolean"
},
"volumeAttributes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"driver"
],
"type": "object"
},
"Capabilities": {
"additionalProperties": false,
"properties": {
"add": {
"items": {
"type": "string"
},
"type": "array"
},
"drop": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"CephFSVolumeSource": {
"additionalProperties": false,
"properties": {
"monitors": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretFile": {
"type": "string"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"user": {
"type": "string"
}
},
"required": [
"monitors"
],
"type": "object"
},
"CinderVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"volumeID": {
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"ClusterTrustBundleProjection": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"$ref": "#/$defs/LabelSelector"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
},
"path": {
"type": "string"
},
"signerName": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"ConfigMapEnvSource": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"ConfigMapKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"ConfigMapProjection": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/$defs/KeyToPath"
},
"type": "array"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"ConfigMapVolumeSource": {
"additionalProperties": false,
"properties": {
"defaultMode": {
"type": "integer"
},
"items": {
"items": {
"$ref": "#/$defs/KeyToPath"
},
"type": "array"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"ConfigMapsSpec": {
"additionalProperties": false,
"properties": {
"mountPath": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"Container": {
"additionalProperties": false,
"properties": {
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"envFrom": {
"items": {
"$ref": "#/$defs/EnvFromSource"
},
"type": "array"
},
"image": {
"type": "string"
},
"imagePullPolicy": {
"type": "string"
},
"lifecycle": {
"$ref": "#/$defs/Lifecycle"
},
"livenessProbe": {
"$ref": "#/$defs/Probe"
},
"name": {
"type": "string"
},
"ports": {
"items": {
"$ref": "#/$defs/ContainerPort"
},
"type": "array"
},
"readinessProbe": {
"$ref": "#/$defs/Probe"
},
"resizePolicy": {
"items": {
"$ref": "#/$defs/ContainerResizePolicy"
},
"type": "array"
},
"resources": {
"$ref": "#/$defs/ResourceRequirements"
},
"restartPolicy": {
"type": "string"
},
"securityContext": {
"$ref": "#/$defs/SecurityContext"
},
"startupProbe": {
"$ref": "#/$defs/Probe"
},
"stdin": {
"type": "boolean"
},
"stdinOnce": {
"type": "boolean"
},
"terminationMessagePath": {
"type": "string"
},
"terminationMessagePolicy": {
"type": "string"
},
"tty": {
"type": "boolean"
},
"volumeDevices": {
"items": {
"$ref": "#/$defs/VolumeDevice"
},
"type": "array"
},
"volumeMounts": {
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ContainerPort": {
"additionalProperties": false,
"properties": {
"containerPort": {
"type": "integer"
},
"hostIP": {
"type": "string"
},
"hostPort": {
"type": "integer"
},
"name": {
"type": "string"
},
"protocol": {
"type": "string"
}
},
"required": [
"containerPort"
],
"type": "object"
},
"ContainerResizePolicy": {
"additionalProperties": false,
"properties": {
"resourceName": {
"type": "string"
},
"restartPolicy": {
"type": "string"
}
},
"required": [
"resourceName",
"restartPolicy"
],
"type": "object"
},
"DaemonSetUpdateStrategy": {
"additionalProperties": false,
"properties": {
"rollingUpdate": {
"$ref": "#/$defs/RollingUpdateDaemonSet"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"DeploymentStrategy": {
"additionalProperties": false,
"properties": {
"rollingUpdate": {
"$ref": "#/$defs/RollingUpdateDeployment"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"DownwardAPIProjection": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/$defs/DownwardAPIVolumeFile"
},
"type": "array"
}
},
"type": "object"
},
"DownwardAPIVolumeFile": {
"additionalProperties": false,
"properties": {
"fieldRef": {
"$ref": "#/$defs/ObjectFieldSelector"
},
"mode": {
"type": "integer"
},
"path": {
"type": "string"
},
"resourceFieldRef": {
"$ref": "#/$defs/ResourceFieldSelector"
}
},
"required": [
"path"
],
"type": "object"
},
"DownwardAPIVolumeSource": {
"additionalProperties": false,
"properties": {
"defaultMode": {
"type": "integer"
},
"items": {
"items": {
"$ref": "#/$defs/DownwardAPIVolumeFile"
},
"type": "array"
}
},
"type": "object"
},
"EmptyDirVolumeSource": {
"additionalProperties": false,
"properties": {
"medium": {
"type": "string"
},
"sizeLimit": {
"$ref": "#/$defs/Quantity"
}
},
"type": "object"
},
"EnvFromSource": {
"additionalProperties": false,
"properties": {
"configMapRef": {
"$ref": "#/$defs/ConfigMapEnvSource"
},
"prefix": {
"type": "string"
},
"secretRef": {
"$ref": "#/$defs/SecretEnvSource"
}
},
"type": "object"
},
"EnvVar": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueFrom": {
"$ref": "#/$defs/EnvVarSource"
}
},
"required": [
"name"
],
"type": "object"
},
"EnvVarSource": {
"additionalProperties": false,
"properties": {
"configMapKeyRef": {
"$ref": "#/$defs/ConfigMapKeySelector"
},
"fieldRef": {
"$ref": "#/$defs/ObjectFieldSelector"
},
"resourceFieldRef": {
"$ref": "#/$defs/ResourceFieldSelector"
},
"secretKeyRef": {
"$ref": "#/$defs/SecretKeySelector"
}
},
"type": "object"
},
"EphemeralVolumeSource": {
"additionalProperties": false,
"properties": {
"volumeClaimTemplate": {
"$ref": "#/$defs/PersistentVolumeClaimTemplate"
}
},
"type": "object"
},
"ExecAction": {
"additionalProperties": false,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"FCVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"lun": {
"type": "integer"
},
"readOnly": {
"type": "boolean"
},
"targetWWNs": {
"items": {
"type": "string"
},
"type": "array"
},
"wwids": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"FieldsV1": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"FlexVolumeSource": {
"additionalProperties": false,
"properties": {
"driver": {
"type": "string"
},
"fsType": {
"type": "string"
},
"options": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
}
},
"required": [
"driver"
],
"type": "object"
},
"FlockerVolumeSource": {
"additionalProperties": false,
"properties": {
"datasetName": {
"type": "string"
},
"datasetUUID": {
"type": "string"
}
},
"type": "object"
},
"GCEPersistentDiskVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"partition": {
"type": "integer"
},
"pdName": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"pdName"
],
"type": "object"
},
"GitRepoVolumeSource": {
"additionalProperties": false,
"properties": {
"directory": {
"type": "string"
},
"repository": {
"type": "string"
},
"revision": {
"type": "string"
}
},
"required": [
"repository"
],
"type": "object"
},
"GlusterfsVolumeSource": {
"additionalProperties": false,
"properties": {
"endpoints": {
"type": "string"
},
"path": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"endpoints",
"path"
],
"type": "object"
},
"HPAScalingPolicy": {
"additionalProperties": false,
"properties": {
"periodSeconds": {
"type": "integer"
},
"type": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"type",
"value",
"periodSeconds"
],
"type": "object"
},
"HPAScalingRules": {
"additionalProperties": false,
"properties": {
"policies": {
"items": {
"$ref": "#/$defs/HPAScalingPolicy"
},
"type": "array"
},
"selectPolicy": {
"type": "string"
},
"stabilizationWindowSeconds": {
"type": "integer"
}
},
"type": "object"
},
"HTTPGetAction": {
"additionalProperties": false,
"properties": {
"host": {
"type": "string"
},
"httpHeaders": {
"items": {
"$ref": "#/$defs/HTTPHeader"
},
"type": "array"
},
"path": {
"type": "string"
},
"port": {
"type": [
"string",
"integer"
]
},
"scheme": {
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"HTTPHeader": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"HorizontalPodAutoscalerBehavior": {
"additionalProperties": false,
"properties": {
"scaleDown": {
"$ref": "#/$defs/HPAScalingRules"
},
"scaleUp": {
"$ref": "#/$defs/HPAScalingRules"
}
},
"type": "object"
},
"HostPathVolumeSource": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"ISCSIVolumeSource": {
"additionalProperties": false,
"properties": {
"chapAuthDiscovery": {
"type": "boolean"
},
"chapAuthSession": {
"type": "boolean"
},
"fsType": {
"type": "string"
},
"initiatorName": {
"type": "string"
},
"iqn": {
"type": "string"
},
"iscsiInterface": {
"type": "string"
},
"lun": {
"type": "integer"
},
"portals": {
"items": {
"type": "string"
},
"type": "array"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"targetPortal": {
"type": "string"
}
},
"required": [
"targetPortal",
"iqn",
"lun"
],
"type": "object"
},
"Ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"hostname": {
"type": "string"
},
"ingressClassName": {
"type": "string"
},
"route": {
"$ref": "#/$defs/OpenShiftRoute"
},
"ruleType": {
"type": "string"
},
"tls": {
"items": {
"$ref": "#/$defs/IngressTLS"
},
"type": "array"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"IngressTLS": {
"additionalProperties": false,
"properties": {
"hosts": {
"items": {
"type": "string"
},
"type": "array"
},
"secretName": {
"type": "string"
}
},
"type": "object"
},
"IntOrString": {
"additionalProperties": false,
"properties": {
"IntVal": {
"type": "integer"
},
"StrVal": {
"type": "string"
},
"Type": {
"type": "integer"
}
},
"required": [
"Type",
"IntVal",
"StrVal"
],
"type": "object"
},
"KeyToPath": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"mode": {
"type": "integer"
},
"path": {
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"LabelSelector": {
"additionalProperties": false,
"properties": {
"matchExpressions": {
"items": {
"$ref": "#/$defs/LabelSelectorRequirement"
},
"type": "array"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"LabelSelectorRequirement": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"Lifecycle": {
"additionalProperties": false,
"properties": {
"postStart": {
"$ref": "#/$defs/LifecycleHandler"
},
"preStop": {
"$ref": "#/$defs/LifecycleHandler"
}
},
"type": "object"
},
"LifecycleHandler": {
"additionalProperties": false,
"properties": {
"exec": {
"$ref": "#/$defs/ExecAction"
},
"httpGet": {
"$ref": "#/$defs/HTTPGetAction"
},
"sleep": {
"$ref": "#/$defs/SleepAction"
},
"tcpSocket": {
"$ref": "#/$defs/TCPSocketAction"
}
},
"type": "object"
},
"LocalObjectReference": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
},
"type": "object"
},
"ManagedFieldsEntry": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"fieldsType": {
"type": "string"
},
"fieldsV1": {
"$ref": "#/$defs/FieldsV1"
},
"manager": {
"type": "string"
},
"operation": {
"type": "string"
},
"subresource": {
"type": "string"
},
"time": {
"$ref": "#/$defs/Time"
}
},
"type": "object"
},
"MetricIdentifier": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"selector": {
"$ref": "#/$defs/LabelSelector"
}
},
"required": [
"name"
],
"type": "object"
},
"MetricSpec": {
"additionalProperties": false,
"properties": {
"pods": {
"$ref": "#/$defs/PodsMetricSource"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"MetricTarget": {
"additionalProperties": false,
"properties": {
"averageUtilization": {
"type": "integer"
},
"averageValue": {
"$ref": "#/$defs/Quantity"
},
"type": {
"type": "string"
},
"value": {
"$ref": "#/$defs/Quantity"
}
},
"required": [
"type"
],
"type": "object"
},
"MetricsConfigSpec": {
"additionalProperties": false,
"properties": {
"DisablePrometheusAnnotations": {
"type": "boolean"
},
"enableMetrics": {
"type": "boolean"
}
},
"type": "object"
},
"ModifyVolumeStatus": {
"additionalProperties": false,
"properties": {
"status": {
"type": "string"
},
"targetVolumeAttributesClassName": {
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
},
"NFSVolumeSource": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"server": {
"type": "string"
}
},
"required": [
"server",
"path"
],
"type": "object"
},
"NodeAffinity": {
"additionalProperties": false,
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/PreferredSchedulingTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"$ref": "#/$defs/NodeSelector"
}
},
"type": "object"
},
"NodeSelector": {
"additionalProperties": false,
"properties": {
"nodeSelectorTerms": {
"items": {
"$ref": "#/$defs/NodeSelectorTerm"
},
"type": "array"
}
},
"required": [
"nodeSelectorTerms"
],
"type": "object"
},
"NodeSelectorRequirement": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"NodeSelectorTerm": {
"additionalProperties": false,
"properties": {
"matchExpressions": {
"items": {
"$ref": "#/$defs/NodeSelectorRequirement"
},
"type": "array"
},
"matchFields": {
"items": {
"$ref": "#/$defs/NodeSelectorRequirement"
},
"type": "array"
}
},
"type": "object"
},
"ObjectFieldSelector": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"fieldPath": {
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"creationTimestamp": {
"$ref": "#/$defs/Time"
},
"deletionGracePeriodSeconds": {
"type": "integer"
},
"deletionTimestamp": {
"$ref": "#/$defs/Time"
},
"finalizers": {
"items": {
"type": "string"
},
"type": "array"
},
"generateName": {
"type": "string"
},
"generation": {
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"managedFields": {
"items": {
"$ref": "#/$defs/ManagedFieldsEntry"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"ownerReferences": {
"items": {
"$ref": "#/$defs/OwnerReference"
},
"type": "array"
},
"resourceVersion": {
"type": "string"
},
"selfLink": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
},
"ObservabilitySpec": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/MetricsConfigSpec"
}
},
"type": "object"
},
"OpenShiftRoute": {
"additionalProperties": false,
"properties": {
"termination": {
"type": "string"
}
},
"type": "object"
},
"OpenTelemetryCollectorSpec": {
"additionalProperties": true,
"properties": {
"additionalContainers": {
"items": {
"$ref": "#/$defs/Container"
},
"type": "array"
},
"affinity": {
"$ref": "#/$defs/Affinity"
},
"annotations": {
"type": "object"
},
"args": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"autoscaler": {
"$ref": "#/$defs/AutoscalerSpec"
},
"clusterRoleBinding": {
"properties": {
"clusterRoleName": {
"type": "string"
},
"enabled": {
"default": "true",
"type": "boolean"
}
},
"type": "object"
},
"config": {
"type": "object"
},
"configmaps": {
"items": {
"$ref": "#/$defs/ConfigMapsSpec"
},
"type": "array"
},
"deploymentUpdateStrategy": {
"$ref": "#/$defs/DeploymentStrategy"
},
"enabled": {
"type": "boolean"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"envFrom": {
"items": {
"$ref": "#/$defs/EnvFromSource"
},
"type": "array"
},
"hostNetwork": {
"type": "boolean"
},
"image": {
"additionalProperties": false,
"description": "Image use in both standalone and agent configs",
"properties": {
"digest": {
"type": "string"
},
"pullPolicy": {
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"type": "string"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"ingress": {
"$ref": "#/$defs/Ingress"
},
"initContainers": {
"items": {
"$ref": "#/$defs/Container"
},
"type": "array"
},
"labels": {
"type": "object"
},
"lifecycle": {
"$ref": "#/$defs/Lifecycle"
},
"livenessProbe": {
"$ref": "#/$defs/Probe"
},
"managementState": {
"type": "string"
},
"maxReplicas": {
"type": "integer"
},
"minReplicas": {
"type": "integer"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"observability": {
"$ref": "#/$defs/ObservabilitySpec"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"podDisruptionBudget": {
"$ref": "#/$defs/PodDisruptionBudgetSpec"
},
"podSecurityContext": {
"$ref": "#/$defs/PodSecurityContext"
},
"ports": {
"items": {
"$ref": "#/$defs/ServicePort"
},
"type": "array"
},
"priorityClassName": {
"type": "string"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/$defs/ResourceRequirements"
},
"scrape_configs_file": {
"default": "",
"type": "string"
},
"securityContext": {
"$ref": "#/$defs/SecurityContext"
},
"serviceAccount": {
"type": "string"
},
"shareProcessNamespace": {
"type": "boolean"
},
"targetAllocator": {
"$ref": "#/$defs/OpenTelemetryTargetAllocator"
},
"terminationGracePeriodSeconds": {
"type": "integer"
},
"tolerations": {
"items": {
"$ref": "#/$defs/Toleration"
},
"type": "array"
},
"topologySpreadConstraints": {
"items": {
"$ref": "#/$defs/TopologySpreadConstraint"
},
"type": "array"
},
"updateStrategy": {
"$ref": "#/$defs/DaemonSetUpdateStrategy"
},
"upgradeStrategy": {
"type": "string"
},
"volumeClaimTemplates": {
"items": {
"$ref": "#/$defs/PersistentVolumeClaim"
},
"type": "array"
},
"volumeMounts": {
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"volumes": {
"items": {
"$ref": "#/$defs/Volume"
},
"type": "array"
}
},
"type": "object"
},
"OpenTelemetryTargetAllocator": {
"additionalProperties": false,
"properties": {
"affinity": {
"$ref": "#/$defs/Affinity"
},
"allocationStrategy": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"filterStrategy": {
"type": "string"
},
"image": {
"additionalProperties": false,
"description": "Image use in both standalone and agent configs",
"properties": {
"digest": {
"type": "string"
},
"pullPolicy": {
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"type": "string"
},
"registry": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"observability": {
"$ref": "#/$defs/ObservabilitySpec"
},
"podDisruptionBudget": {
"$ref": "#/$defs/PodDisruptionBudgetSpec"
},
"podSecurityContext": {
"$ref": "#/$defs/PodSecurityContext"
},
"prometheusCR": {
"$ref": "#/$defs/OpenTelemetryTargetAllocatorPrometheusCR"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/$defs/ResourceRequirements"
},
"securityContext": {
"$ref": "#/$defs/SecurityContext"
},
"serviceAccount": {
"type": "string"
},
"tolerations": {
"items": {
"$ref": "#/$defs/Toleration"
},
"type": "array"
},
"topologySpreadConstraints": {
"items": {
"$ref": "#/$defs/TopologySpreadConstraint"
},
"type": "array"
}
},
"type": "object"
},
"OpenTelemetryTargetAllocatorPrometheusCR": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"podMonitorSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"scrapeInterval": {
"type": "string"
},
"serviceMonitorSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"OwnerReference": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"blockOwnerDeletion": {
"type": "boolean"
},
"controller": {
"type": "boolean"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"type": "object"
},
"PersistentVolumeClaim": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta"
},
"spec": {
"$ref": "#/$defs/PersistentVolumeClaimSpec"
},
"status": {
"$ref": "#/$defs/PersistentVolumeClaimStatus"
}
},
"type": "object"
},
"PersistentVolumeClaimCondition": {
"additionalProperties": false,
"properties": {
"lastProbeTime": {
"$ref": "#/$defs/Time"
},
"lastTransitionTime": {
"$ref": "#/$defs/Time"
},
"message": {
"type": "string"
},
"reason": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"status"
],
"type": "object"
},
"PersistentVolumeClaimSpec": {
"additionalProperties": false,
"properties": {
"accessModes": {
"items": {
"type": "string"
},
"type": "array"
},
"dataSource": {
"$ref": "#/$defs/TypedLocalObjectReference"
},
"dataSourceRef": {
"$ref": "#/$defs/TypedObjectReference"
},
"resources": {
"$ref": "#/$defs/VolumeResourceRequirements"
},
"selector": {
"$ref": "#/$defs/LabelSelector"
},
"storageClassName": {
"type": "string"
},
"volumeAttributesClassName": {
"type": "string"
},
"volumeMode": {
"type": "string"
},
"volumeName": {
"type": "string"
}
},
"type": "object"
},
"PersistentVolumeClaimStatus": {
"additionalProperties": false,
"properties": {
"accessModes": {
"items": {
"type": "string"
},
"type": "array"
},
"allocatedResourceStatuses": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"allocatedResources": {
"$ref": "#/$defs/ResourceList"
},
"capacity": {
"$ref": "#/$defs/ResourceList"
},
"conditions": {
"items": {
"$ref": "#/$defs/PersistentVolumeClaimCondition"
},
"type": "array"
},
"currentVolumeAttributesClassName": {
"type": "string"
},
"modifyVolumeStatus": {
"$ref": "#/$defs/ModifyVolumeStatus"
},
"phase": {
"type": "string"
}
},
"type": "object"
},
"PersistentVolumeClaimTemplate": {
"additionalProperties": false,
"properties": {
"metadata": {
"$ref": "#/$defs/ObjectMeta"
},
"spec": {
"$ref": "#/$defs/PersistentVolumeClaimSpec"
}
},
"required": [
"spec"
],
"type": "object"
},
"PersistentVolumeClaimVolumeSource": {
"additionalProperties": false,
"properties": {
"claimName": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"claimName"
],
"type": "object"
},
"PhotonPersistentDiskVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"pdID": {
"type": "string"
}
},
"required": [
"pdID"
],
"type": "object"
},
"PodAffinity": {
"additionalProperties": false,
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"PodAffinityTerm": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"$ref": "#/$defs/LabelSelector"
},
"matchLabelKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"mismatchLabelKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"namespaceSelector": {
"$ref": "#/$defs/LabelSelector"
},
"namespaces": {
"items": {
"type": "string"
},
"type": "array"
},
"topologyKey": {
"type": "string"
}
},
"required": [
"topologyKey"
],
"type": "object"
},
"PodAntiAffinity": {
"additionalProperties": false,
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"items": {
"$ref": "#/$defs/PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"PodDisruptionBudgetSpec": {
"additionalProperties": false,
"properties": {
"maxUnavailable": {
"type": [
"string",
"integer"
]
},
"minAvailable": {
"type": [
"string",
"integer"
]
}
},
"type": "object"
},
"PodSecurityContext": {
"additionalProperties": false,
"properties": {
"fsGroup": {
"type": "integer"
},
"fsGroupChangePolicy": {
"type": "string"
},
"runAsGroup": {
"type": "integer"
},
"runAsNonRoot": {
"type": "boolean"
},
"runAsUser": {
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/$defs/SELinuxOptions"
},
"seccompProfile": {
"$ref": "#/$defs/SeccompProfile"
},
"supplementalGroups": {
"items": {
"type": "integer"
},
"type": "array"
},
"sysctls": {
"items": {
"$ref": "#/$defs/Sysctl"
},
"type": "array"
},
"windowsOptions": {
"$ref": "#/$defs/WindowsSecurityContextOptions"
}
},
"type": "object"
},
"PodsMetricSource": {
"additionalProperties": false,
"properties": {
"metric": {
"$ref": "#/$defs/MetricIdentifier"
},
"target": {
"$ref": "#/$defs/MetricTarget"
}
},
"required": [
"metric",
"target"
],
"type": "object"
},
"PortworxVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"volumeID": {
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"PreferredSchedulingTerm": {
"additionalProperties": false,
"properties": {
"preference": {
"$ref": "#/$defs/NodeSelectorTerm"
},
"weight": {
"type": "integer"
}
},
"required": [
"weight",
"preference"
],
"type": "object"
},
"Probe": {
"additionalProperties": false,
"properties": {
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"terminationGracePeriodSeconds": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"type": "object"
},
"ProjectedVolumeSource": {
"additionalProperties": false,
"properties": {
"defaultMode": {
"type": "integer"
},
"sources": {
"items": {
"$ref": "#/$defs/VolumeProjection"
},
"type": "array"
}
},
"required": [
"sources"
],
"type": "object"
},
"Quantity": {
"additionalProperties": false,
"properties": {
"Format": {
"type": "string"
}
},
"required": [
"Format"
],
"type": "object"
},
"QuobyteVolumeSource": {
"additionalProperties": false,
"properties": {
"group": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"registry": {
"type": "string"
},
"tenant": {
"type": "string"
},
"user": {
"type": "string"
},
"volume": {
"type": "string"
}
},
"required": [
"registry",
"volume"
],
"type": "object"
},
"RBDVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"image": {
"type": "string"
},
"keyring": {
"type": "string"
},
"monitors": {
"items": {
"type": "string"
},
"type": "array"
},
"pool": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"user": {
"type": "string"
}
},
"required": [
"monitors",
"image"
],
"type": "object"
},
"ResourceClaim": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ResourceFieldSelector": {
"additionalProperties": false,
"properties": {
"containerName": {
"type": "string"
},
"divisor": {
"$ref": "#/$defs/Quantity"
},
"resource": {
"type": "string"
}
},
"required": [
"resource"
],
"type": "object"
},
"ResourceList": {
"additionalProperties": {
"$ref": "#/$defs/Quantity"
},
"type": "object"
},
"ResourceRequirements": {
"additionalProperties": false,
"properties": {
"limits": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": [
"string",
"integer"
]
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"requests": {
"additionalProperties": false,
"properties": {
"cpu": {
"type": [
"string",
"integer"
]
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"RollingUpdateDaemonSet": {
"additionalProperties": false,
"properties": {
"maxSurge": {
"type": [
"string",
"integer"
]
},
"maxUnavailable": {
"type": [
"string",
"integer"
]
}
},
"type": "object"
},
"RollingUpdateDeployment": {
"additionalProperties": false,
"properties": {
"maxSurge": {
"type": [
"string",
"integer"
]
},
"maxUnavailable": {
"type": [
"string",
"integer"
]
}
},
"type": "object"
},
"SELinuxOptions": {
"additionalProperties": false,
"properties": {
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"type": {
"type": "string"
},
"user": {
"type": "string"
}
},
"type": "object"
},
"ScaleIOVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"gateway": {
"type": "string"
},
"protectionDomain": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"sslEnabled": {
"type": "boolean"
},
"storageMode": {
"type": "string"
},
"storagePool": {
"type": "string"
},
"system": {
"type": "string"
},
"volumeName": {
"type": "string"
}
},
"required": [
"gateway",
"system",
"secretRef"
],
"type": "object"
},
"SeccompProfile": {
"additionalProperties": false,
"properties": {
"localhostProfile": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"SecretEnvSource": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"SecretKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"SecretProjection": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/$defs/KeyToPath"
},
"type": "array"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"type": "object"
},
"SecretVolumeSource": {
"additionalProperties": false,
"properties": {
"defaultMode": {
"type": "integer"
},
"items": {
"items": {
"$ref": "#/$defs/KeyToPath"
},
"type": "array"
},
"optional": {
"type": "boolean"
},
"secretName": {
"type": "string"
}
},
"type": "object"
},
"SecurityContext": {
"additionalProperties": false,
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"capabilities": {
"$ref": "#/$defs/Capabilities"
},
"privileged": {
"type": "boolean"
},
"procMount": {
"type": "string"
},
"readOnlyRootFilesystem": {
"type": "boolean"
},
"runAsGroup": {
"type": "integer"
},
"runAsNonRoot": {
"type": "boolean"
},
"runAsUser": {
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/$defs/SELinuxOptions"
},
"seccompProfile": {
"$ref": "#/$defs/SeccompProfile"
},
"windowsOptions": {
"$ref": "#/$defs/WindowsSecurityContextOptions"
}
},
"type": "object"
},
"ServiceAccountTokenProjection": {
"additionalProperties": false,
"properties": {
"audience": {
"type": "string"
},
"expirationSeconds": {
"type": "integer"
},
"path": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"ServicePort": {
"additionalProperties": false,
"properties": {
"appProtocol": {
"type": "string"
},
"name": {
"type": "string"
},
"nodePort": {
"type": "integer"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": [
"string",
"integer"
]
}
},
"required": [
"port"
],
"type": "object"
},
"SleepAction": {
"additionalProperties": false,
"properties": {
"seconds": {
"type": "integer"
}
},
"required": [
"seconds"
],
"type": "object"
},
"StorageOSVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/LocalObjectReference"
},
"volumeName": {
"type": "string"
},
"volumeNamespace": {
"type": "string"
}
},
"type": "object"
},
"Sysctl": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"TCPSocketAction": {
"additionalProperties": false,
"properties": {
"host": {
"type": "string"
},
"port": {
"type": [
"string",
"integer"
]
}
},
"required": [
"port"
],
"type": "object"
},
"Time": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"Toleration": {
"additionalProperties": false,
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"tolerationSeconds": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"TopologySpreadConstraint": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"$ref": "#/$defs/LabelSelector"
},
"matchLabelKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"maxSkew": {
"type": "integer"
},
"minDomains": {
"type": "integer"
},
"nodeAffinityPolicy": {
"type": "string"
},
"nodeTaintsPolicy": {
"type": "string"
},
"topologyKey": {
"type": "string"
},
"whenUnsatisfiable": {
"type": "string"
}
},
"required": [
"maxSkew",
"topologyKey",
"whenUnsatisfiable"
],
"type": "object"
},
"TypedLocalObjectReference": {
"additionalProperties": false,
"properties": {
"apiGroup": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"apiGroup",
"kind",
"name"
],
"type": "object"
},
"TypedObjectReference": {
"additionalProperties": false,
"properties": {
"apiGroup": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
}
},
"required": [
"apiGroup",
"kind",
"name"
],
"type": "object"
},
"Volume": {
"additionalProperties": false,
"properties": {
"awsElasticBlockStore": {
"$ref": "#/$defs/AWSElasticBlockStoreVolumeSource"
},
"azureDisk": {
"$ref": "#/$defs/AzureDiskVolumeSource"
},
"azureFile": {
"$ref": "#/$defs/AzureFileVolumeSource"
},
"cephfs": {
"$ref": "#/$defs/CephFSVolumeSource"
},
"cinder": {
"$ref": "#/$defs/CinderVolumeSource"
},
"configMap": {
"$ref": "#/$defs/ConfigMapVolumeSource"
},
"csi": {
"$ref": "#/$defs/CSIVolumeSource"
},
"downwardAPI": {
"$ref": "#/$defs/DownwardAPIVolumeSource"
},
"emptyDir": {
"$ref": "#/$defs/EmptyDirVolumeSource"
},
"ephemeral": {
"$ref": "#/$defs/EphemeralVolumeSource"
},
"fc": {
"$ref": "#/$defs/FCVolumeSource"
},
"flexVolume": {
"$ref": "#/$defs/FlexVolumeSource"
},
"flocker": {
"$ref": "#/$defs/FlockerVolumeSource"
},
"gcePersistentDisk": {
"$ref": "#/$defs/GCEPersistentDiskVolumeSource"
},
"gitRepo": {
"$ref": "#/$defs/GitRepoVolumeSource"
},
"glusterfs": {
"$ref": "#/$defs/GlusterfsVolumeSource"
},
"hostPath": {
"$ref": "#/$defs/HostPathVolumeSource"
},
"iscsi": {
"$ref": "#/$defs/ISCSIVolumeSource"
},
"name": {
"type": "string"
},
"nfs": {
"$ref": "#/$defs/NFSVolumeSource"
},
"persistentVolumeClaim": {
"$ref": "#/$defs/PersistentVolumeClaimVolumeSource"
},
"photonPersistentDisk": {
"$ref": "#/$defs/PhotonPersistentDiskVolumeSource"
},
"portworxVolume": {
"$ref": "#/$defs/PortworxVolumeSource"
},
"projected": {
"$ref": "#/$defs/ProjectedVolumeSource"
},
"quobyte": {
"$ref": "#/$defs/QuobyteVolumeSource"
},
"rbd": {
"$ref": "#/$defs/RBDVolumeSource"
},
"scaleIO": {
"$ref": "#/$defs/ScaleIOVolumeSource"
},
"secret": {
"$ref": "#/$defs/SecretVolumeSource"
},
"storageos": {
"$ref": "#/$defs/StorageOSVolumeSource"
},
"vsphereVolume": {
"$ref": "#/$defs/VsphereVirtualDiskVolumeSource"
}
},
"required": [
"name"
],
"type": "object"
},
"VolumeDevice": {
"additionalProperties": false,
"properties": {
"devicePath": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"devicePath"
],
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"properties": {
"mountPath": {
"type": "string"
},
"mountPropagation": {
"type": "string"
},
"name": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"subPath": {
"type": "string"
},
"subPathExpr": {
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"VolumeProjection": {
"additionalProperties": false,
"properties": {
"clusterTrustBundle": {
"$ref": "#/$defs/ClusterTrustBundleProjection"
},
"configMap": {
"$ref": "#/$defs/ConfigMapProjection"
},
"downwardAPI": {
"$ref": "#/$defs/DownwardAPIProjection"
},
"secret": {
"$ref": "#/$defs/SecretProjection"
},
"serviceAccountToken": {
"$ref": "#/$defs/ServiceAccountTokenProjection"
}
},
"type": "object"
},
"VolumeResourceRequirements": {
"additionalProperties": false,
"properties": {
"limits": {
"type": "object"
},
"requests": {
"type": "object"
}
},
"type": "object"
},
"VsphereVirtualDiskVolumeSource": {
"additionalProperties": false,
"properties": {
"fsType": {
"type": "string"
},
"storagePolicyID": {
"type": "string"
},
"storagePolicyName": {
"type": "string"
},
"volumePath": {
"type": "string"
}
},
"required": [
"volumePath"
],
"type": "object"
},
"WeightedPodAffinityTerm": {
"additionalProperties": false,
"properties": {
"podAffinityTerm": {
"$ref": "#/$defs/PodAffinityTerm"
},
"weight": {
"type": "integer"
}
},
"required": [
"weight",
"podAffinityTerm"
],
"type": "object"
},
"WindowsSecurityContextOptions": {
"additionalProperties": false,
"properties": {
"gmsaCredentialSpec": {
"type": "string"
},
"gmsaCredentialSpecName": {
"type": "string"
},
"hostProcess": {
"type": "boolean"
},
"runAsUserName": {
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://github.com/open-telemetry/opentelemetry-operator/apis/v1alpha1/open-telemetry-collector-spec",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"clusterName": {
"type": "string"
},
"clusterRole": {
"additionalProperties": false,
"properties": {
"annotations": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"rules": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"collectors": {
"patternProperties": {
"^[a-z]+[a-zA-Z0-9]+$": {
"$ref": "#/$defs/OpenTelemetryCollectorSpec"
}
},
"type": "object"
},
"defaultCRConfig": {
"$ref": "#/$defs/OpenTelemetryCollectorSpec"
},
"extraEnvs": {
"items": {
"type": "object"
},
"type": "array"
},
"fullnameOverride": {
"type": "string"
},
"namespaceOverride": {
"type": "string"
}
}
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 44ebd75a2f3923d77dee9a538b0c90f9ae2a0f3e | 2023-11-20T20:24:04 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.89.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.89.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"cert_file",
"key_file",
"ca_file",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.89.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.89.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.89.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.89.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.89.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.89.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 01182b7944941ffa41480797143871a3ee266918 | 2024-04-11T18:15:14 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"additionalLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The additionalLabels Schema",
"type": "object"
},
"admissionWebhooks": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoGenerateCert": {
"enabled": true,
"recreate": true
},
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"pods": {
"failurePolicy": "Ignore"
},
"secretAnnotations": {},
"secretLabels": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"recreate": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"recreate": {
"default": false,
"examples": [
true
],
"title": "The recreate Schema",
"type": "boolean"
}
},
"required": [
"enabled",
"recreate"
],
"title": "The autoGenerateCert Schema",
"type": "object"
},
"caFile": {
"default": "",
"examples": [
""
],
"title": "File path to self-managed CA bundle.",
"type": "string"
},
"certFile": {
"default": "",
"examples": [
""
],
"title": "File path to self-managed TLS certificate.",
"type": "string"
},
"certManager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"keyFile": {
"default": "",
"examples": [
""
],
"title": "File path to self-managed TLS key.",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"additionalProperties": false,
"default": {},
"examples": [
{
"failurePolicy": "Ignore"
}
],
"properties": {
"failurePolicy": {
"default": "",
"examples": [
"Ignore"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretLabels Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"servicePort": {
"default": 443,
"examples": [
9443
],
"title": "The port for the webhook service",
"type": "integer"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"certFile",
"keyFile",
"caFile",
"serviceAnnotations",
"secretAnnotations",
"secretLabels"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Kubernetes cluster domain suffix",
"type": "string"
},
"clusterRole": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"enabled": {
"description": "Usually used when using Opentelemetry-operator as a subchart.",
"type": "boolean"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"global": {
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
},
"securityContext": {}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.15.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.15.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs",
"securityContext"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"additionalProperties": false,
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"featureGates": "",
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
},
"leaderElection": {
"enabled": true
},
"opampBridgeImage": {
"repository": "",
"tag": ""
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"securityContext": {},
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The go Schema",
"type": "object"
},
"java": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet",
"go"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"createRbacPermissions": {
"default": false,
"examples": [
false
],
"title": "Whether the operator should create RBAC permissions for collector deployments",
"type": "boolean"
},
"deploymentAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The deploymentAnnotations Schema",
"type": "object"
},
"env": {
"additionalProperties": {
"type": "string"
},
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "",
"examples": [
""
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.93.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.93.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"opampBridgeImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The opampBridgeImage Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"additionalProperties": false,
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The serviceAnnotations Schema",
"type": "object"
},
"serviceMonitor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"additionalProperties": false,
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 0,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"opampBridgeImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"featureGates",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"deploymentAnnotations",
"serviceAnnotations",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling",
"securityContext"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"additionalProperties": false,
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"additionalProperties": false,
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"clusterDomain",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework",
"additionalLabels"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | 851bb84a5d3ee8224aa32538fcdb7899738ed659 | 2023-05-26T14:05:31 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"admissionWebhooks": {
"autoGenerateCert": true,
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretAnnotations": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.77.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"default": {},
"examples": [
{
"autoGenerateCert": true,
"ca_file": "",
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"cert_file": "",
"create": true,
"failurePolicy": "Fail",
"key_file": "",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretAnnotations": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"autoGenerateCert": {
"default": true,
"examples": [
true
],
"title": "The autoGenerateCert schema",
"type": "boolean"
},
"ca_file": {
"default": "",
"examples": [
""
],
"title": "The ca_file Schema",
"type": "string"
},
"certManager": {
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"cert_file": {
"default": "",
"examples": [
""
],
"title": "The cert_file Schema",
"type": "string"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"key_file": {
"default": "",
"examples": [
""
],
"title": "The key_file Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"pods": {
"default": {},
"properties": {
"failurePolicy": {
"default": "Ignore",
"examples": [
"Ignore",
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
}
},
"required": [
"failurePolicy"
],
"title": "The pods Schema",
"type": "object"
},
"secretAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The secretAnnotations Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"pods",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager",
"autoGenerateCert",
"secretAnnotations",
"cert_file",
"key_file",
"ca_file"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.14.1"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"go": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.77.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"go": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The Go Schema",
"type": "object"
},
"java": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.77.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.77.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"featureGates": {
"default": "operator.autoinstrumentation.go",
"examples": [
"-operator.autoinstrumentation.go,-operator.autoinstrumentation.go"
],
"title": "The featureGates Schema",
"type": "string"
},
"image": {
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.77.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.77.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 2,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
open-telemetry/opentelemetry-helm-charts | f8cd09d79036499c6d6f4765a4923adb64400a4d | 2023-04-12T14:26:28 | charts/opentelemetry-operator/values.schema.json | 348 | 2024-05-28T04:59:59.268796Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"admissionWebhooks": {
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"create": true,
"failurePolicy": "Fail",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretName": "",
"timeoutSeconds": 10
},
"affinity": {},
"clusterRole": {
"create": true
},
"hostNetwork": false,
"imagePullSecrets": [],
"kubeRBACProxy": {
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
},
"manager": {
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.75.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.74.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
},
"nameOverride": "",
"nodeSelector": {},
"pdb": {
"create": false,
"maxUnavailable": "",
"minAvailable": 1
},
"priorityClassName": "",
"replicaCount": 1,
"role": {
"create": true
},
"securityContext": {
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
},
"testFramework": {
"image": {
"repository": "busybox",
"tag": "latest"
}
},
"tolerations": [],
"topologySpreadConstraints": []
}
],
"properties": {
"admissionWebhooks": {
"default": {},
"examples": [
{
"certManager": {
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
},
"create": true,
"failurePolicy": "Fail",
"namePrefix": "",
"namespaceSelector": {},
"objectSelector": {},
"secretName": "",
"timeoutSeconds": 10
}
],
"properties": {
"certManager": {
"default": {},
"examples": [
{
"certificateAnnotations": {},
"enabled": true,
"issuerAnnotations": {},
"issuerRef": {}
}
],
"properties": {
"certificateAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The certificateAnnotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"issuerAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerAnnotations Schema",
"type": "object"
},
"issuerRef": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The issuerRef Schema",
"type": "object"
}
},
"required": [
"enabled",
"issuerRef",
"certificateAnnotations",
"issuerAnnotations"
],
"title": "The certManager Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"failurePolicy": {
"default": "",
"examples": [
"Fail"
],
"title": "The failurePolicy Schema",
"type": "string"
},
"namePrefix": {
"default": "",
"examples": [
""
],
"title": "The namePrefix Schema",
"type": "string"
},
"namespaceSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The namespaceSelector Schema",
"type": "object"
},
"objectSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The objectSelector Schema",
"type": "object"
},
"secretName": {
"default": "",
"examples": [
""
],
"title": "The secretName Schema",
"type": "string"
},
"timeoutSeconds": {
"default": 0,
"examples": [
10
],
"title": "The timeoutSeconds Schema",
"type": "integer"
}
},
"required": [
"create",
"failurePolicy",
"secretName",
"namePrefix",
"timeoutSeconds",
"namespaceSelector",
"objectSelector",
"certManager"
],
"title": "The admissionWebhooks Schema",
"type": "object"
},
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"clusterRole": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The clusterRole Schema",
"type": "object"
},
"hostNetwork": {
"default": false,
"examples": [
false
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"kubeRBACProxy": {
"default": {},
"examples": [
{
"enabled": true,
"extraArgs": [],
"image": {
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
},
"ports": {
"proxyPort": 8443
},
"resources": {
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "quay.io/brancz/kube-rbac-proxy",
"tag": "v0.14.1"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"quay.io/brancz/kube-rbac-proxy"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.14.1"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"proxyPort": 8443
}
],
"properties": {
"proxyPort": {
"default": 0,
"examples": [
8443
],
"title": "The proxyPort Schema",
"type": "integer"
}
},
"required": [
"proxyPort"
],
"title": "The ports Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "500m",
"memory": "128Mi"
},
"requests": {
"cpu": "5m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "500m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"500m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "5m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"5m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
}
},
"required": [
"enabled",
"image",
"ports",
"resources",
"extraArgs"
],
"title": "The kubeRBACProxy Schema",
"type": "object"
},
"manager": {
"default": {},
"examples": [
{
"autoInstrumentationImage": {
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
},
"collectorImage": {
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.75.0"
},
"env": {
"ENABLE_WEBHOOKS": "true"
},
"extraArgs": [],
"image": {
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.74.0"
},
"leaderElection": {
"enabled": true
},
"podAnnotations": {},
"podLabels": {},
"ports": {
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
},
"prometheusRule": {
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
},
"resources": {
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
},
"rolling": false,
"serviceAccount": {
"annotations": {},
"create": true
},
"serviceMonitor": {
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
},
"targetAllocatorImage": {
"repository": "",
"tag": ""
},
"verticalPodAutoscaler": {
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
}
],
"properties": {
"autoInstrumentationImage": {
"default": {},
"examples": [
{
"dotnet": {
"repository": "",
"tag": ""
},
"java": {
"repository": "",
"tag": ""
},
"nodejs": {
"repository": "",
"tag": ""
},
"python": {
"repository": "",
"tag": ""
}
}
],
"properties": {
"dotnet": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The dotnet Schema",
"type": "object"
},
"java": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The java Schema",
"type": "object"
},
"nodejs": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The nodejs Schema",
"type": "object"
},
"python": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The python Schema",
"type": "object"
}
},
"required": [
"java",
"nodejs",
"python",
"dotnet"
],
"title": "The autoInstrumentationImage Schema",
"type": "object"
},
"collectorImage": {
"default": {},
"examples": [
{
"repository": "otel/opentelemetry-collector-contrib",
"tag": "0.75.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"otel/opentelemetry-collector-contrib"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"0.75.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The collectorImage Schema",
"type": "object"
},
"env": {
"default": {},
"examples": [
{
"ENABLE_WEBHOOKS": "true"
}
],
"properties": {
"ENABLE_WEBHOOKS": {
"default": "",
"examples": [
"true"
],
"title": "The ENABLE_WEBHOOKS Schema",
"type": "string"
}
},
"required": [
"ENABLE_WEBHOOKS"
],
"title": "The env Schema",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The extraArgs Schema",
"type": "array"
},
"image": {
"default": {},
"examples": [
{
"repository": "ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator",
"tag": "v0.74.0"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"v0.74.0"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"leaderElection": {
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
true
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The leaderElection Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podLabels Schema",
"type": "object"
},
"ports": {
"default": {},
"examples": [
{
"healthzPort": 8081,
"metricsPort": 8080,
"webhookPort": 9443
}
],
"properties": {
"healthzPort": {
"default": 0,
"examples": [
8081
],
"title": "The healthzPort Schema",
"type": "integer"
},
"metricsPort": {
"default": 0,
"examples": [
8080
],
"title": "The metricsPort Schema",
"type": "integer"
},
"webhookPort": {
"default": 0,
"examples": [
9443
],
"title": "The webhookPort Schema",
"type": "integer"
}
},
"required": [
"metricsPort",
"webhookPort",
"healthzPort"
],
"title": "The ports Schema",
"type": "object"
},
"prometheusRule": {
"default": {},
"examples": [
{
"annotations": {},
"defaultRules": {
"enabled": false
},
"enabled": false,
"extraLabels": {},
"groups": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"defaultRules": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "The defaultRules Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"groups": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The groups Schema",
"type": "array"
}
},
"required": [
"enabled",
"groups",
"defaultRules",
"extraLabels",
"annotations"
],
"title": "The prometheusRule Schema",
"type": "object"
},
"resources": {
"default": {},
"examples": [
{
"limits": {
"cpu": "100m",
"memory": "128Mi"
},
"requests": {
"cpu": "100m",
"memory": "64Mi"
}
}
],
"properties": {
"limits": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "128Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"128Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The limits Schema",
"type": "object"
},
"requests": {
"default": {},
"examples": [
{
"cpu": "100m",
"memory": "64Mi"
}
],
"properties": {
"cpu": {
"default": "",
"examples": [
"100m"
],
"title": "The cpu Schema",
"type": "string"
},
"memory": {
"default": "",
"examples": [
"64Mi"
],
"title": "The memory Schema",
"type": "string"
}
},
"required": [
"cpu",
"memory"
],
"title": "The requests Schema",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "The resources Schema",
"type": "object"
},
"rolling": {
"default": false,
"examples": [
false
],
"title": "The rolling Schema",
"type": "boolean"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create",
"annotations"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"annotations": {},
"enabled": false,
"extraLabels": {},
"metricsEndpoints": [
{
"port": "metrics"
}
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels Schema",
"type": "object"
},
"metricsEndpoints": {
"default": [],
"examples": [
[
{
"port": "metrics"
}
]
],
"items": {
"default": {},
"examples": [
{
"port": "metrics"
}
],
"properties": {
"port": {
"default": "",
"examples": [
"metrics"
],
"title": "The port Schema",
"type": "string"
}
},
"required": [
"port"
],
"title": "A Schema",
"type": "object"
},
"title": "The metricsEndpoints Schema",
"type": "array"
}
},
"required": [
"enabled",
"extraLabels",
"annotations",
"metricsEndpoints"
],
"title": "The serviceMonitor Schema",
"type": "object"
},
"targetAllocatorImage": {
"default": {},
"examples": [
{
"repository": "",
"tag": ""
}
],
"properties": {
"repository": {
"default": "",
"examples": [
""
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The targetAllocatorImage Schema",
"type": "object"
},
"verticalPodAutoscaler": {
"default": {},
"examples": [
{
"controlledResources": [],
"enabled": false,
"maxAllowed": {},
"minAllowed": {},
"updatePolicy": {
"minReplicas": 2,
"updateMode": "Auto"
}
}
],
"properties": {
"controlledResources": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The controlledResources Schema",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"maxAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The maxAllowed Schema",
"type": "object"
},
"minAllowed": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The minAllowed Schema",
"type": "object"
},
"updatePolicy": {
"default": {},
"examples": [
{
"minReplicas": 2,
"updateMode": "Auto"
}
],
"properties": {
"minReplicas": {
"default": 2,
"examples": [
2
],
"title": "The minReplicas Schema",
"type": "integer"
},
"updateMode": {
"default": "",
"examples": [
"Auto"
],
"title": "The updateMode Schema",
"type": "string"
}
},
"required": [
"updateMode",
"minReplicas"
],
"title": "The updatePolicy Schema",
"type": "object"
}
},
"required": [
"enabled",
"controlledResources",
"maxAllowed",
"minAllowed",
"updatePolicy"
],
"title": "The verticalPodAutoscaler Schema",
"type": "object"
}
},
"required": [
"image",
"collectorImage",
"targetAllocatorImage",
"autoInstrumentationImage",
"ports",
"resources",
"env",
"serviceAccount",
"serviceMonitor",
"podAnnotations",
"podLabels",
"prometheusRule",
"extraArgs",
"leaderElection",
"verticalPodAutoscaler",
"rolling"
],
"title": "The manager Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pdb": {
"default": {},
"examples": [
{
"create": false,
"maxUnavailable": "",
"minAvailable": 1
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"minAvailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
}
},
"required": [
"create",
"minAvailable",
"maxUnavailable"
],
"title": "The pdb Schema",
"type": "object"
},
"priorityClassName": {
"default": "",
"examples": [
""
],
"title": "The priorityClassName Schema",
"type": "string"
},
"replicaCount": {
"default": 0,
"examples": [
1
],
"title": "The replicaCount Schema",
"type": "integer"
},
"role": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The role Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{
"fsGroup": 65532,
"runAsGroup": 65532,
"runAsNonRoot": true,
"runAsUser": 65532
}
],
"properties": {
"fsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The fsGroup Schema",
"type": "integer"
},
"runAsGroup": {
"default": 0,
"examples": [
65532
],
"title": "The runAsGroup Schema",
"type": "integer"
},
"runAsNonRoot": {
"default": false,
"examples": [
true
],
"title": "The runAsNonRoot Schema",
"type": "boolean"
},
"runAsUser": {
"default": 0,
"examples": [
65532
],
"title": "The runAsUser Schema",
"type": "integer"
}
},
"required": [
"runAsGroup",
"runAsNonRoot",
"runAsUser",
"fsGroup"
],
"title": "The securityContext Schema",
"type": "object"
},
"testFramework": {
"default": {},
"examples": [
{
"image": {
"repository": "busybox",
"tag": "latest"
}
}
],
"properties": {
"image": {
"default": {},
"examples": [
{
"repository": "busybox",
"tag": "latest"
}
],
"properties": {
"repository": {
"default": "",
"examples": [
"busybox"
],
"title": "The repository Schema",
"type": "string"
},
"tag": {
"default": "",
"examples": [
"latest"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
}
},
"required": [
"image"
],
"title": "The testFramework Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The topologySpreadConstraints Schema",
"type": "array"
}
},
"required": [
"replicaCount",
"nameOverride",
"imagePullSecrets",
"pdb",
"manager",
"kubeRBACProxy",
"admissionWebhooks",
"role",
"clusterRole",
"affinity",
"tolerations",
"nodeSelector",
"topologySpreadConstraints",
"hostNetwork",
"priorityClassName",
"securityContext",
"testFramework"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | b9e9d5357a93ba58d759b493428baa61419d9d2c | 2024-02-22T15:47:10 | docs/schemas/profile/qgis_profile.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "A QGIS profile described in a JSON file.",
"$id": "https://github.com/Guts/qgis-deployment-cli/raw/main/docs/schemas/profile/qgis_profile.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"alias": {
"description": "Profile's name in an human readable form, allowing special characters.",
"type": "string"
},
"author": {
"description": "Name of profile auhor and maintener.",
"type": "string"
},
"description": {
"description": "Profile description.",
"type": "string"
},
"email": {
"description": "Email of profile's auhor and maintener.",
"format": "email",
"maxLength": 127,
"minLength": 6,
"type": "string"
},
"folder_name": {
"description": "Name of the profile's directory in QGIS.",
"pattern": "^([a-zA-Z]:)?(\\\\[^<>:\"/\\\\|?*]+)+\\\\?$",
"type": "string"
},
"icon": {
"description": "Relative path to the icon used for shortcuts.",
"type": "string"
},
"name": {
"description": "Profile name without any special characters.",
"pattern": "^[_a-zA-Z][a-zA-Z0-9_-]*$"
},
"plugins": {
"description": "Plugins installed with the profile.",
"items": {
"$ref": "qgis_plugin.json"
},
"title": "QGIS Plugins",
"type": "array"
},
"qgisMaximumVersion": {
"description": "Maximum QGIS version where the profile can be deployed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"qgisMinimumVersion": {
"description": "Minimum QGIS version where the profile can be deployed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"splash": {
"description": "Relative path to the splash image.",
"type": "string"
},
"version": {
"description": "Profile version. Must complies with SemVer.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"required": [
"author",
"email",
"name",
"version"
],
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 47adeb050ac7b707bf8b85f3e00bd1e69e7ab3cb | 2023-03-09T10:46:50 | docs/schemas/scenario/jobs/shortcuts-manager.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/jobs/shortcuts-manager.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "create shortcuts in desktop and/or start menu allowing the end-user opening QGIS with a profile.",
"properties": {
"action": {
"default": "create_or_restore",
"description": "Which action to perform with shortcuts.",
"enum": [
"create",
"create_or_restore",
"remove"
],
"type": "string"
},
"include": {
"description": "Name of the branch to use when working with a git repository.",
"items": {
"properties": {
"additional_arguments": {
"description": "Arguments to pass to QGIS executable.",
"example": "--noversioncheck",
"type": "string"
},
"desktop": {
"default": false,
"description": "If true, create a desktop shortcut.",
"type": "boolean"
},
"icon": {
"description": "Filename of the icon to use for the shortcut.",
"type": "string"
},
"label": {
"description": "Text to display on the shortcut.",
"type": "string"
},
"profile": {
"description": "Name of the profile to associate with the shortcut.",
"type": "string"
},
"start_menu": {
"default": false,
"description": "If true, create a shortcut in start menu.",
"type": "boolean"
}
},
"type": "object"
},
"type": "array"
}
},
"title": "Shortcuts Manager.",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 79b8ea4f84eae27c37e38c4b6f6f0980b7054a0d | 2023-03-09T10:04:10 | docs/schemas/scenario/metadata.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/metadata.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "QGIS Deployment Toolbelt - Scenario metadata",
"properties": {
"description": {
"description": "Short or long description of what this scenario does. Multilines accepted.",
"type": "string"
},
"id": {
"description": "Unique identifier of the job. Like the title but slugified and without special characters.",
"pattern": "^[_a-zA-Z][a-zA-Z0-9_-]*$",
"type": "string"
},
"title": {
"description": "The title of the job.",
"pattern": "^[A-Za-z0-9 ]+$",
"type": "string"
}
},
"required": [
"id",
"title"
],
"title": "Define scenario's metadata.",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 94be5ff4815b7e08f9386bbb5a2b1beb300c9863 | 2023-02-03T16:58:55 | docs/schemas/scenario/settings.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/settings.json",
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"description": "QGIS Deployment Toolbelt - Environment variables",
"properties": {
"DEBUG": {
"default": false,
"description": "Enable debug mode. Make the execution more verbose but quite slower too.",
"title": "Debug mode",
"type": "boolean"
},
"LOCAL_QDT_WORKDIR": {
"default": null,
"description": "Where QDT stores locally everything it uses: profiles, plugins, etc.",
"title": "Local working folder.",
"type": [
"null",
"string"
]
},
"QGIS_EXE_PATH": {
"default": null,
"description": "QGIS executable to use for shortcuts and more.",
"properties": {
"linux": {
"description": "Path to QGIS on Linux.",
"examples": [
"/usr/bin/qgis"
],
"type": "string"
},
"mac": {
"description": "Path to QGIS on MacOS.",
"examples": [
"/usr/bin/qgis"
],
"type": "string"
},
"windows": {
"description": "Path to QGIS on Windows.",
"examples": [
"%PROGRAMFILES%/QGIS/3_22/bin/qgis-bin.exe"
],
"type": "string"
}
},
"title": "QGIS binary path.",
"type": "object"
},
"SCENARIO_VALIDATION": {
"default": false,
"description": "Enable scenario validation. This will check the scenario against the JSON schema.",
"title": "Scenario validation",
"type": "boolean"
}
},
"title": "Define environment variables for the QGIS Deployment CLI execution. Attention, no confusion: these are the settings for the toolbelt, not for the QGIS installation.",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 93745fb18aaa0cc94fc14011027e58ae2bb294ee | 2023-02-03T16:59:34 | docs/schemas/profile/qgis_plugin.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "A QGIS profile described in a JSON file.",
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/qgis_plugin.json",
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"location": {
"description": "Indicates if the plugin is located on a remote server or on local drive/network.",
"enum": [
"local",
"remote"
],
"type": "string"
},
"name": {
"description": "Plugin name, as referenced in the source plugins repository.",
"type": "string"
},
"official_repository": {
"description": "Indicates if the plugin is referenced on plugins.qgis.org",
"type": "boolean"
},
"plugin_id": {
"description": "Plugin ID as referenced into the repository (XML version). Typically for official repository: https://plugins.qgis.org/plugins/plugins.xml?qgis=3.22",
"type": "number"
},
"type": {
"deprecated": true,
"enum": [
"local",
"remote"
],
"type": "string"
},
"version": {
"description": "Plugin version to install.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 04a712c33ef99881ec1df3a940b28f167e5d7e3a | 2024-04-18T15:37:04 | docs/schemas/profile/qgis_profile.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "A QGIS profile described in a JSON file.",
"$id": "https://github.com/Guts/qgis-deployment-cli/raw/main/docs/schemas/profile/qgis_profile.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"alias": {
"description": "Profile's name in an human readable form, allowing special characters.",
"type": "string"
},
"author": {
"description": "Name of profile auhor and maintener.",
"type": "string"
},
"description": {
"description": "Profile description.",
"type": "string"
},
"email": {
"description": "Email of profile's auhor and maintener.",
"format": "email",
"maxLength": 127,
"minLength": 6,
"type": "string"
},
"folder_name": {
"description": "Name of the profile's directory in QGIS.",
"type": "string"
},
"icon": {
"description": "Relative path to the icon used for shortcuts.",
"type": "string"
},
"name": {
"description": "Profile name without any special characters.",
"type": "string"
},
"plugins": {
"description": "Plugins installed with the profile.",
"items": {
"$ref": "qgis_plugin.json"
},
"title": "QGIS Plugins",
"type": "array"
},
"qgisMaximumVersion": {
"description": "Maximum QGIS version where the profile can be deployed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"qgisMinimumVersion": {
"description": "Minimum QGIS version where the profile can be deployed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"rules": {
"description": "Plugins installed with the profile.",
"items": {
"$ref": "rules.json"
},
"title": "QGIS Plugins",
"type": "array"
},
"splash": {
"description": "Relative path to the splash image.",
"type": "string"
},
"version": {
"description": "Profile version. Must complies with SemVer.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"required": [
"author",
"email",
"name",
"version"
],
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 810e0ff4b67b4995f8e7e15003e3f4fb6d86326b | 2023-02-06T11:58:21 | docs/schemas/profile/qgis_profile.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "A QGIS profile described in a JSON file.",
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/qgis_profile.json",
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"alias": {
"description": "Profile's name in an human readable form, allowing special characters.",
"type": "string"
},
"author": {
"description": "Name of profile auhor and maintener.",
"type": "string"
},
"description": {
"description": "Profile description.",
"type": "string"
},
"email": {
"description": "Email of profile's auhor and maintener.",
"format": "email",
"maxLength": 127,
"minLength": 6,
"type": "string"
},
"folder_name": {
"description": "Name of the plugins's directory once installed in QGIS. Useful when name does not complies with filename conventions.",
"pattern": "^([a-zA-Z]:)?(\\\\[^<>:\"/\\\\|?*]+)+\\\\?$",
"type": "string"
},
"icon": {
"description": "Relative path to the icon used for shortcuts.",
"type": "string"
},
"name": {
"description": "Profile name without any special characters.",
"pattern": "^[_a-zA-Z][a-zA-Z0-9_-]*$"
},
"plugins": {
"description": "Plugins installed with the profile.",
"items": {
"$ref": "qgis_plugin.json"
},
"title": "QGIS Plugins",
"type": "array"
},
"qgisMaximumVersion": {
"description": "Maximum QGIS version where the profile can be deployed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"qgisMinimumVersion": {
"description": "Minimum QGIS version where the profile can be deployed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"splash": {
"description": "Relative path to the splash image.",
"type": "string"
},
"version": {
"description": "Profile version. Must complies with SemVer.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"required": [
"author",
"email",
"name",
"version"
],
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 57e40299cf0e075b9eedc89e362d0e65c7f04def | 2024-04-05T09:09:59 | docs/schemas/scenario/jobs/qgis-installation-finder.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://github.com/Guts/qgis-deployment-cli/raw/main/docs/schemas/scenario/jobs/qgis-installation-finder.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Job in charge of findind installed QGIS version on computer.",
"items": {
"properties": {
"if_not_found": {
"default": "error",
"description": "Behavior if no QGIS installation found.",
"enum": [
"warning",
"error"
],
"type": "string"
},
"version_priority": {
"default": "",
"description": "Define QGIS version priority for search.",
"type": "array"
}
},
"type": "object"
},
"title": "QGIS installation finder",
"type": "array"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 6676aae5b54b868b53e9e43355764b7c41ee8a55 | 2024-04-05T09:09:59 | docs/schemas/scenario/jobs/qgis-installation-finder.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://github.com/Guts/qgis-deployment-cli/raw/main/docs/schemas/scenario/jobs/qgis-installation-finder.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Job in charge of findind installed QGIS version on computer.",
"items": {
"properties": {
"if_not_found": {
"default": "warning",
"description": "Behavior if no QGIS installation found.",
"enum": [
"warning",
"error"
],
"type": "string"
},
"version_priority": {
"default": "",
"description": "Define QGIS version priority for search.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"title": "QGIS installation finder",
"type": "array"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | b9e9d5357a93ba58d759b493428baa61419d9d2c | 2024-02-22T15:47:10 | docs/schemas/scenario/jobs/qplugins-synchronizer.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://github.com/Guts/qgis-deployment-cli/raw/main/docs/schemas/scenario/jobs/qplugins-synchronizer.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "synchronize plugins between those stored locally (typically downloaded by the Plugins Downloader job) and the installed plugins.",
"properties": {
"action": {
"default": "create_or_restore",
"description": "Tell the job what to do with plugins in installed profiles.",
"enum": [
"create",
"create_or_restore",
"remove"
],
"type": "string"
},
"profile_ref": {
"default": "installed",
"description": "Which `profile.json` file to use as reference.",
"enum": [
"downloaded",
"installed"
],
"type": "string"
},
"source": {
"description": "Where to find plugins zip files.",
"type": "string"
}
},
"title": "QPlugins Synchronizer.",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 7cb52ada4bcebe2df804dba13fbe452c4ee57441 | 2023-03-09T10:06:43 | docs/schemas/scenario/jobs/qplugins-downloader.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/jobs/qplugins-downloader.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Download plugins into QDT local folder.",
"properties": {
"force": {
"default": false,
"description": "Controls download mode.",
"type": "boolean"
},
"threads": {
"default": 5,
"description": "Number of threads to use for downloading.",
"maximum": 5,
"minimum": 1,
"type": "integer"
}
},
"title": "QPlugins Downloader.",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 8add6a83394e52044a937228429f24573d59f63e | 2023-03-09T23:21:43 | docs/schemas/profile/qgis_plugin.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "A QGIS profile described in a JSON file.",
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/qgis_plugin.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"folder_name": {
"description": "Name of the plugins's directory once installed in QGIS. Useful when name does not complies with filename conventions.",
"pattern": "^([a-zA-Z]:)?(\\\\[^<>:\"/\\\\|?*]+)+\\\\?$",
"type": "string"
},
"location": {
"description": "Indicates if the plugin is located on a remote server or on local drive/network.",
"enum": [
"local",
"remote"
],
"type": "string"
},
"name": {
"description": "Plugin name, as referenced in the source plugins repository.",
"type": "string"
},
"official_repository": {
"description": "Indicates if the plugin is referenced on plugins.qgis.org",
"type": "boolean"
},
"plugin_id": {
"description": "Plugin ID as referenced into the repository (XML version). Typically for official repository: https://plugins.qgis.org/plugins/plugins.xml?qgis=3.22",
"type": "number"
},
"qgisMaximumVersion": {
"description": "Maximum QGIS version where the plugin can be installed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"qgisMinimumVersion": {
"description": "Minimum QGIS version where the plugin can be installed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"repository_url_xml": {
"description": "URL to the plugin repository file (XML).",
"type": "string"
},
"type": {
"deprecated": true,
"enum": [
"local",
"remote"
],
"type": "string"
},
"version": {
"description": "Plugin version to install.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 77367afb7a3558c87176c39466a15e43fbb895b5 | 2024-03-12T20:42:15 | docs/schemas/scenario/metadata.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://github.com/Guts/qgis-deployment-cli/raw/main/docs/schemas/scenario/metadata.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "QGIS Deployment Toolbelt - Scenario metadata",
"properties": {
"description": {
"description": "Short or long description of what this scenario does. Multilines accepted.",
"type": "string"
},
"id": {
"description": "Unique identifier of the job. Like the title but slugified and without special characters.",
"pattern": "^[_a-zA-Z][a-zA-Z0-9_-]*$",
"type": "string"
},
"title": {
"description": "The title of the job.",
"type": "string"
}
},
"required": [
"id",
"title"
],
"title": "Define scenario's metadata.",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 9f7ad4e4103ce7c775296a2c6c97652e2f3ddb21 | 2023-03-06T16:45:34 | docs/schemas/scenario/settings.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/settings.json",
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"description": "Define environment variables for the QGIS Deployment CLI execution, prefixing them with 'QDT_'. Attention, no confusion: these are the settings for the toolbelt, not for the QGIS installation.",
"properties": {
"DEBUG": {
"default": false,
"description": "Enable debug mode. Make the execution more verbose but quite slower too.",
"title": "Debug mode",
"type": "boolean"
},
"LOCAL_WORK_DIR": {
"default": null,
"description": "Where QDT stores locally everything it uses: profiles, plugins, etc.",
"title": "Local working folder.",
"type": [
"null",
"string"
]
},
"QGIS_EXE_PATH": {
"default": null,
"description": "QGIS executable to use for shortcuts and more.",
"properties": {
"linux": {
"description": "Path to QGIS on Linux.",
"examples": [
"/usr/bin/qgis"
],
"type": "string"
},
"mac": {
"description": "Path to QGIS on MacOS.",
"examples": [
"/usr/bin/qgis"
],
"type": "string"
},
"windows": {
"description": "Path to QGIS on Windows.",
"examples": [
"%PROGRAMFILES%/QGIS/3_22/bin/qgis-bin.exe"
],
"type": "string"
}
},
"title": "QGIS binary path.",
"type": "object"
},
"SCENARIO_VALIDATION": {
"default": false,
"description": "Enable scenario validation. This will check the scenario against the JSON schema.",
"title": "Scenario validation",
"type": "boolean"
}
},
"title": "QGIS Deployment Toolbelt - Environment variables",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | b9e9d5357a93ba58d759b493428baa61419d9d2c | 2024-02-22T15:47:10 | docs/schemas/scenario/jobs/shortcuts-manager.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://github.com/Guts/qgis-deployment-cli/raw/main/docs/schemas/scenario/jobs/shortcuts-manager.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "create shortcuts in desktop and/or start menu allowing the end-user opening QGIS with a profile.",
"properties": {
"action": {
"default": "create_or_restore",
"description": "Which action to perform with shortcuts.",
"enum": [
"create",
"create_or_restore",
"remove"
],
"type": "string"
},
"include": {
"description": "Name of the branch to use when working with a git repository.",
"items": {
"properties": {
"additional_arguments": {
"description": "Arguments to pass to QGIS executable.",
"example": "--noversioncheck",
"type": "string"
},
"desktop": {
"default": false,
"description": "If true, create a desktop shortcut.",
"type": "boolean"
},
"icon": {
"description": "Filename of the icon to use for the shortcut.",
"type": "string"
},
"label": {
"description": "Text to display on the shortcut.",
"type": "string"
},
"profile": {
"description": "Name of the profile to associate with the shortcut.",
"type": "string"
},
"qgis_path": {
"deprecated": true,
"description": "Which QGIS bin/exe to use for the shortcut.",
"type": "string"
},
"start_menu": {
"default": false,
"description": "If true, create a shortcut in start menu.",
"type": "boolean"
}
},
"required": [
"label",
"profile"
],
"type": "object"
},
"type": "array"
}
},
"title": "Shortcuts Manager.",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | f298c8e781bcda494ef288513d29d9d768300a76 | 2024-04-18T15:37:04 | docs/schemas/profile/qgis_profile.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "A QGIS profile described in a JSON file.",
"$id": "https://github.com/Guts/qgis-deployment-cli/raw/main/docs/schemas/profile/qgis_profile.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"alias": {
"description": "Profile's name in an human readable form, allowing special characters.",
"type": "string"
},
"author": {
"description": "Name of profile auhor and maintener.",
"type": "string"
},
"description": {
"description": "Profile description.",
"type": "string"
},
"email": {
"description": "Email of profile's auhor and maintener.",
"format": "email",
"maxLength": 127,
"minLength": 6,
"type": "string"
},
"folder_name": {
"description": "Name of the profile's directory in QGIS.",
"type": "string"
},
"icon": {
"description": "Relative path to the icon used for shortcuts.",
"type": "string"
},
"name": {
"description": "Profile name without any special characters.",
"type": "string"
},
"plugins": {
"description": "Plugins installed with the profile.",
"items": {
"$ref": "qgis_plugin.json"
},
"title": "QGIS Plugins",
"type": "array"
},
"qgisMaximumVersion": {
"description": "Maximum QGIS version where the profile can be deployed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"qgisMinimumVersion": {
"description": "Minimum QGIS version where the profile can be deployed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"rules": {
"description": "Logical rules based on contextual elements that condition profile deployment.",
"items": {
"$ref": "rules.json"
},
"title": "QGIS Plugins",
"type": "array"
},
"splash": {
"description": "Relative path to the splash image.",
"type": "string"
},
"version": {
"description": "Profile version. Must complies with SemVer.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"required": [
"author",
"email",
"name",
"version"
],
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 29a593b8e0c4a5a03b38d1882e54f2933c9e27fa | 2024-02-22T15:41:50 | docs/schemas/scenario/jobs/qprofiles-synchronizer.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/main/docs/schemas/scenario/jobs/qprofiles-synchronizer.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"if": {
"properties": {
"protocol": {
"const": "git"
}
}
},
"then": {
"required": [
"branch"
]
}
}
],
"description": "Synchronizes installed profiles (in QGIS profiles folder) from downloaded ones in QDT working folder.",
"properties": {
"sync_mode": {
"description": "Synchronization mode to apply with profiles.",
"enum": [
"only_different_version",
"only_missing",
"only_new_version",
"overwrite"
],
"type": "string"
}
},
"title": "QProfiles Synchronizer",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 435e055ad3833f2fed0d264e7749b200e303e604 | 2024-03-27T08:14:06 | docs/schemas/profile/qgis_plugin.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "A QGIS plugin described in a JSON file.",
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/main/docs/schemas/profile/qgis_plugin.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"folder_name": {
"description": "Name of the plugins's directory once installed in QGIS. Useful when name does not complies with filename conventions.",
"type": "string"
},
"location": {
"description": "Indicates if the plugin is located on a remote server or on local drive/network.",
"enum": [
"local",
"remote"
],
"type": "string"
},
"name": {
"description": "Plugin name, as referenced in the source plugins repository.",
"type": "string"
},
"official_repository": {
"description": "Indicates if the plugin is referenced on plugins.qgis.org",
"type": "boolean"
},
"plugin_id": {
"description": "Plugin ID as referenced into the repository (XML version). Typically for official repository: https://plugins.qgis.org/plugins/plugins.xml?qgis=3.22",
"type": "number"
},
"qgisMaximumVersion": {
"description": "Maximum QGIS version where the plugin can be installed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"qgisMinimumVersion": {
"description": "Minimum QGIS version where the plugin can be installed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"repository_url_xml": {
"description": "URL to the plugin repository file (XML).",
"examples": [
"https://oslandia.gitlab.io/qgis/ngp-connect/plugins.xml"
],
"type": "string"
},
"url": {
"description": "Direct URI (URL or local path) to download the plugin archive (.zip).",
"examples": [
"https: //plugins.qgis.org/plugins/QuickOSM/version/2.2.2/download/",
"/home/jmo/Git/Oslandia/QGIS/stsi-plugin-qgis-geocoder-locator-filter/stsi_locator_filter.1.0.0.zip"
],
"format": "uri",
"type": "string"
},
"version": {
"description": "Version of the plugin to be installed.",
"maxLength": 14,
"minLength": 5,
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 435e055ad3833f2fed0d264e7749b200e303e604 | 2024-03-27T08:14:06 | docs/schemas/profile/qgis_profile.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "A QGIS profile described in a JSON file.",
"$id": "https://github.com/Guts/qgis-deployment-cli/raw/main/docs/schemas/profile/qgis_profile.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"alias": {
"description": "Profile's name in an human readable form, allowing special characters.",
"type": "string"
},
"author": {
"description": "Name of profile auhor and maintener.",
"type": "string"
},
"description": {
"description": "Profile description.",
"type": "string"
},
"email": {
"description": "Email of profile's auhor and maintener.",
"format": "email",
"maxLength": 127,
"minLength": 6,
"type": "string"
},
"folder_name": {
"description": "Name of the profile's directory in QGIS.",
"type": "string"
},
"icon": {
"description": "Relative path to the icon used for shortcuts.",
"type": "string"
},
"name": {
"description": "Profile name without any special characters.",
"type": "string"
},
"plugins": {
"description": "Plugins installed with the profile.",
"items": {
"$ref": "qgis_plugin.json"
},
"title": "QGIS Plugins",
"type": "array"
},
"qgisMaximumVersion": {
"description": "Maximum QGIS version where the profile can be deployed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"qgisMinimumVersion": {
"description": "Minimum QGIS version where the profile can be deployed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"splash": {
"description": "Relative path to the splash image.",
"type": "string"
},
"version": {
"description": "Profile version. Must complies with SemVer.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"required": [
"author",
"email",
"name",
"version"
],
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 94be5ff4815b7e08f9386bbb5a2b1beb300c9863 | 2023-02-03T16:58:55 | docs/schemas/scenario/jobs/manage-env-vars.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/jobs/manage-env-vars.json",
"$schema": "https://json-schema.org/draft-07/schema",
"description": "Job in charge of setting/updating/removing environment variables no the target computer.",
"items": {
"type": "object"
},
"title": "Manage environment variables.",
"type": "array"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 9fead974613303e098ac48110ca0a2b2a2cce648 | 2023-02-03T18:40:10 | docs/schemas/profile/qgis_plugin.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$comment": "A QGIS profile described in a JSON file.",
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/qgis_plugin.json",
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"location": {
"description": "Indicates if the plugin is located on a remote server or on local drive/network.",
"enum": [
"local",
"remote"
],
"type": "string"
},
"name": {
"description": "Plugin name, as referenced in the source plugins repository.",
"type": "string"
},
"official_repository": {
"description": "Indicates if the plugin is referenced on plugins.qgis.org",
"type": "boolean"
},
"plugin_id": {
"description": "Plugin ID as referenced into the repository (XML version). Typically for official repository: https://plugins.qgis.org/plugins/plugins.xml?qgis=3.22",
"type": "number"
},
"qgisMaximumVersion": {
"description": "Maximum QGIS version where the plugin can be installed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"qgisMinimumVersion": {
"description": "Minimum QGIS version where the plugin can be installed.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"repository_url_xml": {
"description": "URL to the plugin repository file (XML).",
"type": "string"
},
"type": {
"deprecated": true,
"enum": [
"local",
"remote"
],
"type": "string"
},
"version": {
"description": "Plugin version to install.",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 7320301863c074dcd3769743bb80aae8e0e2427b | 2023-03-09T10:13:21 | docs/schemas/scenario/jobs/qplugins-synchronizer.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/jobs/qplugins-synchronizer.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "synchronize plugins between those stored locally (typically downloaded by the Plugins Downloader job) and the installed plugins.",
"properties": {
"action": {
"default": "create_or_restore",
"description": "Tell the job what to do with plugins in installed profiles.",
"enum": [
"create",
"create_or_restore",
"remove"
],
"type": "string"
},
"profile_ref": {
"default": "installed",
"description": "Which `profile.json` file to use as reference.",
"enum": [
"downloaded",
"installed"
],
"type": "string"
},
"source": {
"description": "Where to find plugins zip files.",
"type": "string"
}
},
"title": "QPlugins Synchronizer.",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 1acc7118aed08c5b6388ce7f5770de876b465cce | 2023-07-11T08:17:07 | docs/schemas/scenario/jobs/manage-env-vars.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/jobs/manage-env-vars.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Job in charge of setting/updating/removing environment variables on target computer.",
"items": {
"allOf": [
{
"if": {
"properties": {
"action": {
"const": "add"
}
},
"type": "object"
},
"then": {
"required": [
"value"
]
}
}
],
"properties": {
"action": {
"default": "add",
"description": "Tell the job what to do with the environment variable.",
"enum": [
"add",
"remove"
],
"type": "string"
},
"name": {
"description": "Name of the environment variable.",
"type": "string"
},
"scope": {
"default": "user",
"description": "Level of the environment variable.",
"enum": [
"user",
"system"
],
"type": "string"
},
"value": {
"description": "Value to set to the environment variable.",
"type": [
"boolean",
"string"
]
},
"value_type": {
"description": "Value type to avoid ambiguity when interpreting it.",
"enum": [
"bool",
"path",
"str",
"url"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"title": "Environment variables manager.",
"type": "array"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 77367afb7a3558c87176c39466a15e43fbb895b5 | 2024-03-12T20:42:15 | docs/schemas/scenario/jobs/qprofiles-synchronizer.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/main/docs/schemas/scenario/jobs/qprofiles-synchronizer.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Synchronizes installed profiles (in QGIS profiles folder) from downloaded ones in QDT working folder.",
"properties": {
"sync_mode": {
"description": "Synchronization mode to apply with profiles.",
"enum": [
"only_different_version",
"only_missing",
"only_new_version",
"overwrite"
],
"type": "string"
}
},
"title": "QProfiles Synchronizer",
"type": "object"
} | Apache-2.0 | en |
Guts/qgis-deployment-cli | 8d592a1c63cb110065b1e0a754380743825ff2e3 | 2023-03-09T10:06:20 | docs/schemas/scenario/jobs/manage-env-vars.json | 13 | 2024-05-28T04:42:54.58367Z | {
"$id": "https://raw.githubusercontent.com/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/jobs/manage-env-vars.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Job in charge of setting/updating/removing environment variables on target computer.",
"items": {
"allOf": [
{
"if": {
"properties": {
"action": {
"const": "add"
}
},
"type": "object"
},
"then": {
"required": [
"value"
]
}
}
],
"properties": {
"action": {
"default": "add",
"description": "Tell the job what to do with the environment variable.",
"enum": [
"add",
"remove"
],
"type": "string"
},
"name": {
"description": "Name of the environment variable.",
"type": "string"
},
"scope": {
"default": "user",
"description": "Level of the environment variable.",
"enum": [
"user",
"system"
],
"type": "string"
},
"value": {
"description": "Value to set to the environment variable.",
"type": [
"boolean",
"string"
]
}
},
"required": [
"name"
],
"type": "object"
},
"title": "Environment variables manager.",
"type": "array"
} | Apache-2.0 | en |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.