schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
renovate-schema.json
userStrings
User-facing strings for the Renovate comment when a PR is closed.
{"type": "object", "default": {"ignoreTopic": "Renovate Ignore Notification", "ignoreMajor": "Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for *any* future {{{newMajor}}}.x releases. But if you manually upgrade to {{{newMajor}}}.x then Renovate will re-enable `minor` and `patch` updates automatically.", "ignoreDigest": "Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for the `{{{depName}}}` `{{{newDigestShort}}}` update again.", "ignoreOther": "Because you closed this PR without merging, Renovate will ignore this update ({{{newValue}}}). You will get a PR once a newer version is released. To ignore this dependency forever, add it to the `ignoreDeps` array of your Renovate config."}}
renovate-schema.json
username
Username for authentication.
{"type": "string"}
renovate-schema.json
velaci
Configuration object for the velaci manager
{"type": "object", "default": {"fileMatch": ["(^|/)\\.vela\\.ya?ml$"]}}
renovate-schema.json
versioning
Versioning to use for filtering and comparisons.
{"type": "string", "oneOf": [{"enum": ["aws-machine-image", "azure-rest-api", "bazel-module", "cargo", "composer", "conan", "deb", "debian", "docker", "git", "go-mod-directive", "gradle", "hashicorp", "helm", "hermit", "hex", "ivy", "kubernetes-api", "loose", "maven", "nixpkgs", "node", "npm", "nuget", "pep440", "perl", "poetry", "python", "redhat", "regex", "rez", "ruby", "semver", "semver-coerced", "swift", "ubuntu"]}, {"type": "string", "pattern": "^regex:"}]}
renovate-schema.json
vulnerabilityAlerts
Config to apply when a PR is needed due to a vulnerability in the existing package version.
{"type": "object", "default": {"groupName": null, "schedule": [], "dependencyDashboardApproval": false, "minimumReleaseAge": null, "rangeStrategy": "update-lockfile", "commitMessageSuffix": "[SECURITY]", "branchTopic": "{{{datasource}}}-{{{depName}}}-vulnerability", "prCreation": "immediate"}}
renovate-schema.json
woodpecker
Configuration object for the woodpecker manager
{"type": "object", "default": {"fileMatch": ["^\\.woodpecker(?:/[^/]+)?\\.ya?ml$"]}}
renovate-schema.json
writeDiscoveredRepos
Writes discovered repositories to a JSON file and then exit.
{"type": "string"}
esmrc.json
cjs
A boolean or object for toggling CJS features in ESM
{"default": true, "oneOf": [{"type": "boolean", "default": true}, {"type": "object", "properties": {"cache": {"type": "boolean", "default": true}, "esModule": {"type": "boolean", "default": true}, "extensions": {"type": "boolean", "default": true}, "mutableNamespace": {"type": "boolean", "default": true}, "namedExports": {"type": "boolean", "default": true}, "paths": {"type": "boolean", "default": true}, "vars": {"type": "boolean", "default": true}, "dedefault": {"type": "boolean", "default": false}, "topLevelReturn": {"type": "boolean", "default": false}}}]}
esmrc.json
cache
A boolean for storing ES modules in require.cache
{"type": "boolean", "default": true}
esmrc.json
esModule
A boolean for __esModule interoperability
{"type": "boolean", "default": true}
esmrc.json
extensions
A boolean for respecting require.extensions in ESM
{"type": "boolean", "default": true}
esmrc.json
mutableNamespace
A boolean for importing named exports of CJS modules
{"type": "boolean", "default": true}
esmrc.json
namedExports
A boolean for importing named exports of CJS modules
{"type": "boolean", "default": true}
esmrc.json
paths
A boolean for following CJS path rules in ESM
{"type": "boolean", "default": true}
esmrc.json
vars
A boolean for __dirname, __filename, and require in ESM
{"type": "boolean", "default": true}
esmrc.json
dedefault
A boolean for requiring ES modules without the dangling require().default
{"type": "boolean", "default": false}
esmrc.json
topLevelReturn
A boolean for top-level return support
{"type": "boolean", "default": false}
esmrc.json
mainFields
An array of fields checked when importing a package
{"type": "array", "default": ["main"], "uniqueItems": true, "items": {"type": "string"}}
esmrc.json
items
Fields from package.json
{"type": "string"}
esmrc.json
mode
A string describing the mode in which to detect ESM module files
{"type": "string", "default": "auto", "oneOf": [{"const": "auto"}, {"const": "all"}, {"const": "strict"}]}
esmrc.json
mode
'auto' detect files with import, import.meta, export, 'use module', or .mjs as ESM
{"const": "auto"}
esmrc.json
mode
'all' files besides those with 'use script' or .cjs are treated as ESM
{"const": "all"}
esmrc.json
mode
'strict to treat only .mjs files as ESM
{"const": "strict"}
esmrc.json
await
A boolean for top-level await in modules without ESM exports. (Node 10+)
{"type": "boolean", "default": false}
esmrc.json
force
A boolean to apply these options to all module loads
{"type": "boolean", "default": false}
esmrc.json
wasm
A boolean for WebAssembly module support. (Node 8+)
{"type": "boolean", "default": false}
esmrc.json
cache
[dev] A boolean for toggling cache creation or a cache directory path
{"type": "boolean", "default": true}
esmrc.json
sourceMap
[dev] A boolean for including inline source maps
{"type": "boolean", "default": false}
devspace-schema.json
Config defines the configuration
{"$schema": "http://json-schema.org/draft/2020-12/schema", "$defs": {"Attach": {"properties": {"enabled": {"type": "boolean"}, "disableReplace": {"type": "boolean"}, "disableTTY": {"type": "boolean"}}, "type": "object"}, "BandwidthLimits": {"properties": {"download": {"type": "integer"}, "upload": {"type": "integer"}}, "type": "object"}, "BuildKitConfig": {"properties": {"inCluster": {}, "preferMinikube": {"type": "boolean"}, "args": {"items": {"type": "string"}, "type": "array"}, "command": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "BuildKitInClusterConfig": {"properties": {"name": {"type": "string"}, "namespace": {"type": "string"}, "rootless": {"type": "boolean"}, "image": {"type": "string"}, "nodeSelector": {"type": "string"}, "noCreate": {"type": "boolean"}, "noRecreate": {"type": "boolean"}, "noLoad": {"type": "boolean"}, "createArgs": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "ChartConfig": {"properties": {"name": {"type": "string", "group": "repo", "group_name": "Source: Helm Repository"}, "version": {"type": "string", "group": "repo"}, "repo": {"type": "string", "group": "repo"}, "username": {"type": "string", "group": "repo"}, "password": {"type": "string", "group": "repo"}, "path": {"type": "string", "group": "path", "group_name": "Source: Local Filesystem"}, "git": {"type": "string", "group": "git", "group_name": "Source: Git Repository"}, "subPath": {"type": "string", "group": "git"}, "branch": {"type": "string", "group": "git"}, "tag": {"type": "string", "group": "git"}, "revision": {"type": "string", "group": "git"}, "cloneArgs": {"items": {"type": "string"}, "type": "array", "group": "git"}, "disableShallow": {"type": "boolean", "group": "git"}, "disablePull": {"type": "boolean", "group": "git"}}, "type": "object"}, "CommandConfig": {"properties": {"name": {"type": "string"}, "section": {"type": "string"}, "command": {"type": "string"}, "args": {"items": {"type": "string"}, "type": "array"}, "appendArgs": {"type": "boolean"}, "internal": {"type": "boolean"}, "after": {"type": "string"}}, "type": "object", "required": ["command"]}, "CustomConfig": {"properties": {"command": {"type": "string"}, "onChange": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "DependencyConfig": {"properties": {"name": {"type": "string"}, "disabled": {"type": "boolean"}, "path": {"type": "string", "group": "path", "group_name": "Source: Local Filesystem"}, "git": {"type": "string", "group": "git", "group_name": "Source: Git Repository"}, "subPath": {"type": "string", "group": "git"}, "branch": {"type": "string", "group": "git"}, "tag": {"type": "string", "group": "git"}, "revision": {"type": "string", "group": "git"}, "cloneArgs": {"items": {"type": "string"}, "type": "array", "group": "git"}, "disableShallow": {"type": "boolean", "group": "git"}, "disablePull": {"type": "boolean", "group": "git"}, "pipeline": {"type": "string", "default": "deploy", "group": "execution", "group_name": "Execution"}, "vars": {"patternProperties": {".*": {"type": "string"}}, "type": "object", "group": "execution"}, "overwriteVars": {"type": "boolean", "group": "execution"}, "ignoreDependencies": {"type": "boolean", "group": "execution"}, "namespace": {"type": "string", "group": "execution"}}, "type": "object"}, "DeploymentConfig": {"properties": {"name": {"type": "string"}, "helm": {}, "kubectl": {}, "updateImageTags": {"type": "boolean"}, "namespace": {"type": "string"}}, "type": "object"}, "DevContainer": {"properties": {"container": {"type": "string", "group": "selector", "group_name": "Selector"}, "arch": {"type": "string", "group": "selector"}, "devImage": {"type": "string", "group": "modifications", "group_name": "Modifications"}, "command": {"items": {"type": "string"}, "type": "array", "group": "modifications"}, "args": {"items": {"type": "string"}, "type": "array", "group": "modifications"}, "workingDir": {"type": "string", "group": "modifications"}, "env": {"items": {}, "type": "array", "group": "modifications"}, "resources": {"group": "modifications"}, "reversePorts": {"items": {}, "type": "array", "group": "ports", "group_name": "Port Forwarding"}, "sync": {"items": {}, "type": "array", "group": "sync", "group_name": "File Sync"}, "persistPaths": {"items": {}, "type": "array"}, "terminal": {"group": "workflows", "group_name": "Foreground Dev Workflows"}, "logs": {"group": "workflows"}, "attach": {"group": "workflows"}, "ssh": {}, "proxyCommands": {"items": {}, "type": "array", "group": "workflows_background"}, "restartHelper": {"group": "workflows_background"}}, "type": "object"}, "DevPod": {"properties": {"name": {"type": "string"}, "imageSelector": {"type": "string", "group": "selector"}, "labelSelector": {"patternProperties": {".*": {"type": "string"}}, "type": "object", "group": "selector"}, "namespace": {"type": "string", "group": "selector"}, "container": {"type": "string", "group": "selector", "group_name": "Selector"}, "arch": {"type": "string", "group": "selector"}, "devImage": {"type": "string", "group": "modifications", "group_name": "Modifications"}, "command": {"items": {"type": "string"}, "type": "array", "group": "modifications"}, "args": {"items": {"type": "string"}, "type": "array", "group": "modifications"}, "workingDir": {"type": "string", "group": "modifications"}, "env": {"items": {}, "type": "array", "group": "modifications"}, "resources": {"group": "modifications"}, "reversePorts": {"items": {}, "type": "array", "group": "ports", "group_name": "Port Forwarding"}, "sync": {"items": {}, "type": "array", "group": "sync", "group_name": "File Sync"}, "persistPaths": {"items": {}, "type": "array"}, "terminal": {"group": "workflows", "group_name": "Foreground Dev Workflows"}, "logs": {"group": "workflows"}, "attach": {"group": "workflows"}, "ssh": {}, "proxyCommands": {"items": {}, "type": "array", "group": "workflows_background"}, "restartHelper": {"group": "workflows_background"}, "ports": {"items": {}, "type": "array", "group": "ports"}, "persistenceOptions": {"group": "modifications"}, "patches": {"items": {}, "type": "array", "group": "modifications"}, "open": {"items": {}, "type": "array", "group": "workflows_background", "group_name": "Background Dev Workflows"}, "containers": {"patternProperties": {".*": {}}, "type": "object", "group": "selector"}}, "type": "object"}, "DockerConfig": {"properties": {"disableFallback": {"type": "boolean"}, "preferMinikube": {"type": "boolean"}, "useCli": {"type": "boolean"}, "args": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "EnvVar": {"properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "type": "object", "required": ["name", "value"]}, "HelmConfig": {"properties": {"releaseName": {"type": "string"}, "chart": {}, "values": {"type": "object"}, "valuesFiles": {"items": {"type": "string"}, "type": "array"}, "displayOutput": {"type": "boolean"}, "upgradeArgs": {"items": {"type": "string"}, "type": "array"}, "templateArgs": {"items": {"type": "string"}, "type": "array"}, "disableDependencyUpdate": {"type": "boolean"}}, "type": "object"}, "Image": {"properties": {"name": {"type": "string"}, "image": {"type": "string"}, "tags": {"items": {"type": "string"}, "type": "array"}, "dockerfile": {"type": "string", "default": "./Dockerfile", "group": "buildConfig"}, "context": {"type": "string", "default": "./", "group": "buildConfig"}, "entrypoint": {"items": {"type": "string"}, "type": "array", "group": "overwrites", "group_name": "In-Memory Overwrites"}, "cmd": {"items": {"type": "string"}, "type": "array", "group": "overwrites"}, "appendDockerfileInstructions": {"items": {"type": "string"}, "type": "array", "group": "overwrites"}, "buildArgs": {"patternProperties": {".*": {"type": "string"}}, "type": "object", "group": "buildConfig", "group_name": "Build Configuration"}, "target": {"type": "string", "group": "buildConfig"}, "network": {"type": "string", "group": "buildConfig"}, "rebuildStrategy": {"type": "string", "enum": ["default", "always", "ignoreContextChanges"], "group": "buildConfig"}, "skipPush": {"type": "boolean", "group": "pushPull", "group_name": "Push & Pull"}, "createPullSecret": {"type": "boolean", "group": "pushPull"}, "buildKit": {"group": "engines", "group_name": "Build Engines"}, "docker": {"group": "engines"}, "kaniko": {"group": "engines"}, "custom": {"group": "engines"}}, "type": "object", "required": ["image"]}, "Import": {"properties": {"enabled": {"type": "boolean"}, "path": {"type": "string", "group": "path", "group_name": "Source: Local Filesystem"}, "git": {"type": "string", "group": "git", "group_name": "Source: Git Repository"}, "subPath": {"type": "string", "group": "git"}, "branch": {"type": "string", "group": "git"}, "tag": {"type": "string", "group": "git"}, "revision": {"type": "string", "group": "git"}, "cloneArgs": {"items": {"type": "string"}, "type": "array", "group": "git"}, "disableShallow": {"type": "boolean", "group": "git"}, "disablePull": {"type": "boolean", "group": "git"}}, "type": "object"}, "KanikoAdditionalMount": {"properties": {"secret": {}, "configMap": {}, "readOnly": {"type": "boolean"}, "mountPath": {"type": "string"}, "subPath": {"type": "string"}}, "type": "object"}, "KanikoAdditionalMountConfigMap": {"properties": {"name": {"type": "string"}, "items": {"items": {}, "type": "array"}, "defaultMode": {"type": "integer"}}, "type": "object"}, "KanikoAdditionalMountKeyToPath": {"properties": {"key": {"type": "string"}, "path": {"type": "string"}, "mode": {"type": "integer"}}, "type": "object", "required": ["key", "path"]}, "KanikoAdditionalMountSecret": {"properties": {"name": {"type": "string"}, "items": {"items": {}, "type": "array"}, "defaultMode": {"type": "integer"}}, "type": "object", "required": ["name"]}, "KanikoConfig": {"properties": {"cache": {"type": "boolean"}, "snapshotMode": {"type": "string"}, "image": {"type": "string"}, "initImage": {"type": "string"}, "args": {"items": {"type": "string"}, "type": "array"}, "command": {"items": {"type": "string"}, "type": "array"}, "namespace": {"type": "string"}, "insecure": {"type": "boolean"}, "pullSecret": {"type": "string"}, "skipPullSecretMount": {"type": "boolean"}, "nodeSelector": {"patternProperties": {".*": {"type": "string"}}, "type": "object"}, "tolerations": {"items": {}, "type": "array"}, "serviceAccount": {"type": "string"}, "generateName": {"type": "string"}, "annotations": {"patternProperties": {".*": {"type": "string"}}, "type": "object"}, "labels": {"patternProperties": {".*": {"type": "string"}}, "type": "object"}, "initEnv": {"patternProperties": {".*": {"type": "string"}}, "type": "object"}, "env": {"patternProperties": {".*": {"type": "string"}}, "type": "object"}, "envFrom": {"patternProperties": {".*": {"type": "object"}}, "type": "object"}, "additionalMounts": {"items": {}, "type": "array"}, "resources": {}}, "type": "object"}, "KubectlConfig": {"properties": {"manifests": {"items": {"type": "string"}, "type": "array"}, "applyArgs": {"items": {"type": "string"}, "type": "array"}, "createArgs": {"items": {"type": "string"}, "type": "array"}, "kubectlBinaryPath": {"type": "string"}, "inlineManifest": {"type": "string"}, "kustomize": {"type": "boolean", "group": "kustomize", "group_name": "Kustomize"}, "kustomizeArgs": {"items": {"type": "string"}, "type": "array", "group": "kustomize"}, "kustomizeBinaryPath": {"type": "string", "group": "kustomize"}, "patches": {"items": {}, "type": "array", "group": "modifications"}}, "type": "object"}, "LocalRegistryConfig": {"properties": {"enabled": {"type": "boolean"}, "localbuild": {"type": "boolean"}, "namespace": {"type": "string"}, "name": {"type": "string"}, "image": {"type": "string"}, "buildKitImage": {"type": "string"}, "port": {"type": "integer"}, "persistence": {}}, "type": "object"}, "LocalRegistryPersistence": {"properties": {"enabled": {"type": "boolean"}, "size": {"type": "string"}, "storageClassName": {"type": "string"}}, "type": "object"}, "Logs": {"properties": {"enabled": {"type": "boolean"}, "lastLines": {"type": "integer"}}, "type": "object"}, "OpenConfig": {"properties": {"url": {"type": "string"}}, "type": "object"}, "PatchConfig": {"properties": {"op": {"type": "string"}, "path": {"type": "string"}, "value": {}}, "type": "object", "required": ["op", "path"]}, "PatchTarget": {"properties": {"target": {}, "op": {"type": "string"}, "path": {"type": "string"}, "value": {}}, "type": "object", "required": ["target", "op", "path"]}, "PersistenceOptions": {"properties": {"size": {"type": "string"}, "storageClassName": {"type": "string"}, "accessModes": {"items": {"type": "string"}, "type": "array"}, "readOnly": {"type": "boolean"}, "name": {"type": "string"}}, "type": "object"}, "PersistentPath": {"properties": {"path": {"type": "string"}, "volumePath": {"type": "string"}, "readOnly": {"type": "boolean"}, "skipPopulate": {"type": "boolean"}, "initContainer": {}}, "type": "object"}, "PersistentPathInitContainer": {"properties": {"resources": {}}, "type": "object"}, "Pipeline": {"properties": {"name": {"type": "string", "enum": ["dev", "deploy", "build", "purge", ".*"]}, "run": {"type": "string"}, "flags": {"items": {}, "type": "array"}, "continueOnError": {"type": "boolean"}}, "type": "object"}, "PipelineFlag": {"properties": {"name": {"type": "string"}, "short": {"type": "string"}, "type": {"type": "string", "enum": ["bool", "int", "string", "stringArray"]}, "default": {}}, "type": "object"}, "PodResources": {"properties": {"requests": {"patternProperties": {".*": {"type": "string"}}, "type": "object"}, "limits": {"patternProperties": {".*": {"type": "string"}}, "type": "object"}}, "type": "object"}, "PortMapping": {"properties": {"port": {"type": "string"}, "bindAddress": {"type": "string"}}, "type": "object", "required": ["port"]}, "ProxyCommand": {"properties": {"gitCredentials": {"type": "boolean"}, "command": {"type": "string"}, "localCommand": {"type": "string"}, "skipContainerEnv": {"type": "boolean"}, "env": {"patternProperties": {".*": {"type": "string"}}, "type": "object"}}, "type": "object"}, "PullSecretConfig": {"properties": {"name": {"type": "string"}, "registry": {"type": "string"}, "username": {"type": "string"}, "password": {"type": "string"}, "email": {"type": "string"}, "secret": {"type": "string"}, "serviceAccounts": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "RequireCommand": {"properties": {"name": {"type": "string"}, "versionArgs": {"items": {"type": "string"}, "type": "array"}, "versionRegEx": {"type": "string"}, "version": {"type": "string"}}, "type": "object", "required": ["name"]}, "RequireConfig": {"properties": {"devspace": {"type": "string"}, "commands": {"items": {}, "type": "array"}, "plugins": {"items": {}, "type": "array"}}, "type": "object"}, "RequirePlugin": {"properties": {"name": {"type": "string"}, "version": {"type": "string"}}, "type": "object", "required": ["name", "version"]}, "RestartHelper": {"properties": {"path": {"type": "string"}, "inject": {"type": "boolean"}}, "type": "object"}, "SSH": {"properties": {"enabled": {"type": "boolean"}, "localHostname": {"type": "string"}, "localPort": {"type": "integer"}, "remoteAddress": {"type": "string"}, "useInclude": {"type": "boolean"}}, "type": "object"}, "SyncConfig": {"properties": {"path": {"type": "string"}, "excludePaths": {"items": {"type": "string"}, "type": "array", "group": "exclude", "group_name": "Exclude Paths From File Sync"}, "excludeFile": {"type": "string", "group": "exclude"}, "downloadExcludePaths": {"items": {"type": "string"}, "type": "array", "group": "exclude"}, "downloadExcludeFile": {"type": "string", "group": "exclude"}, "uploadExcludePaths": {"items": {"type": "string"}, "type": "array", "group": "exclude"}, "uploadExcludeFile": {"type": "string", "group": "exclude"}, "startContainer": {"type": "boolean", "group": "actions", "group_name": "Sync-Triggered Actions"}, "onUpload": {"group": "actions"}, "initialSync": {"type": "string", "group": "initial_sync", "group_name": "Initial Sync"}, "waitInitialSync": {"type": "boolean", "group": "initial_sync"}, "initialSyncCompareBy": {"type": "string", "group": "initial_sync"}, "disableDownload": {"type": "boolean", "group": "one_direction", "group_name": "One-Directional Sync"}, "disableUpload": {"type": "boolean", "group": "one_direction"}, "bandwidthLimits": {}, "polling": {"type": "boolean"}, "noWatch": {"type": "boolean"}, "file": {"type": "boolean"}}, "type": "object"}, "SyncExec": {"properties": {"name": {"type": "string"}, "command": {"type": "string"}, "args": {"items": {"type": "string"}, "type": "array"}, "failOnError": {"type": "boolean"}, "local": {"type": "boolean"}, "once": {"type": "boolean"}, "onChange": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "SyncOnUpload": {"properties": {"restartContainer": {"type": "boolean"}, "exec": {"items": {}, "type": "array"}}, "type": "object"}, "Target": {"properties": {"apiVersion": {"type": "string"}, "kind": {"type": "string"}, "name": {"type": "string"}}, "type": "object", "required": ["apiVersion", "kind", "name"]}, "Terminal": {"properties": {"command": {"type": "string"}, "workDir": {"type": "string"}, "enabled": {"type": "boolean"}, "disableReplace": {"type": "boolean"}, "disableScreen": {"type": "boolean"}, "disableTTY": {"type": "boolean"}}, "type": "object"}, "Toleration": {"properties": {"Key": {"type": "string"}, "Operator": {"type": "string"}, "Value": {"type": "string"}, "Effect": {"type": "string"}, "TolerationSeconds": {"type": "integer"}}, "type": "object", "required": ["Key", "Operator", "Value", "Effect", "TolerationSeconds"]}, "Variable": {"properties": {"name": {"type": "string"}, "value": {"oneOf": [{"type": "string"}, {"type": "integer"}, {"type": "boolean"}], "group": "static", "group_name": "Static Value"}, "question": {"type": "string", "group": "question", "group_name": "Value From Input (Question)"}, "default": {"oneOf": [{"type": "string"}, {"type": "integer"}, {"type": "boolean"}], "group": "question"}, "options": {"items": {"type": "string"}, "type": "array", "group": "question"}, "password": {"type": "boolean", "group": "question"}, "validationPattern": {"type": "string", "group": "question"}, "validationMessage": {"type": "string", "group": "question"}, "noCache": {"type": "boolean", "group": "question"}, "command": {"type": "string", "group": "execution", "group_name": "Value From Command"}, "args": {"items": {"type": "string"}, "type": "array", "group": "execution"}, "commands": {"items": {}, "type": "array", "group": "execution"}, "alwaysResolve": {"type": "boolean"}, "source": {"type": "string", "enum": ["all", "env", "input", "command", "none"]}}, "type": "object"}, "VariableCommand": {"properties": {"os": {"type": "string"}, "command": {"type": "string"}, "args": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}}, "properties": {"version": {"type": "string"}, "name": {"type": "string"}, "imports": {"items": {}, "type": "array"}, "functions": {"patternProperties": {".*": {"type": "string"}}, "type": "object"}, "pipelines": {"anyOf": [{"patternProperties": {".*": {"type": "string"}}, "type": "object"}, {"patternProperties": {".*": {}}, "type": "object"}, {"type": "object"}], "type": "object"}, "images": {"patternProperties": {".*": {}}, "type": "object"}, "deployments": {"patternProperties": {".*": {}}, "type": "object"}, "dev": {"patternProperties": {".*": {}}, "type": "object"}, "vars": {"anyOf": [{"patternProperties": {".*": {"type": "string"}}, "type": "object"}, {"patternProperties": {".*": {}}, "type": "object"}, {"type": "object"}], "type": "object"}, "commands": {"anyOf": [{"patternProperties": {".*": {"type": "string"}}, "type": "object"}, {"patternProperties": {".*": {}}, "type": "object"}, {"type": "object"}], "type": "object"}, "dependencies": {"patternProperties": {".*": {}}, "type": "object"}, "pullSecrets": {"patternProperties": {".*": {}}, "type": "object"}, "require": {}, "localRegistry": {}}, "type": "object", "required": ["version", "name"]}
devspace-schema.json
enabled
Enabled can be used to enable attaching to a container
{"type": "boolean"}
devspace-schema.json
disableReplace
DisableReplace prevents DevSpace from actually replacing the pod with modifications so that the pod starts up correctly.
{"type": "boolean"}
devspace-schema.json
disableTTY
DisableTTY is used to tell DevSpace to not use a TTY connection for attaching
{"type": "boolean"}
devspace-schema.json
BandwidthLimits
BandwidthLimits defines the struct for specifying the sync bandwidth limits
{"properties": {"download": {"type": "integer"}, "upload": {"type": "integer"}}, "type": "object"}
devspace-schema.json
download
Download is the download limit in kilo bytes per second
{"type": "integer"}
devspace-schema.json
upload
Upload is the upload limit in kilo bytes per second
{"type": "integer"}
devspace-schema.json
BuildKitConfig
BuildKitConfig tells the DevSpace CLI to
{"properties": {"inCluster": {}, "preferMinikube": {"type": "boolean"}, "args": {"items": {"type": "string"}, "type": "array"}, "command": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}
devspace-schema.json
inCluster
InCluster if specified, DevSpace will use BuildKit to build the image within the cluster
{}
devspace-schema.json
preferMinikube
PreferMinikube if false, will not try to use the minikube docker daemon to build the image
{"type": "boolean"}
devspace-schema.json
args
Args are additional arguments to call docker buildx build with
{"items": {"type": "string"}, "type": "array"}
devspace-schema.json
command
Command to override the base command to create a builder and build images. Defaults to ["docker", "buildx"]
{"items": {"type": "string"}, "type": "array"}
devspace-schema.json
BuildKitInClusterConfig
BuildKitInClusterConfig holds the buildkit builder config
{"properties": {"name": {"type": "string"}, "namespace": {"type": "string"}, "rootless": {"type": "boolean"}, "image": {"type": "string"}, "nodeSelector": {"type": "string"}, "noCreate": {"type": "boolean"}, "noRecreate": {"type": "boolean"}, "noLoad": {"type": "boolean"}, "createArgs": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}
devspace-schema.json
name
Name is the name of the builder to use. If omitted, DevSpace will try to create or reuse a builder in the form devspace-$NAMESPACE
{"type": "string"}
devspace-schema.json
namespace
Namespace where to create the builder deployment in. Defaults to the current active namespace.
{"type": "string"}
devspace-schema.json
rootless
Rootless if enabled will create a rootless builder deployment.
{"type": "boolean"}
devspace-schema.json
image
Image is the docker image to use for the BuildKit deployment
{"type": "string"}
devspace-schema.json
nodeSelector
NodeSelector is the node selector to use for the BuildKit deployment
{"type": "string"}
devspace-schema.json
noCreate
NoCreate. By default, DevSpace will try to create a new builder if it cannot be found. If this is true, DevSpace will fail if the specified builder cannot be found.
{"type": "boolean"}
devspace-schema.json
noRecreate
NoRecreate. By default, DevSpace will try to recreate the builder if the builder configuration in the devspace.yaml differs from the actual builder configuration. If this is true, DevSpace will not try to do that.
{"type": "boolean"}
devspace-schema.json
noLoad
NoLoad if enabled, DevSpace will not try to load the built image into the local docker daemon if skip push is defined
{"type": "boolean"}
devspace-schema.json
createArgs
CreateArgs are additional args to create the builder with.
{"items": {"type": "string"}, "type": "array"}
devspace-schema.json
ChartConfig
ChartConfig defines the helm chart options
{"properties": {"name": {"type": "string", "group": "repo", "group_name": "Source: Helm Repository"}, "version": {"type": "string", "group": "repo"}, "repo": {"type": "string", "group": "repo"}, "username": {"type": "string", "group": "repo"}, "password": {"type": "string", "group": "repo"}, "path": {"type": "string", "group": "path", "group_name": "Source: Local Filesystem"}, "git": {"type": "string", "group": "git", "group_name": "Source: Git Repository"}, "subPath": {"type": "string", "group": "git"}, "branch": {"type": "string", "group": "git"}, "tag": {"type": "string", "group": "git"}, "revision": {"type": "string", "group": "git"}, "cloneArgs": {"items": {"type": "string"}, "type": "array", "group": "git"}, "disableShallow": {"type": "boolean", "group": "git"}, "disablePull": {"type": "boolean", "group": "git"}}, "type": "object"}
devspace-schema.json
name
Name is the name of the helm chart to deploy. Can also be a local path or an oci url
{"type": "string", "group": "repo", "group_name": "Source: Helm Repository"}
devspace-schema.json
version
Version is the version of the helm chart to deploy
{"type": "string", "group": "repo"}
devspace-schema.json
repo
RepoURL is the url of the repo to deploy the chart from
{"type": "string", "group": "repo"}
devspace-schema.json
username
Username is the username to authenticate to the chart repo. When using an OCI chart, used for registry auth
{"type": "string", "group": "repo"}
devspace-schema.json
password
Password is the password to authenticate to the chart repo, When using an OCI chart, used for registry auth
{"type": "string", "group": "repo"}
devspace-schema.json
path
Path is the local path where DevSpace can find the artifact. This option is mutually exclusive with the git option.
{"type": "string", "group": "path", "group_name": "Source: Local Filesystem"}
devspace-schema.json
git
Git is the remote repository to download the artifact from. You can either use https projects or ssh projects here, but need to make sure git can pull the project. This option is mutually exclusive with the path option.
{"type": "string", "group": "git", "group_name": "Source: Git Repository"}
devspace-schema.json
subPath
SubPath is a path within the git repository where the artifact lies in
{"type": "string", "group": "git"}
devspace-schema.json
branch
Branch is the git branch to pull
{"type": "string", "group": "git"}
devspace-schema.json
tag
Tag is the tag to pull
{"type": "string", "group": "git"}
devspace-schema.json
revision
Revision is the git revision to pull
{"type": "string", "group": "git"}
devspace-schema.json
cloneArgs
CloneArgs are additional arguments that should be supplied to the git CLI
{"items": {"type": "string"}, "type": "array", "group": "git"}
devspace-schema.json
disableShallow
DisableShallow can be used to turn off shallow clones as these are the default used by devspace
{"type": "boolean", "group": "git"}
devspace-schema.json
disablePull
DisablePull will disable pulling every time DevSpace is reevaluating this source
{"type": "boolean", "group": "git"}
devspace-schema.json
CommandConfig
CommandConfig defines the command specification
{"properties": {"name": {"type": "string"}, "section": {"type": "string"}, "command": {"type": "string"}, "args": {"items": {"type": "string"}, "type": "array"}, "appendArgs": {"type": "boolean"}, "internal": {"type": "boolean"}, "after": {"type": "string"}}, "type": "object", "required": ["command"]}
devspace-schema.json
name
Name is the name of a command that is used via `devspace run NAME`
{"type": "string"}
devspace-schema.json
section
Section can be used to group similar commands together in `devspace list commands`
{"type": "string"}
devspace-schema.json
command
Command is the command that should be executed. For example: 'echo 123'
{"type": "string"}
devspace-schema.json
args
Args are optional and if defined, command is not executed within a shell and rather directly.
{"items": {"type": "string"}, "type": "array"}
devspace-schema.json
appendArgs
AppendArgs will append arguments passed to the DevSpace command automatically to the specified command.
{"type": "boolean"}
devspace-schema.json
description
Description describes what the command is doing and can be seen in `devspace list commands`
{"type": "string"}
devspace-schema.json
internal
Internal commands are not show in list and are usable through run_command
{"type": "boolean"}
devspace-schema.json
after
After is executed after the command was run. It is executed also when the command was interrupted which will set the env variable COMMAND_INTERRUPT to true as well as when the command errored which will set the error string to COMMAND_ERROR.
{"type": "string"}
devspace-schema.json
CustomConfig
CustomConfig tells the DevSpace CLI to build with a custom build script
{"properties": {"command": {"type": "string"}, "onChange": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}
devspace-schema.json
command
Command to execute to build the image. You can use ${runtime.images.my-image.image} and ${runtime.image.my-image.tag} to reference the image and tag that should get built.
{"type": "string"}
devspace-schema.json
onChange
OnChange will determine when the command should be rerun
{"items": {"type": "string"}, "type": "array"}
devspace-schema.json
DependencyConfig
DependencyConfig defines the devspace dependency
{"properties": {"name": {"type": "string"}, "disabled": {"type": "boolean"}, "path": {"type": "string", "group": "path", "group_name": "Source: Local Filesystem"}, "git": {"type": "string", "group": "git", "group_name": "Source: Git Repository"}, "subPath": {"type": "string", "group": "git"}, "branch": {"type": "string", "group": "git"}, "tag": {"type": "string", "group": "git"}, "revision": {"type": "string", "group": "git"}, "cloneArgs": {"items": {"type": "string"}, "type": "array", "group": "git"}, "disableShallow": {"type": "boolean", "group": "git"}, "disablePull": {"type": "boolean", "group": "git"}, "pipeline": {"type": "string", "default": "deploy", "group": "execution", "group_name": "Execution"}, "vars": {"patternProperties": {".*": {"type": "string"}}, "type": "object", "group": "execution"}, "overwriteVars": {"type": "boolean", "group": "execution"}, "ignoreDependencies": {"type": "boolean", "group": "execution"}, "namespace": {"type": "string", "group": "execution"}}, "type": "object"}
devspace-schema.json
name
Name is used internally
{"type": "string"}
devspace-schema.json
disabled
Disabled excludes this dependency from variable resolution and pipeline runs
{"type": "boolean"}
devspace-schema.json
path
Path is the local path where DevSpace can find the artifact. This option is mutually exclusive with the git option.
{"type": "string", "group": "path", "group_name": "Source: Local Filesystem"}
devspace-schema.json
git
Git is the remote repository to download the artifact from. You can either use https projects or ssh projects here, but need to make sure git can pull the project. This option is mutually exclusive with the path option.
{"type": "string", "group": "git", "group_name": "Source: Git Repository"}
devspace-schema.json
subPath
SubPath is a path within the git repository where the artifact lies in
{"type": "string", "group": "git"}
devspace-schema.json
branch
Branch is the git branch to pull
{"type": "string", "group": "git"}
devspace-schema.json
tag
Tag is the tag to pull
{"type": "string", "group": "git"}
devspace-schema.json
revision
Revision is the git revision to pull
{"type": "string", "group": "git"}
devspace-schema.json
cloneArgs
CloneArgs are additional arguments that should be supplied to the git CLI
{"items": {"type": "string"}, "type": "array", "group": "git"}
devspace-schema.json
disableShallow
DisableShallow can be used to turn off shallow clones as these are the default used by devspace
{"type": "boolean", "group": "git"}
devspace-schema.json
disablePull
DisablePull will disable pulling every time DevSpace is reevaluating this source
{"type": "boolean", "group": "git"}
devspace-schema.json
pipeline
Pipeline is the pipeline to deploy by default. Defaults to 'deploy'
{"type": "string", "default": "deploy", "group": "execution", "group_name": "Execution"}
devspace-schema.json
vars
Vars are variables that should be passed to the dependency
{"patternProperties": {".*": {"type": "string"}}, "type": "object", "group": "execution"}
devspace-schema.json
overwriteVars
OverwriteVars specifies if DevSpace should pass the parent variables to the dependency
{"type": "boolean", "group": "execution"}
devspace-schema.json
ignoreDependencies
IgnoreDependencies defines if dependencies of the dependency should be excluded
{"type": "boolean", "group": "execution"}
devspace-schema.json
namespace
Namespace specifies the namespace this dependency should be deployed to
{"type": "string", "group": "execution"}
devspace-schema.json
DeploymentConfig
DeploymentConfig defines the configuration how the devspace should be deployed
{"properties": {"name": {"type": "string"}, "helm": {}, "kubectl": {}, "updateImageTags": {"type": "boolean"}, "namespace": {"type": "string"}}, "type": "object"}
devspace-schema.json
name
Name of the deployment
{"type": "string"}
devspace-schema.json
helm
Helm tells DevSpace to deploy this deployment via helm
{}
devspace-schema.json
kubectl
Kubectl tells DevSpace to deploy this deployment via kubectl or kustomize
{}
devspace-schema.json
updateImageTags
UpdateImageTags lets you define if DevSpace should update the tags of the images defined in the images section with their most recent built tag.
{"type": "boolean"}
devspace-schema.json
namespace
Namespace where to deploy this deployment
{"type": "string"}