devspace.yaml
yaml devspace.yaml
| Type | object |
|---|---|
| File match |
devspace.yaml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/devspace-yaml/latest.json |
| Source | https://raw.githubusercontent.com/loft-sh/devspace/main/devspace-schema.json |
Validate with Lintel
npx @lintel/lintel checkConfig defines the configuration
Properties
Version holds the config version. DevSpace will always convert older configs to the current latest config version, which makes it possible to use the newest DevSpace version also with older config versions.
Name specifies the name of the DevSpace project and uniquely identifies a project. DevSpace will not allow multiple active projects with the same name in the same Kubernetes namespace. If not provided, DevSpace will use the name of the current working directory.
Imports merges specified config files into this one. This is very useful to split up your DevSpace configuration into multiple files and reuse those through git, a remote url or common local path.
Functions are POSIX functions that can be used within pipelines. Those functions can also be imported by imports.
Pipelines are the work blocks that DevSpace should execute when devspace dev, devspace build, devspace deploy or devspace purge is called. Pipelines are defined through a special POSIX script that allows you to use special commands such as create_deployments, start_dev, build_images etc. to signal DevSpace you want to execute a specific functionality. The pipelines dev, build, deploy and purge are special and will override the default functionality of the respective command if defined. All other pipelines can be either run via the devspace run-pipeline command or used within another pipeline through run_pipelines.
Images holds configuration of how DevSpace should build images. By default, DevSpace will build all defined images. If you are using a custom pipeline, you can dynamically define which image is built at which time during the execution.
Deployments holds configuration of how DevSpace should deploy resources to Kubernetes. By default, DevSpace will deploy all defined deployments. If you are using a custom pipeline, you can dynamically define which deployment is deployed at which time during the execution.
Dev holds development configuration. Each dev configuration targets a single pod and enables certain dev services on that pod or even rewrites it if certain changes are requested, such as adding an environment variable or changing the entrypoint. Dev allows you to:
- sync local folders to the Kubernetes pod
- port forward remote ports to your local computer
- forward local ports into the Kubernetes pod
- configure an ssh tunnel to the Kubernetes pod
- proxy local commands to the container
- restart the container on file changes
Vars are config variables that can be used inside other config sections to replace certain values dynamically
Commands are custom commands that can be executed via 'devspace run COMMAND'. These commands are run within a pseudo bash that also allows executing special commands such as run_watch or is_equal.
Dependencies are sub devspace projects that lie in a local folder or remote git repository that can be executed from within the pipeline. In contrast to imports, these projects pose as separate fully functional DevSpace projects that typically lie including source code in a different folder and can be used to compose a full microservice application that will be deployed by DevSpace. Each dependency name can only be used once and if you want to use the same project multiple times, make sure to use a different name for each of those instances.
PullSecrets are image pull secrets that will be created by devspace in the target namespace during devspace dev or devspace deploy. DevSpace will merge all defined pull secrets into a single one or the one specified.
Require defines what DevSpace, plugins and command versions are required to use this config and if a condition is not fulfilled, DevSpace will fail.
Hooks are actions that are executed at certain points within the pipeline. Hooks are ordered and are executed in the order they are specified. They are deprecated and pipelines should be used instead.
LocalRegistry specifies the configuration for a local image registry
Definitions
Enabled can be used to enable attaching to a container
DisableReplace prevents DevSpace from actually replacing the pod with modifications so that the pod starts up correctly.
DisableTTY is used to tell DevSpace to not use a TTY connection for attaching
BandwidthLimits defines the struct for specifying the sync bandwidth limits
Download is the download limit in kilo bytes per second
Upload is the upload limit in kilo bytes per second
BuildKitConfig tells the DevSpace CLI to
InCluster if specified, DevSpace will use BuildKit to build the image within the cluster
PreferMinikube if false, will not try to use the minikube docker daemon to build the image
Args are additional arguments to call docker buildx build with
Command to override the base command to create a builder and build images. Defaults to ["docker", "buildx"]
BuildKitInClusterConfig holds the buildkit builder config
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
Namespace where to create the builder deployment in. Defaults to the current active namespace.
Rootless if enabled will create a rootless builder deployment.
Image is the docker image to use for the BuildKit deployment
NodeSelector is the node selector to use for the BuildKit deployment
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.
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.
NoLoad if enabled, DevSpace will not try to load the built image into the local docker daemon if skip push is defined
CreateArgs are additional args to create the builder with.
ChartConfig defines the helm chart options
Name is the name of the helm chart to deploy. Can also be a local path or an oci url
Version is the version of the helm chart to deploy
RepoURL is the url of the repo to deploy the chart from
Username is the username to authenticate to the chart repo. When using an OCI chart, used for registry auth
Password is the password to authenticate to the chart repo, When using an OCI chart, used for registry auth
Path is the local path where DevSpace can find the artifact. This option is mutually exclusive with the git option.
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.
SubPath is a path within the git repository where the artifact lies in
Branch is the git branch to pull
Tag is the tag to pull
Revision is the git revision to pull
CloneArgs are additional arguments that should be supplied to the git CLI
DisableShallow can be used to turn off shallow clones as these are the default used by devspace
DisablePull will disable pulling every time DevSpace is reevaluating this source
CommandConfig defines the command specification
Command is the command that should be executed. For example: 'echo 123'
Name is the name of a command that is used via devspace run NAME
Section can be used to group similar commands together in devspace list commands
Args are optional and if defined, command is not executed within a shell and rather directly.
AppendArgs will append arguments passed to the DevSpace command automatically to the specified command.
Description describes what the command is doing and can be seen in devspace list commands
Internal commands are not show in list and are usable through run_command
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.
CustomConfig tells the DevSpace CLI to build with a custom build script
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.
OnChange will determine when the command should be rerun
DependencyConfig defines the devspace dependency
Name is used internally
Disabled excludes this dependency from variable resolution and pipeline runs
Path is the local path where DevSpace can find the artifact. This option is mutually exclusive with the git option.
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.
SubPath is a path within the git repository where the artifact lies in
Branch is the git branch to pull
Tag is the tag to pull
Revision is the git revision to pull
CloneArgs are additional arguments that should be supplied to the git CLI
DisableShallow can be used to turn off shallow clones as these are the default used by devspace
DisablePull will disable pulling every time DevSpace is reevaluating this source
Pipeline is the pipeline to deploy by default. Defaults to 'deploy'
Vars are variables that should be passed to the dependency
OverwriteVars specifies if DevSpace should pass the parent variables to the dependency
IgnoreDependencies defines if dependencies of the dependency should be excluded
Namespace specifies the namespace this dependency should be deployed to
DeploymentConfig defines the configuration how the devspace should be deployed
Name of the deployment
Helm tells DevSpace to deploy this deployment via helm
Kubectl tells DevSpace to deploy this deployment via kubectl or kustomize
UpdateImageTags lets you define if DevSpace should update the tags of the images defined in the images section with their most recent built tag.
Namespace where to deploy this deployment
DevContainer holds options for dev services that should get started within a certain container of the selected pod
Container is the container name these services should get started.
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.
DevImage is the image to use for this container and will replace the existing image if necessary.
Command can be used to override the entrypoint of the container
Args can be used to override the args of the container
WorkingDir can be used to override the working dir of the container
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.
Resources can be used to override the resource definitions of the container
ReversePorts are port mappings to make local ports available inside the container
Sync allows you to sync certain local paths with paths inside the container
PersistPaths allows you to persist certain paths within this container with a persistent volume claim
Terminal allows you to tell DevSpace to open a terminal with screen support to this container
Logs allows you to tell DevSpace to stream logs from this container to the console
Attach allows you to tell DevSpace to attach to this container
SSH allows you to create an SSH tunnel to this container
ProxyCommands allow you to proxy certain local commands to the container
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.
DevPod holds configurations for selecting a pod and starting dev services for that pod
Name of the dev configuration
ImageSelector to select a pod
LabelSelector to select a pod
Namespace where to select the pod
Container is the container name these services should get started.
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.
DevImage is the image to use for this container and will replace the existing image if necessary.
Command can be used to override the entrypoint of the container
Args can be used to override the args of the container
WorkingDir can be used to override the working dir of the container
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.
Resources can be used to override the resource definitions of the container
ReversePorts are port mappings to make local ports available inside the container
Sync allows you to sync certain local paths with paths inside the container
PersistPaths allows you to persist certain paths within this container with a persistent volume claim
Terminal allows you to tell DevSpace to open a terminal with screen support to this container
Logs allows you to tell DevSpace to stream logs from this container to the console
Attach allows you to tell DevSpace to attach to this container
SSH allows you to create an SSH tunnel to this container
ProxyCommands allow you to proxy certain local commands to the container
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.
Ports defines port mappings from the remote pod that should be forwarded to your local computer
PersistenceOptions are additional options for persisting paths within this pod
Patches are additional changes to the pod spec that should be applied
Open defines urls that should be opened as soon as they are reachable
DockerConfig tells the DevSpace CLI to build with Docker on Minikube or on localhost
DisableFallback allows you to turn off kaniko building if docker isn't installed
PreferMinikube allows you to turn off using the minikube docker daemon if the minikube context is used.
UseCLI specifies if DevSpace should use the docker cli for building
Args are additional arguments to pass to the docker cli
Name of the environment variable
Value of the environment variable
HelmConfig defines the specific helm options used during deployment
ReleaseName of the helm configuration
Chart holds the chart configuration and where DevSpace can find the chart
Values are additional values that should get passed to deploying this chart
ValuesFiles are additional files that hold values for deploying this chart
DisplayOutput allows you to display the helm output to the console
UpgradeArgs are additional arguments to pass to helm upgrade
TemplateArgs are additional arguments to pass to helm template
DisableDependencyUpdate disables helm dependencies update, default to false
HookConfig defines a hook
Events are the events when the hook should be executed
Name is the name of the hook
Disabled can be used to disable the hook
Command is the base command that is either executed locally or in a remote container. Command is mutually exclusive with other hook actions. In the case this is defined together with where.container, DevSpace will until the target container is running and only then execute the command. If the container does not start in time, DevSpace will fail.
Args are additional arguments passed together with the command to execute.
If an operating system is defined, the hook will only be executed for the given os. All supported golang OS types are supported and multiple can be combined with ','.
If Upload is specified, DevSpace will upload certain local files or folders into a remote container.
Same as Upload, but with this option DevSpace will download files or folders from a remote container.
If logs is defined will print the logs of the target container. This is useful for containers that should finish like init containers or job pods. Otherwise this hook will never terminate.
If wait is defined the hook will wait until the matched pod or container is running or is terminated with a certain exit code.
If true, the hook will be executed in the background.
If true, the hook will not output anything to the standard out of DevSpace except for the case when the hook fails, where DevSpace will show the error including the captured output streams of the hook.
Container specifies where the hook should be run. If this is omitted DevSpace expects a local command hook.
HookContainer defines how to select one or more containers to execute a hook in
LabelSelector to select a container
Pod name to use
Namespace to use
ImageSelector to select a container
ContainerName to use
Wait can be used to disable waiting
Timeout is how long to wait (in seconds) for the container to start. Default is 150 seconds.
Once only executes an hook once in the container until it is restarted
HookLogsConfig defines a hook logs config
If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container
HookSyncConfig defines a hook upload config
LocalPath to sync files from
ContainerPath to sync files to
HookWaitConfig defines a hook wait config
If running is true, will wait until the matched containers are running. Can be used together with terminatedWithCode.
If terminatedWithCode is not nil, will wait until the matched containers are terminated with the given exit code. If the container has exited with a different exit code, the hook will fail. Can be used together with running.
The amount of seconds to wait until the hook will fail. Defaults to 150 seconds.
Image defines the image specification
Image is the complete image name including registry and repository for example myregistry.com/mynamespace/myimage
Name of the image, will be filled automatically
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
Dockerfile specifies a path (relative or absolute) to the dockerfile. Defaults to ./Dockerfile.
Context is the context path to build with. Defaults to the current working directory
Entrypoint specifies an entrypoint that will be appended to the dockerfile during image build in memory. Example: ["sleep", "99999"]
Cmd specifies the arguments for the entrypoint that will be appended during build in memory to the dockerfile
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
BuildArgs are the build args that are to the build
Target is the target that should get used during the build. Only works if the dockerfile supports this
Network is the network that should get used to build the image
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.
SkipPush will not push the image to a registry if enabled. Only works if docker or buildkit is chosen as build method
CreatePullSecret specifies if a pull secret should be created for this image in the target namespace. Defaults to true
BuildKit if buildKit is specified, DevSpace will build the image either in-cluster or locally with BuildKit
Docker if docker is specified, DevSpace will build the image using the local docker daemon
Kaniko if kaniko is specified, DevSpace will build the image in-cluster with kaniko
Custom if custom is specified, DevSpace will build the image with the help of a custom script.
Import specifies the source of the devspace config to merge
Enabled specifies if the given import should be enabled
Path is the local path where DevSpace can find the artifact. This option is mutually exclusive with the git option.
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.
SubPath is a path within the git repository where the artifact lies in
Branch is the git branch to pull
Tag is the tag to pull
Revision is the git revision to pull
CloneArgs are additional arguments that should be supplied to the git CLI
DisableShallow can be used to turn off shallow clones as these are the default used by devspace
DisablePull will disable pulling every time DevSpace is reevaluating this source
KanikoAdditionalMount tells devspace how the additional mount of the kaniko pod should look like
The secret that should be mounted
The configMap that should be mounted
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. +optional
Path within the container at which the volume should be mounted. Must not contain ':'.
Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). +optional
Name of the configmap +optional
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
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
The key to project.
The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. 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
Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret +optional
If unspecified, each key-value pair in the Data field of the referenced Secret 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 Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +optional
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
KanikoConfig tells the DevSpace CLI to build with Docker on Minikube or on localhost
Cache tells DevSpace if a cache repository should be used. defaults to false
SnapshotMode tells DevSpace which snapshot mode kaniko should use. defaults to time
Image is the image name of the kaniko pod to use
InitImage to override the init image of the kaniko pod
Args for additional arguments that should be passed to kaniko
Command to replace the starting command for the kaniko container
Namespace is the namespace where the kaniko pod should be run
Insecure allows pushing to insecure registries
PullSecret is the pull secret to mount by default
SkipPullSecretMount will skip mounting the pull secret
NodeSelector is the node selector to use for the kaniko pod
Tolerations is a tolerations list to use for the kaniko pod
ServiceAccount the service account to use for the kaniko pod
GenerateName is the optional prefix that will be set to the generateName field of the build pod
Annotations are extra annotations that will be added to the build pod
Labels are extra labels that will be added to the build pod
InitEnv are extra environment variables that will be added to the build init container
Env are extra environment variables that will be added to the build kaniko container Will populate the env.value field.
EnvFrom are extra environment variables from configmap or secret that will be added to the build kaniko container Will populate the env.valueFrom field.
AdditionalMounts are additional mounts that will be added to the build pod
Resources are the resources that should be set on the kaniko pod
KubectlConfig defines the specific kubectl options used during deployment
Manifests is a list of files or folders that will be deployed by DevSpace using kubectl or kustomize
ApplyArgs are extra arguments for kubectl apply
CreateArgs are extra arguments for kubectl create which will be run before kubectl apply
KubectlBinaryPath is the optional path where to find the kubectl binary
InlineManifests is a block containing the manifest to deploy
Kustomize can be used to enable kustomize instead of kubectl
KustomizeArgs are extra arguments for kustomize build which will be run before kubectl apply
KustomizeBinaryPath is the optional path where to find the kustomize binary
Patches are additional changes to the pod spec that should be applied
LocalRegistryConfig holds the configuration of the local image registry
Enabled enables the local registry for pushing images.
When unset the local registry will be used as a fallback if there are no push permissions for the registry.
When true the local registry will always be used.
When false the local registry will never be used.
LocalBuild enables use of local docker builder instead of building in the cluster
Namespace where the local registry is deployed. Default is the current context's namespace
Name of the deployment and service of the local registry. Default is registry
Image of the local registry. Default is registry:2.8.1
BuildKitImage of the buildkit sidecar. Default is moby/buildkit:master-rootless
Port that the registry image listens on. Default is 5000
Persistence settings for the local registry
LocalRegistryPersistence configures persistence settings for the local registry
Enable enables persistence for the local registry
Size of the persistent volume for local docker registry storage. Default is 5Gi
StorageClassName of the persistent volume. Default is your cluster's configured default storage class
Enabled can be used to enable printing container logs
LastLines is the amount of lines to print of the running container initially
OpenConfig defines what to open after services have been started
URL is the url to open in the browser after it is available
PatchConfig describes a config patch and how it should be applied
Operation is the path operation to do. Can be either replace, add or remove
Path is the config path to apply the patch to
Value is the value to use for this patch.
PatchTarget describes a config patch and how it should be applied
Target describes where to apply a config patch
Operation is the path operation to do. Can be either replace, add or remove
Path is the config path to apply the patch to
Value is the value to use for this patch.
PersistenceOptions are general persistence options DevSpace should use for all persistent paths within a single dev configuration
Size is the size of the created persistent volume in Kubernetes size notation like 5Gi
StorageClassName is the storage type DevSpace should use for this persistent volume
AccessModes are the access modes DevSpace should use for the persistent volume
ReadOnly specifies if the volume should be read only
Name is the name of the PVC that should be created. If a PVC with that name already exists, DevSpace will use that PVC instead of creating one.
PersistentPath holds options to configure persistence for DevSpace
Path is the container path that should get persisted. By default, DevSpace will create an init container that will copy over the contents of this folder from the existing image.
VolumePath is the sub path on the volume that is mounted as persistent volume for this path
ReadOnly will make the persistent path read only to the user
SkipPopulate will not create an init container to copy over the existing contents if true
InitContainer holds additional options for the persistent path init container
PersistentPathInitContainer defines additional options for the persistent path init container
Resources are the resources used by the persistent path init container
Pipeline defines what DevSpace should do.
Name of the pipeline, will be filled automatically
Run is the actual shell command that should be executed during this pipeline
Flags are extra flags that can be used for running the pipeline via devspace run-pipeline.
ContinueOnError will not fail the whole job and pipeline if a call within the step fails.
PipelineFlag defines an extra pipeline flag
Name is the name of the flag
Short is optional and is the shorthand name for this flag. E.g. 'g' converts to '-g'
Type is the type of the flag. Defaults to bool
Default is the default value for this flag
Description is the description as shown in devspace run-pipeline my-pipe -h
PodResources describes the resources section of the started kaniko pod
Requests are the requests part of the resources
Limits are the limits part of the resources
PortMapping defines the ports for a PortMapping
Port is a port mapping that maps the localPort:remotePort. So if you port forward the remote port will be available at the local port. If you do reverse port forwarding, the local port will be available at the remote port in the container. If only port is specified, local and remote port are the same.
BindAddress is the address DevSpace should listen on. Optional and defaults to localhost.
GitCredentials configures a git credentials helper inside the container that proxies local git credentials
Command is the name of the command that should be available in the remote container. DevSpace will create a small script for that inside the container that redirect command execution to the local computer.
LocalCommand can be used to run a different command than specified via the command option. By default, this will be assumed to be the same as command.
SkipContainerEnv will not forward the container environment variables to the local command
Env are extra environment variables to set for the command
PullSecretConfig defines a pull secret that should be created by DevSpace
Name is the pull secret name to deploy
The registry to create the image pull secret for. Empty string == docker hub e.g. gcr.io
The username of the registry. If this is empty, devspace will try to receive the auth data from the local docker
The password to use for the registry. If this is empty, devspace will try to receive the auth data from the local docker
The optional email to use
The secret to create
The service account to add the secret to
Name is the name of the command that should be installed
VersionArgs are the arguments to retrieve the version of the command
VersionRegEx is the regex that is used to parse the version
Version constraint of the command that should be installed
DevSpace specifies the DevSpace version constraint that is needed to use this config
Commands specifies an array of commands that need to be installed locally to use this config
Plugins specifies an array of plugins that need to be installed locally
Name of the plugin that should be installed
Version constraint of the plugin that should be installed
Path defines the path to the restart helper that might be used if certain config options are enabled
Inject signals DevSpace to inject the restart helper
Enabled can be used to enable the ssh server within the container. By default,
DevSpace will generate the required keys and create an entry in your ~/.ssh/config
for this container that can be used via ssh dev-config-name.dev-project-name.devspace
LocalHostname is the local ssh host to write to the ~/.ssh/config
LocalPort is the local port to forward from, if empty will be random
RemoteAddress is the address to listen to inside the container
UseInclude tells DevSpace to use a the file ~/.ssh/devspace_config for its ssh entries. DevSpace will also create an import for its own entries inside ~/.ssh/config, this is a cleaner way, but unfortunately not all SSH clients support this.
SyncConfig defines the paths for a SyncFolder
Path is the path to sync. This can be defined in the form localPath:remotePath. You can also use '.' to specify either the local or remote working directory. This is valid for example: .:.
ExcludePaths is an array of file patterns in gitignore format to exclude.
ExcludeFile loads the file patterns to exclude from a file.
DownloadExcludePaths is an array of file patterns in gitignore format to exclude from downloading
DownloadExcludeFile loads the file patterns to exclude from downloading from a file.
UploadExcludePaths is an array of file patterns in gitignore format to exclude from uploading
UploadExcludeFile loads the file patterns to exclude from uploading from a file.
StartContainer will start the container after initial sync is done. This will inject a devspacehelper into the pod and you need to define dev.*.command for this to work.
OnUpload can be used to execute certain commands on uploading either in the container or locally as well as restart the container after a file changed has happened.
InitialSync defines the initial sync strategy to use when this sync starts. Defaults to mirrorLocal
WaitInitialSync can be used to tell DevSpace to not wait until the initial sync is done
InitialSyncCompareBy defines if the sync should only compare by the given type. Either mtime or size are possible
DisableDownload will disable downloading completely
DisableUpload will disable uploading completely
BandwidthLimits can be used to limit the amount of bytes that are transferred by DevSpace with this sync configuration
Polling will tell the remote container to use polling instead of inotify
NoWatch will terminate the sync after the initial sync is done
File signals DevSpace that this is a single file that should get synced instead of a whole directory
Name is the name to show for this exec in the logs
Command is the command to execute. If no args are specified this is executed within a shell.
Args are arguments to pass to the command
FailOnError specifies if the sync should fail if the command fails
Local specifies if the command should be executed locally instead of within the container
Once executes this command only once in the container's life. Can be used to initialize a container before starting it, but after everything was synced.
OnChange is an array of file patterns that trigger this command execution
SyncOnUpload defines the struct for the command that should be executed when files / folders are uploaded
If true restart container will try to restart the container after a change has been made. Make sure that images.*.injectRestartHelper is enabled for the container that should be restarted or the devspace-restart-helper script is present in the container root folder.
Exec will execute the given commands in order after a sync operation
Target describes where to apply a config patch
ApiVersion is the Kubernetes api of the target resource
Kind is the kind of the target resource (eg: Deployment, Service ...)
Name is the name of the target resource
Terminal describes the terminal options
Command is the command that should be executed on terminal start. This command is executed within a shell.
WorkDir is the working directory that is used to execute the command in.
If enabled is true, DevSpace will use the terminal. Can be also used to disable the terminal if set to false. DevSpace makes sure that within a pipeline only one dev configuration can open a terminal at a time and subsequent dev terminals will fail.
DisableReplace tells DevSpace to not replace the pod or adjust its settings to make sure the pod is sleeping when opening a terminal
DisableScreen will disable screen which is used by DevSpace by default to preserve sessions if connections interrupt or the session is lost.
DisableTTY will disable a tty shell for terminal command execution
Variable describes the var definition
Name is the name of the variable
Value is a shortcut for using source: none and default: my-value
Question can be used to define a custom question if the variable was not yet used
Default is the default value the variable should have if not set by the user
Options are options that can be selected when the variable question is asked
Password signals that this variable should not be visible if entered
ValidationPattern can be used to verify the user input
ValidationMessage can be used to tell the user the format of the variable value
NoCache can be used to prompt the user on every run for this variable
Command is the command how to retrieve the variable. If args is omitted, command is parsed as a shell command.
Args are optional args that will be used for the command
Commands are additional commands that can be used to run a different command on a different operating system.
AlwaysResolve makes sure this variable will always be resolved and not only if it is used somewhere. Defaults to false.
Source defines where the variable should be taken from
OperatingSystem is optional and defines the operating system this command should be executed on
Command is the command to use to retrieve the value for this variable. If no args are specified the command is run within a pseudo shell.
Args are optional arguments for the command