schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
devspace-schema.json | path | 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 '..'. | {"type": "string"} |
devspace-schema.json | mode | 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 | {"type": "integer"} |
devspace-schema.json | name | Name of the secret in the pod's namespace to use.
More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+optional | {"type": "string"} |
devspace-schema.json | items | 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 | {"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 | KanikoConfig | KanikoConfig tells the DevSpace CLI to build with Docker on Minikube or on localhost | {"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"} |
devspace-schema.json | cache | Cache tells DevSpace if a cache repository should be used. defaults to false | {"type": "boolean"} |
devspace-schema.json | snapshotMode | SnapshotMode tells DevSpace which snapshot mode kaniko should use. defaults to time | {"type": "string"} |
devspace-schema.json | image | Image is the image name of the kaniko pod to use | {"type": "string"} |
devspace-schema.json | initImage | InitImage to override the init image of the kaniko pod | {"type": "string"} |
devspace-schema.json | args | Args for additional arguments that should be passed to kaniko | {"items": {"type": "string"}, "type": "array"} |
devspace-schema.json | command | Command to replace the starting command for the kaniko container | {"items": {"type": "string"}, "type": "array"} |
devspace-schema.json | namespace | Namespace is the namespace where the kaniko pod should be run | {"type": "string"} |
devspace-schema.json | insecure | Insecure allows pushing to insecure registries | {"type": "boolean"} |
devspace-schema.json | pullSecret | PullSecret is the pull secret to mount by default | {"type": "string"} |
devspace-schema.json | skipPullSecretMount | SkipPullSecretMount will skip mounting the pull secret | {"type": "boolean"} |
devspace-schema.json | nodeSelector | NodeSelector is the node selector to use for the kaniko pod | {"patternProperties": {".*": {"type": "string"}}, "type": "object"} |
devspace-schema.json | tolerations | Tolerations is a tolerations list to use for the kaniko pod | {"items": {}, "type": "array"} |
devspace-schema.json | serviceAccount | ServiceAccount the service account to use for the kaniko pod | {"type": "string"} |
devspace-schema.json | generateName | GenerateName is the optional prefix that will be set to the generateName field of the build pod | {"type": "string"} |
devspace-schema.json | annotations | Annotations are extra annotations that will be added to the build pod | {"patternProperties": {".*": {"type": "string"}}, "type": "object"} |
devspace-schema.json | labels | Labels are extra labels that will be added to the build pod | {"patternProperties": {".*": {"type": "string"}}, "type": "object"} |
devspace-schema.json | initEnv | InitEnv are extra environment variables that will be added to the build init container | {"patternProperties": {".*": {"type": "string"}}, "type": "object"} |
devspace-schema.json | env | Env are extra environment variables that will be added to the build kaniko container
Will populate the env.value field. | {"patternProperties": {".*": {"type": "string"}}, "type": "object"} |
devspace-schema.json | envFrom | EnvFrom are extra environment variables from configmap or secret that will be added to the build kaniko container
Will populate the env.valueFrom field. | {"patternProperties": {".*": {"type": "object"}}, "type": "object"} |
devspace-schema.json | additionalMounts | AdditionalMounts are additional mounts that will be added to the build pod | {"items": {}, "type": "array"} |
devspace-schema.json | resources | Resources are the resources that should be set on the kaniko pod | {} |
devspace-schema.json | KubectlConfig | KubectlConfig defines the specific kubectl options used during deployment | {"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"} |
devspace-schema.json | manifests | Manifests is a list of files or folders that will be deployed by DevSpace using kubectl
or kustomize | {"items": {"type": "string"}, "type": "array"} |
devspace-schema.json | applyArgs | ApplyArgs are extra arguments for `kubectl apply` | {"items": {"type": "string"}, "type": "array"} |
devspace-schema.json | createArgs | CreateArgs are extra arguments for `kubectl create` which will be run before `kubectl apply` | {"items": {"type": "string"}, "type": "array"} |
devspace-schema.json | kubectlBinaryPath | KubectlBinaryPath is the optional path where to find the kubectl binary | {"type": "string"} |
devspace-schema.json | inlineManifest | InlineManifests is a block containing the manifest to deploy | {"type": "string"} |
devspace-schema.json | kustomize | Kustomize can be used to enable kustomize instead of kubectl | {"type": "boolean", "group": "kustomize", "group_name": "Kustomize"} |
devspace-schema.json | kustomizeArgs | KustomizeArgs are extra arguments for `kustomize build` which will be run before `kubectl apply` | {"items": {"type": "string"}, "type": "array", "group": "kustomize"} |
devspace-schema.json | kustomizeBinaryPath | KustomizeBinaryPath is the optional path where to find the kustomize binary | {"type": "string", "group": "kustomize"} |
devspace-schema.json | patches | Patches are additional changes to the pod spec that should be applied | {"items": {}, "type": "array", "group": "modifications"} |
devspace-schema.json | LocalRegistryConfig | LocalRegistryConfig holds the configuration of the local image registry | {"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"} |
devspace-schema.json | enabled | 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. | {"type": "boolean"} |
devspace-schema.json | localbuild | LocalBuild enables use of local docker builder instead of building in the cluster | {"type": "boolean"} |
devspace-schema.json | namespace | Namespace where the local registry is deployed. Default is the current context's namespace | {"type": "string"} |
devspace-schema.json | name | Name of the deployment and service of the local registry. Default is `registry` | {"type": "string"} |
devspace-schema.json | image | Image of the local registry. Default is `registry:2.8.1` | {"type": "string"} |
devspace-schema.json | buildKitImage | BuildKitImage of the buildkit sidecar. Default is `moby/buildkit:master-rootless` | {"type": "string"} |
devspace-schema.json | port | Port that the registry image listens on. Default is `5000` | {"type": "integer"} |
devspace-schema.json | persistence | Persistence settings for the local registry | {} |
devspace-schema.json | LocalRegistryPersistence | LocalRegistryPersistence configures persistence settings for the local registry | {"properties": {"enabled": {"type": "boolean"}, "size": {"type": "string"}, "storageClassName": {"type": "string"}}, "type": "object"} |
devspace-schema.json | enabled | Enable enables persistence for the local registry | {"type": "boolean"} |
devspace-schema.json | size | Size of the persistent volume for local docker registry storage. Default is `5Gi` | {"type": "string"} |
devspace-schema.json | storageClassName | StorageClassName of the persistent volume. Default is your cluster's configured default storage class | {"type": "string"} |
devspace-schema.json | enabled | Enabled can be used to enable printing container logs | {"type": "boolean"} |
devspace-schema.json | lastLines | LastLines is the amount of lines to print of the running container initially | {"type": "integer"} |
devspace-schema.json | OpenConfig | OpenConfig defines what to open after services have been started | {"properties": {"url": {"type": "string"}}, "type": "object"} |
devspace-schema.json | url | URL is the url to open in the browser after it is available | {"type": "string"} |
devspace-schema.json | PatchConfig | PatchConfig describes a config patch and how it should be applied | {"properties": {"op": {"type": "string"}, "path": {"type": "string"}, "value": {}}, "type": "object", "required": ["op", "path"]} |
devspace-schema.json | op | Operation is the path operation to do. Can be either replace, add or remove | {"type": "string"} |
devspace-schema.json | path | Path is the config path to apply the patch to | {"type": "string"} |
devspace-schema.json | value | Value is the value to use for this patch. | {} |
devspace-schema.json | PatchTarget | PatchTarget describes a config patch and how it should be applied | {"properties": {"target": {}, "op": {"type": "string"}, "path": {"type": "string"}, "value": {}}, "type": "object", "required": ["target", "op", "path"]} |
devspace-schema.json | target | Target describes where to apply a config patch | {} |
devspace-schema.json | op | Operation is the path operation to do. Can be either replace, add or remove | {"type": "string"} |
devspace-schema.json | path | Path is the config path to apply the patch to | {"type": "string"} |
devspace-schema.json | value | Value is the value to use for this patch. | {} |
devspace-schema.json | PersistenceOptions | PersistenceOptions are general persistence options DevSpace should use for all persistent paths within a single dev configuration | {"properties": {"size": {"type": "string"}, "storageClassName": {"type": "string"}, "accessModes": {"items": {"type": "string"}, "type": "array"}, "readOnly": {"type": "boolean"}, "name": {"type": "string"}}, "type": "object"} |
devspace-schema.json | size | Size is the size of the created persistent volume in Kubernetes size notation like 5Gi | {"type": "string"} |
devspace-schema.json | storageClassName | StorageClassName is the storage type DevSpace should use for this persistent volume | {"type": "string"} |
devspace-schema.json | accessModes | AccessModes are the access modes DevSpace should use for the persistent volume | {"items": {"type": "string"}, "type": "array"} |
devspace-schema.json | readOnly | ReadOnly specifies if the volume should be read only | {"type": "boolean"} |
devspace-schema.json | name | 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. | {"type": "string"} |
devspace-schema.json | PersistentPath | PersistentPath holds options to configure persistence for DevSpace | {"properties": {"path": {"type": "string"}, "volumePath": {"type": "string"}, "readOnly": {"type": "boolean"}, "skipPopulate": {"type": "boolean"}, "initContainer": {}}, "type": "object"} |
devspace-schema.json | path | 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. | {"type": "string"} |
devspace-schema.json | volumePath | VolumePath is the sub path on the volume that is mounted as persistent volume for this path | {"type": "string"} |
devspace-schema.json | readOnly | ReadOnly will make the persistent path read only to the user | {"type": "boolean"} |
devspace-schema.json | skipPopulate | SkipPopulate will not create an init container to copy over the existing contents if true | {"type": "boolean"} |
devspace-schema.json | initContainer | InitContainer holds additional options for the persistent path init container | {} |
devspace-schema.json | PersistentPathInitContainer | PersistentPathInitContainer defines additional options for the persistent path init container | {"properties": {"resources": {}}, "type": "object"} |
devspace-schema.json | resources | Resources are the resources used by the persistent path init container | {} |
devspace-schema.json | Pipeline | Pipeline defines what DevSpace should do. | {"properties": {"name": {"type": "string", "enum": ["dev", "deploy", "build", "purge", ".*"]}, "run": {"type": "string"}, "flags": {"items": {}, "type": "array"}, "continueOnError": {"type": "boolean"}}, "type": "object"} |
devspace-schema.json | name | Name of the pipeline, will be filled automatically | {"type": "string", "enum": ["dev", "deploy", "build", "purge", ".*"]} |
devspace-schema.json | run | Run is the actual shell command that should be executed during this pipeline | {"type": "string"} |
devspace-schema.json | flags | Flags are extra flags that can be used for running the pipeline via
devspace run-pipeline. | {"items": {}, "type": "array"} |
devspace-schema.json | continueOnError | ContinueOnError will not fail the whole job and pipeline if
a call within the step fails. | {"type": "boolean"} |
devspace-schema.json | PipelineFlag | PipelineFlag defines an extra pipeline flag | {"properties": {"name": {"type": "string"}, "short": {"type": "string"}, "type": {"type": "string", "enum": ["bool", "int", "string", "stringArray"]}, "default": {}}, "type": "object"} |
devspace-schema.json | name | Name is the name of the flag | {"type": "string"} |
devspace-schema.json | short | Short is optional and is the shorthand name for this flag. E.g. 'g' converts to '-g' | {"type": "string"} |
devspace-schema.json | type | Type is the type of the flag. Defaults to `bool` | {"type": "string", "enum": ["bool", "int", "string", "stringArray"]} |
devspace-schema.json | default | Default is the default value for this flag | {} |
devspace-schema.json | description | Description is the description as shown in `devspace run-pipeline my-pipe -h` | {"type": "string"} |
devspace-schema.json | PodResources | PodResources describes the resources section of the started kaniko pod | {"properties": {"requests": {"patternProperties": {".*": {"type": "string"}}, "type": "object"}, "limits": {"patternProperties": {".*": {"type": "string"}}, "type": "object"}}, "type": "object"} |
devspace-schema.json | requests | Requests are the requests part of the resources | {"patternProperties": {".*": {"type": "string"}}, "type": "object"} |
devspace-schema.json | limits | Limits are the limits part of the resources | {"patternProperties": {".*": {"type": "string"}}, "type": "object"} |
devspace-schema.json | PortMapping | PortMapping defines the ports for a PortMapping | {"properties": {"port": {"type": "string"}, "bindAddress": {"type": "string"}}, "type": "object", "required": ["port"]} |
devspace-schema.json | port | 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. | {"type": "string"} |
devspace-schema.json | bindAddress | BindAddress is the address DevSpace should listen on. Optional and defaults
to localhost. | {"type": "string"} |
devspace-schema.json | gitCredentials | GitCredentials configures a git credentials helper inside the container that proxies local git credentials | {"type": "boolean"} |
devspace-schema.json | command | 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. | {"type": "string"} |
devspace-schema.json | localCommand | 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. | {"type": "string"} |
devspace-schema.json | skipContainerEnv | SkipContainerEnv will not forward the container environment variables to the local command | {"type": "boolean"} |
devspace-schema.json | env | Env are extra environment variables to set for the command | {"patternProperties": {".*": {"type": "string"}}, "type": "object"} |
devspace-schema.json | PullSecretConfig | PullSecretConfig defines a pull secret that should be created by DevSpace | {"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"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.