schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
devspace-schema.json | name | Name is the pull secret name to deploy | {"type": "string"} |
devspace-schema.json | registry | The registry to create the image pull secret for.
Empty string == docker hub
e.g. gcr.io | {"type": "string"} |
devspace-schema.json | username | The username of the registry. If this is empty, devspace will try
to receive the auth data from the local docker | {"type": "string"} |
devspace-schema.json | password | The password to use for the registry. If this is empty, devspace will
try to receive the auth data from the local docker | {"type": "string"} |
devspace-schema.json | email | The optional email to use | {"type": "string"} |
devspace-schema.json | secret | The secret to create | {"type": "string"} |
devspace-schema.json | serviceAccounts | The service account to add the secret to | {"items": {"type": "string"}, "type": "array"} |
devspace-schema.json | name | Name is the name of the command that should be installed | {"type": "string"} |
devspace-schema.json | versionArgs | VersionArgs are the arguments to retrieve the version of the command | {"items": {"type": "string"}, "type": "array"} |
devspace-schema.json | versionRegEx | VersionRegEx is the regex that is used to parse the version | {"type": "string"} |
devspace-schema.json | version | Version constraint of the command that should be installed | {"type": "string"} |
devspace-schema.json | devspace | DevSpace specifies the DevSpace version constraint that is needed to use this config | {"type": "string"} |
devspace-schema.json | commands | Commands specifies an array of commands that need to be installed locally to use this config | {"items": {}, "type": "array"} |
devspace-schema.json | plugins | Plugins specifies an array of plugins that need to be installed locally | {"items": {}, "type": "array"} |
devspace-schema.json | name | Name of the plugin that should be installed | {"type": "string"} |
devspace-schema.json | version | Version constraint of the plugin that should be installed | {"type": "string"} |
devspace-schema.json | path | Path defines the path to the restart helper that might be used if certain config
options are enabled | {"type": "string"} |
devspace-schema.json | inject | Inject signals DevSpace to inject the restart helper | {"type": "boolean"} |
devspace-schema.json | enabled | 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` | {"type": "boolean"} |
devspace-schema.json | localHostname | LocalHostname is the local ssh host to write to the ~/.ssh/config | {"type": "string"} |
devspace-schema.json | localPort | LocalPort is the local port to forward from, if empty will be random | {"type": "integer"} |
devspace-schema.json | remoteAddress | RemoteAddress is the address to listen to inside the container | {"type": "string"} |
devspace-schema.json | useInclude | 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. | {"type": "boolean"} |
devspace-schema.json | SyncConfig | SyncConfig defines the paths for a SyncFolder | {"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"} |
devspace-schema.json | path | 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: .:. | {"type": "string"} |
devspace-schema.json | excludePaths | ExcludePaths is an array of file patterns in gitignore format to exclude. | {"items": {"type": "string"}, "type": "array", "group": "exclude", "group_name": "Exclude Paths From File Sync"} |
devspace-schema.json | excludeFile | ExcludeFile loads the file patterns to exclude from a file. | {"type": "string", "group": "exclude"} |
devspace-schema.json | downloadExcludePaths | DownloadExcludePaths is an array of file patterns in gitignore format to exclude from downloading | {"items": {"type": "string"}, "type": "array", "group": "exclude"} |
devspace-schema.json | downloadExcludeFile | DownloadExcludeFile loads the file patterns to exclude from downloading from a file. | {"type": "string", "group": "exclude"} |
devspace-schema.json | uploadExcludePaths | UploadExcludePaths is an array of file patterns in gitignore format to exclude from uploading | {"items": {"type": "string"}, "type": "array", "group": "exclude"} |
devspace-schema.json | uploadExcludeFile | UploadExcludeFile loads the file patterns to exclude from uploading from a file. | {"type": "string", "group": "exclude"} |
devspace-schema.json | startContainer | 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. | {"type": "boolean", "group": "actions", "group_name": "Sync-Triggered Actions"} |
devspace-schema.json | onUpload | 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. | {"group": "actions"} |
devspace-schema.json | initialSync | InitialSync defines the initial sync strategy to use when this sync starts. Defaults to mirrorLocal | {"type": "string", "group": "initial_sync", "group_name": "Initial Sync"} |
devspace-schema.json | waitInitialSync | WaitInitialSync can be used to tell DevSpace to not wait until the initial sync is done | {"type": "boolean", "group": "initial_sync"} |
devspace-schema.json | initialSyncCompareBy | InitialSyncCompareBy defines if the sync should only compare by the given type. Either mtime or size are possible | {"type": "string", "group": "initial_sync"} |
devspace-schema.json | disableDownload | DisableDownload will disable downloading completely | {"type": "boolean", "group": "one_direction", "group_name": "One-Directional Sync"} |
devspace-schema.json | disableUpload | DisableUpload will disable uploading completely | {"type": "boolean", "group": "one_direction"} |
devspace-schema.json | bandwidthLimits | BandwidthLimits can be used to limit the amount of bytes that are transferred by DevSpace with this
sync configuration | {} |
devspace-schema.json | polling | Polling will tell the remote container to use polling instead of inotify | {"type": "boolean"} |
devspace-schema.json | noWatch | NoWatch will terminate the sync after the initial sync is done | {"type": "boolean"} |
devspace-schema.json | file | File signals DevSpace that this is a single file that should get synced instead of a whole directory | {"type": "boolean"} |
devspace-schema.json | name | Name is the name to show for this exec in the logs | {"type": "string"} |
devspace-schema.json | command | Command is the command to execute. If no args are specified this is executed
within a shell. | {"type": "string"} |
devspace-schema.json | args | Args are arguments to pass to the command | {"items": {"type": "string"}, "type": "array"} |
devspace-schema.json | failOnError | FailOnError specifies if the sync should fail if the command fails | {"type": "boolean"} |
devspace-schema.json | local | Local specifies if the command should be executed locally instead of within the
container | {"type": "boolean"} |
devspace-schema.json | once | 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. | {"type": "boolean"} |
devspace-schema.json | onChange | OnChange is an array of file patterns that trigger this command execution | {"items": {"type": "string"}, "type": "array"} |
devspace-schema.json | SyncOnUpload | SyncOnUpload defines the struct for the command that should be executed when files / folders are uploaded | {"properties": {"restartContainer": {"type": "boolean"}, "exec": {"items": {}, "type": "array"}}, "type": "object"} |
devspace-schema.json | restartContainer | 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. | {"type": "boolean"} |
devspace-schema.json | exec | Exec will execute the given commands in order after a sync operation | {"items": {}, "type": "array"} |
devspace-schema.json | Target | Target describes where to apply a config patch | {"properties": {"apiVersion": {"type": "string"}, "kind": {"type": "string"}, "name": {"type": "string"}}, "type": "object", "required": ["apiVersion", "kind", "name"]} |
devspace-schema.json | apiVersion | ApiVersion is the Kubernetes api of the target resource | {"type": "string"} |
devspace-schema.json | kind | Kind is the kind of the target resource (eg: Deployment, Service ...) | {"type": "string"} |
devspace-schema.json | name | Name is the name of the target resource | {"type": "string"} |
devspace-schema.json | Terminal | Terminal describes the terminal options | {"properties": {"command": {"type": "string"}, "workDir": {"type": "string"}, "enabled": {"type": "boolean"}, "disableReplace": {"type": "boolean"}, "disableScreen": {"type": "boolean"}, "disableTTY": {"type": "boolean"}}, "type": "object"} |
devspace-schema.json | command | Command is the command that should be executed on terminal start.
This command is executed within a shell. | {"type": "string"} |
devspace-schema.json | workDir | WorkDir is the working directory that is used to execute the command in. | {"type": "string"} |
devspace-schema.json | enabled | 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. | {"type": "boolean"} |
devspace-schema.json | disableReplace | DisableReplace tells DevSpace to not replace the pod or adjust its settings
to make sure the pod is sleeping when opening a terminal | {"type": "boolean"} |
devspace-schema.json | disableScreen | DisableScreen will disable screen which is used by DevSpace by default to preserve
sessions if connections interrupt or the session is lost. | {"type": "boolean"} |
devspace-schema.json | disableTTY | DisableTTY will disable a tty shell for terminal command execution | {"type": "boolean"} |
devspace-schema.json | Variable | Variable describes the var definition | {"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"} |
devspace-schema.json | name | Name is the name of the variable | {"type": "string"} |
devspace-schema.json | value | Value is a shortcut for using source: none and default: my-value | {"oneOf": [{"type": "string"}, {"type": "integer"}, {"type": "boolean"}], "group": "static", "group_name": "Static Value"} |
devspace-schema.json | question | Question can be used to define a custom question if the variable was not yet used | {"type": "string", "group": "question", "group_name": "Value From Input (Question)"} |
devspace-schema.json | default | Default is the default value the variable should have if not set by the user | {"oneOf": [{"type": "string"}, {"type": "integer"}, {"type": "boolean"}], "group": "question"} |
devspace-schema.json | options | Options are options that can be selected when the variable question is asked | {"items": {"type": "string"}, "type": "array", "group": "question"} |
devspace-schema.json | password | Password signals that this variable should not be visible if entered | {"type": "boolean", "group": "question"} |
devspace-schema.json | validationPattern | ValidationPattern can be used to verify the user input | {"type": "string", "group": "question"} |
devspace-schema.json | validationMessage | ValidationMessage can be used to tell the user the format of the variable value | {"type": "string", "group": "question"} |
devspace-schema.json | noCache | NoCache can be used to prompt the user on every run for this variable | {"type": "boolean", "group": "question"} |
devspace-schema.json | command | Command is the command how to retrieve the variable. If args is omitted, command is parsed as a shell
command. | {"type": "string", "group": "execution", "group_name": "Value From Command"} |
devspace-schema.json | args | Args are optional args that will be used for the command | {"items": {"type": "string"}, "type": "array", "group": "execution"} |
devspace-schema.json | commands | Commands are additional commands that can be used to run a different command on a different operating
system. | {"items": {}, "type": "array", "group": "execution"} |
devspace-schema.json | alwaysResolve | AlwaysResolve makes sure this variable will always be resolved and not only if it is used somewhere. Defaults to false. | {"type": "boolean"} |
devspace-schema.json | source | Source defines where the variable should be taken from | {"type": "string", "enum": ["all", "env", "input", "command", "none"]} |
devspace-schema.json | os | OperatingSystem is optional and defines the operating system this
command should be executed on | {"type": "string"} |
devspace-schema.json | command | 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. | {"type": "string"} |
devspace-schema.json | args | Args are optional arguments for the command | {"items": {"type": "string"}, "type": "array"} |
devspace-schema.json | version | 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. | {"type": "string"} |
devspace-schema.json | name | 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. | {"type": "string"} |
devspace-schema.json | imports | 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. | {"items": {}, "type": "array"} |
devspace-schema.json | functions | Functions are POSIX functions that can be used within pipelines. Those functions can also be imported by
imports. | {"patternProperties": {".*": {"type": "string"}}, "type": "object"} |
devspace-schema.json | pipelines | 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. | {"anyOf": [{"patternProperties": {".*": {"type": "string"}}, "type": "object"}, {"patternProperties": {".*": {}}, "type": "object"}, {"type": "object"}], "type": "object"} |
devspace-schema.json | images | 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. | {"patternProperties": {".*": {}}, "type": "object"} |
devspace-schema.json | deployments | 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. | {"patternProperties": {".*": {}}, "type": "object"} |
devspace-schema.json | dev | 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 | {"patternProperties": {".*": {}}, "type": "object"} |
devspace-schema.json | vars | Vars are config variables that can be used inside other config sections to replace certain values dynamically | {"anyOf": [{"patternProperties": {".*": {"type": "string"}}, "type": "object"}, {"patternProperties": {".*": {}}, "type": "object"}, {"type": "object"}], "type": "object"} |
devspace-schema.json | commands | 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. | {"anyOf": [{"patternProperties": {".*": {"type": "string"}}, "type": "object"}, {"patternProperties": {".*": {}}, "type": "object"}, {"type": "object"}], "type": "object"} |
devspace-schema.json | dependencies | 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. | {"patternProperties": {".*": {}}, "type": "object"} |
devspace-schema.json | pullSecrets | 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. | {"patternProperties": {".*": {}}, "type": "object"} |
devspace-schema.json | require | Require defines what DevSpace, plugins and command versions are required to use this config and if a condition is not
fulfilled, DevSpace will fail. | {} |
devspace-schema.json | localRegistry | LocalRegistry specifies the configuration for a local image registry | {} |
typingsrc.json | ca | A string or array of strings of trusted certificates in PEM format | {"type": ["array", "string"], "items": {"type": "string"}} |
typingsrc.json | cert | Public x509 certificate to use | {"type": "string"} |
typingsrc.json | defaultSource | Override the default installation source (e.g., when doing 'typings install debug') | {"type": "string", "default": "npm", "enum": ["file", "npm", "github", "bitbucket", "bower", "http", "https"]} |
typingsrc.json | githubToken | Set your GitHub for resolving 'github:' locations | {"type": "string"} |
typingsrc.json | httpProxy | The proxy to use for HTTP requests | {"type": "string"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.