schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
devspace-schema.json | DevContainer | DevContainer holds options for dev services that should get started within a certain container of the selected pod | {"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"} |
devspace-schema.json | container | Container is the container name these services should get started. | {"type": "string", "group": "selector", "group_name": "Selector"} |
devspace-schema.json | arch | Target Container architecture to use for the devspacehelper (currently amd64 or arm64). Defaults to amd64, but
devspace tries to find out the architecture by itself by looking at the node this container runs on. | {"type": "string", "group": "selector"} |
devspace-schema.json | devImage | DevImage is the image to use for this container and will replace the existing image
if necessary. | {"type": "string", "group": "modifications", "group_name": "Modifications"} |
devspace-schema.json | command | Command can be used to override the entrypoint of the container | {"items": {"type": "string"}, "type": "array", "group": "modifications"} |
devspace-schema.json | args | Args can be used to override the args of the container | {"items": {"type": "string"}, "type": "array", "group": "modifications"} |
devspace-schema.json | workingDir | WorkingDir can be used to override the working dir of the container | {"type": "string", "group": "modifications"} |
devspace-schema.json | env | Env can be used to add environment variables to the container. DevSpace will
not replace existing environment variables if an environment variable is defined here. | {"items": {}, "type": "array", "group": "modifications"} |
devspace-schema.json | resources | Resources can be used to override the resource definitions of the container | {"group": "modifications"} |
devspace-schema.json | reversePorts | ReversePorts are port mappings to make local ports available inside the container | {"items": {}, "type": "array", "group": "ports", "group_name": "Port Forwarding"} |
devspace-schema.json | sync | Sync allows you to sync certain local paths with paths inside the container | {"items": {}, "type": "array", "group": "sync", "group_name": "File Sync"} |
devspace-schema.json | persistPaths | PersistPaths allows you to persist certain paths within this container with a persistent volume claim | {"items": {}, "type": "array"} |
devspace-schema.json | terminal | Terminal allows you to tell DevSpace to open a terminal with screen support to this container | {"group": "workflows", "group_name": "Foreground Dev Workflows"} |
devspace-schema.json | logs | Logs allows you to tell DevSpace to stream logs from this container to the console | {"group": "workflows"} |
devspace-schema.json | attach | Attach allows you to tell DevSpace to attach to this container | {"group": "workflows"} |
devspace-schema.json | ssh | SSH allows you to create an SSH tunnel to this container | {} |
devspace-schema.json | proxyCommands | ProxyCommands allow you to proxy certain local commands to the container | {"items": {}, "type": "array", "group": "workflows_background"} |
devspace-schema.json | restartHelper | RestartHelper holds restart helper specific configuration. The restart helper is used to delay starting of
the container and restarting it and is injected via an annotation in the replaced pod. | {"group": "workflows_background"} |
devspace-schema.json | DevPod | DevPod holds configurations for selecting a pod and starting dev services for that pod | {"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"} |
devspace-schema.json | name | Name of the dev configuration | {"type": "string"} |
devspace-schema.json | imageSelector | ImageSelector to select a pod | {"type": "string", "group": "selector"} |
devspace-schema.json | labelSelector | LabelSelector to select a pod | {"patternProperties": {".*": {"type": "string"}}, "type": "object", "group": "selector"} |
devspace-schema.json | namespace | Namespace where to select the pod | {"type": "string", "group": "selector"} |
devspace-schema.json | container | Container is the container name these services should get started. | {"type": "string", "group": "selector", "group_name": "Selector"} |
devspace-schema.json | arch | Target Container architecture to use for the devspacehelper (currently amd64 or arm64). Defaults to amd64, but
devspace tries to find out the architecture by itself by looking at the node this container runs on. | {"type": "string", "group": "selector"} |
devspace-schema.json | devImage | DevImage is the image to use for this container and will replace the existing image
if necessary. | {"type": "string", "group": "modifications", "group_name": "Modifications"} |
devspace-schema.json | command | Command can be used to override the entrypoint of the container | {"items": {"type": "string"}, "type": "array", "group": "modifications"} |
devspace-schema.json | args | Args can be used to override the args of the container | {"items": {"type": "string"}, "type": "array", "group": "modifications"} |
devspace-schema.json | workingDir | WorkingDir can be used to override the working dir of the container | {"type": "string", "group": "modifications"} |
devspace-schema.json | env | Env can be used to add environment variables to the container. DevSpace will
not replace existing environment variables if an environment variable is defined here. | {"items": {}, "type": "array", "group": "modifications"} |
devspace-schema.json | resources | Resources can be used to override the resource definitions of the container | {"group": "modifications"} |
devspace-schema.json | reversePorts | ReversePorts are port mappings to make local ports available inside the container | {"items": {}, "type": "array", "group": "ports", "group_name": "Port Forwarding"} |
devspace-schema.json | sync | Sync allows you to sync certain local paths with paths inside the container | {"items": {}, "type": "array", "group": "sync", "group_name": "File Sync"} |
devspace-schema.json | persistPaths | PersistPaths allows you to persist certain paths within this container with a persistent volume claim | {"items": {}, "type": "array"} |
devspace-schema.json | terminal | Terminal allows you to tell DevSpace to open a terminal with screen support to this container | {"group": "workflows", "group_name": "Foreground Dev Workflows"} |
devspace-schema.json | logs | Logs allows you to tell DevSpace to stream logs from this container to the console | {"group": "workflows"} |
devspace-schema.json | attach | Attach allows you to tell DevSpace to attach to this container | {"group": "workflows"} |
devspace-schema.json | ssh | SSH allows you to create an SSH tunnel to this container | {} |
devspace-schema.json | proxyCommands | ProxyCommands allow you to proxy certain local commands to the container | {"items": {}, "type": "array", "group": "workflows_background"} |
devspace-schema.json | restartHelper | RestartHelper holds restart helper specific configuration. The restart helper is used to delay starting of
the container and restarting it and is injected via an annotation in the replaced pod. | {"group": "workflows_background"} |
devspace-schema.json | ports | Ports defines port mappings from the remote pod that should be forwarded to your local
computer | {"items": {}, "type": "array", "group": "ports"} |
devspace-schema.json | persistenceOptions | PersistenceOptions are additional options for persisting paths within this pod | {"group": "modifications"} |
devspace-schema.json | patches | Patches are additional changes to the pod spec that should be applied | {"items": {}, "type": "array", "group": "modifications"} |
devspace-schema.json | open | Open defines urls that should be opened as soon as they are reachable | {"items": {}, "type": "array", "group": "workflows_background", "group_name": "Background Dev Workflows"} |
devspace-schema.json | DockerConfig | DockerConfig tells the DevSpace CLI to build with Docker on Minikube or on localhost | {"properties": {"disableFallback": {"type": "boolean"}, "preferMinikube": {"type": "boolean"}, "useCli": {"type": "boolean"}, "args": {"items": {"type": "string"}, "type": "array"}}, "type": "object"} |
devspace-schema.json | disableFallback | DisableFallback allows you to turn off kaniko building if docker isn't installed | {"type": "boolean"} |
devspace-schema.json | preferMinikube | PreferMinikube allows you to turn off using the minikube docker daemon if the minikube
context is used. | {"type": "boolean"} |
devspace-schema.json | useCli | UseCLI specifies if DevSpace should use the docker cli for building | {"type": "boolean"} |
devspace-schema.json | args | Args are additional arguments to pass to the docker cli | {"items": {"type": "string"}, "type": "array"} |
devspace-schema.json | name | Name of the environment variable | {"type": "string"} |
devspace-schema.json | value | Value of the environment variable | {"type": "string"} |
devspace-schema.json | HelmConfig | HelmConfig defines the specific helm options used during deployment | {"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"} |
devspace-schema.json | releaseName | ReleaseName of the helm configuration | {"type": "string"} |
devspace-schema.json | chart | Chart holds the chart configuration and where DevSpace can find the chart | {} |
devspace-schema.json | values | Values are additional values that should get passed to deploying this chart | {"type": "object"} |
devspace-schema.json | valuesFiles | ValuesFiles are additional files that hold values for deploying this chart | {"items": {"type": "string"}, "type": "array"} |
devspace-schema.json | displayOutput | DisplayOutput allows you to display the helm output to the console | {"type": "boolean"} |
devspace-schema.json | upgradeArgs | UpgradeArgs are additional arguments to pass to `helm upgrade` | {"items": {"type": "string"}, "type": "array"} |
devspace-schema.json | templateArgs | TemplateArgs are additional arguments to pass to `helm template` | {"items": {"type": "string"}, "type": "array"} |
devspace-schema.json | disableDependencyUpdate | DisableDependencyUpdate disables helm dependencies update, default to false | {"type": "boolean"} |
devspace-schema.json | Image | Image defines the image specification | {"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"]} |
devspace-schema.json | name | Name of the image, will be filled automatically | {"type": "string"} |
devspace-schema.json | image | Image is the complete image name including registry and repository
for example myregistry.com/mynamespace/myimage | {"type": "string"} |
devspace-schema.json | tags | Tags is an array that specifies all tags that should be build during
the build process. If this is empty, devspace will generate a random tag | {"items": {"type": "string"}, "type": "array"} |
devspace-schema.json | dockerfile | Dockerfile specifies a path (relative or absolute) to the dockerfile. Defaults to ./Dockerfile. | {"type": "string", "default": "./Dockerfile", "group": "buildConfig"} |
devspace-schema.json | context | Context is the context path to build with. Defaults to the current working directory | {"type": "string", "default": "./", "group": "buildConfig"} |
devspace-schema.json | entrypoint | Entrypoint specifies an entrypoint that will be appended to the dockerfile during
image build in memory. Example: ["sleep", "99999"] | {"items": {"type": "string"}, "type": "array", "group": "overwrites", "group_name": "In-Memory Overwrites"} |
devspace-schema.json | cmd | Cmd specifies the arguments for the entrypoint that will be appended
during build in memory to the dockerfile | {"items": {"type": "string"}, "type": "array", "group": "overwrites"} |
devspace-schema.json | appendDockerfileInstructions | AppendDockerfileInstructions are instructions that will be appended to the Dockerfile that is build
at the current build target and are appended before the entrypoint and cmd instructions | {"items": {"type": "string"}, "type": "array", "group": "overwrites"} |
devspace-schema.json | buildArgs | BuildArgs are the build args that are to the build | {"patternProperties": {".*": {"type": "string"}}, "type": "object", "group": "buildConfig", "group_name": "Build Configuration"} |
devspace-schema.json | target | Target is the target that should get used during the build. Only works if the dockerfile supports this | {"type": "string", "group": "buildConfig"} |
devspace-schema.json | network | Network is the network that should get used to build the image | {"type": "string", "group": "buildConfig"} |
devspace-schema.json | rebuildStrategy | RebuildStrategy is used to determine when DevSpace should rebuild an image. By default, devspace will
rebuild an image if one of the following conditions is true:
- The dockerfile has changed
- The configuration within the devspace.yaml for the image has changed
- A file within the docker context (excluding .dockerignore rules) has changed
This option is ignored for custom builds. | {"type": "string", "enum": ["default", "always", "ignoreContextChanges"], "group": "buildConfig"} |
devspace-schema.json | skipPush | SkipPush will not push the image to a registry if enabled. Only works if docker or buildkit is chosen
as build method | {"type": "boolean", "group": "pushPull", "group_name": "Push & Pull"} |
devspace-schema.json | createPullSecret | CreatePullSecret specifies if a pull secret should be created for this image in the
target namespace. Defaults to true | {"type": "boolean", "group": "pushPull"} |
devspace-schema.json | buildKit | BuildKit if buildKit is specified, DevSpace will build the image either in-cluster or locally with BuildKit | {"group": "engines", "group_name": "Build Engines"} |
devspace-schema.json | docker | Docker if docker is specified, DevSpace will build the image using the local docker daemon | {"group": "engines"} |
devspace-schema.json | kaniko | Kaniko if kaniko is specified, DevSpace will build the image in-cluster with kaniko | {"group": "engines"} |
devspace-schema.json | custom | Custom if custom is specified, DevSpace will build the image with the help of
a custom script. | {"group": "engines"} |
devspace-schema.json | Import | Import specifies the source of the devspace config to merge | {"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"} |
devspace-schema.json | enabled | Enabled specifies if the given import should be enabled | {"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 | KanikoAdditionalMount | KanikoAdditionalMount tells devspace how the additional mount of the kaniko pod should look like | {"properties": {"secret": {}, "configMap": {}, "readOnly": {"type": "boolean"}, "mountPath": {"type": "string"}, "subPath": {"type": "string"}}, "type": "object"} |
devspace-schema.json | secret | The secret that should be mounted | {} |
devspace-schema.json | configMap | The configMap that should be mounted | {} |
devspace-schema.json | readOnly | Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.
+optional | {"type": "boolean"} |
devspace-schema.json | mountPath | Path within the container at which the volume should be mounted. Must
not contain ':'. | {"type": "string"} |
devspace-schema.json | subPath | Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).
+optional | {"type": "string"} |
devspace-schema.json | name | Name of the configmap
+optional | {"type": "string"} |
devspace-schema.json | items | If unspecified, each key-value pair in the Data field of the referenced
ConfigMap will be projected into the volume as a file whose name is the
key and content is the value. If specified, the listed keys will be
projected into the specified paths, and unlisted keys will not be
present. If a key is specified which is not present in the ConfigMap,
the volume setup will error unless it is marked optional. Paths must be
relative and may not contain the '..' path or start with '..'.
+optional | {"items": {}, "type": "array"} |
devspace-schema.json | defaultMode | Optional: mode bits to use on created files by default. Must be a
value between 0 and 0777. Defaults to 0644.
Directories within the path are not affected by this setting.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set.
+optional | {"type": "integer"} |
devspace-schema.json | key | The key to project. | {"type": "string"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.