-
Notifications
You must be signed in to change notification settings - Fork 368
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b23879a
commit e911f65
Showing
188 changed files
with
12,657 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
title: "Command - devspace" | ||
sidebar_label: devspace | ||
--- | ||
|
||
## devspace | ||
|
||
Welcome to the DevSpace! | ||
|
||
### Synopsis | ||
|
||
DevSpace accelerates developing, deploying and debugging applications with Docker and Kubernetes. Get started by running the init command in one of your projects: | ||
|
||
devspace init | ||
|
||
### Options | ||
|
||
``` | ||
--config string The devspace config file to use | ||
--debug Prints the stack trace if an error occurs | ||
-h, --help help for devspace | ||
--kube-context string The kubernetes context to use | ||
-n, --namespace string The kubernetes namespace to use | ||
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before | ||
-p, --profile string The devspace profile to use (if there is any) | ||
--profile-refresh If true will pull and re-download profile parent sources | ||
--silent Run in silent mode and prevents any devspace log output except panics & fatals | ||
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project | ||
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE) | ||
``` | ||
|
||
``` | ||
``` | ||
|
||
|
||
## Flags | ||
## Global & Inherited Flags |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
title: "Command - devspace add" | ||
sidebar_label: devspace add | ||
--- | ||
|
||
|
||
Convenience command: adds something to devspace.yaml | ||
|
||
## Synopsis | ||
|
||
|
||
``` | ||
####################################################### | ||
#################### devspace add ##################### | ||
####################################################### | ||
Adds config sections to devspace.yaml | ||
``` | ||
|
||
|
||
## Flags | ||
|
||
``` | ||
-h, --help help for add | ||
``` | ||
|
||
|
||
## Global & Inherited Flags | ||
|
||
``` | ||
--config string The devspace config file to use | ||
--debug Prints the stack trace if an error occurs | ||
--kube-context string The kubernetes context to use | ||
-n, --namespace string The kubernetes namespace to use | ||
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before | ||
-p, --profile string The devspace profile to use (if there is any) | ||
--profile-refresh If true will pull and re-download profile parent sources | ||
--silent Run in silent mode and prevents any devspace log output except panics & fatals | ||
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project | ||
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE) | ||
``` | ||
|
70 changes: 70 additions & 0 deletions
70
docs/versioned_docs/version-5.3/commands/devspace_add_deployment.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
--- | ||
title: "Command - devspace add deployment" | ||
sidebar_label: devspace add deployment | ||
--- | ||
|
||
|
||
Adds a deployment to devspace.yaml | ||
|
||
## Synopsis | ||
|
||
|
||
``` | ||
devspace add deployment [deployment-name] [flags] | ||
``` | ||
|
||
``` | ||
####################################################### | ||
############# devspace add deployment ################# | ||
####################################################### | ||
Adds a new deployment to this project's devspace.yaml | ||
Examples: | ||
# Deploy a predefined component | ||
devspace add deployment my-deployment --component=mysql | ||
# Deploy a local dockerfile | ||
devspace add deployment my-deployment --dockerfile=./Dockerfile | ||
devspace add deployment my-deployment --image=myregistry.io/myuser/myrepo --dockerfile=frontend/Dockerfile --context=frontend/Dockerfile | ||
# Deploy an existing docker image | ||
devspace add deployment my-deployment --image=mysql | ||
devspace add deployment my-deployment --image=myregistry.io/myusername/mysql | ||
# Deploy local or remote helm charts | ||
devspace add deployment my-deployment --chart=chart/ | ||
devspace add deployment my-deployment --chart=stable/mysql | ||
# Deploy local kubernetes yamls | ||
devspace add deployment my-deployment --manifests=kube/pod.yaml | ||
devspace add deployment my-deployment --manifests=kube/* --namespace=devspace | ||
####################################################### | ||
``` | ||
|
||
|
||
## Flags | ||
|
||
``` | ||
--chart string A helm chart to deploy (e.g. ./chart or stable/mysql) | ||
--chart-repo string The helm chart repository url to use | ||
--chart-version string The helm chart version to use | ||
--component devspace list available-components A predefined component to use (run devspace list available-components to see all available components) | ||
--context string | ||
--dockerfile string A dockerfile | ||
-h, --help help for deployment | ||
--image string A docker image to deploy (e.g. dscr.io/myuser/myrepo or dockeruser/repo:0.1 or mysql:latest) | ||
--manifests string The kubernetes manifests to deploy (glob pattern are allowed, comma separated, e.g. manifests/** or kube/pod.yaml) | ||
``` | ||
|
||
|
||
## Global & Inherited Flags | ||
|
||
``` | ||
--config string The devspace config file to use | ||
--debug Prints the stack trace if an error occurs | ||
--kube-context string The kubernetes context to use | ||
-n, --namespace string The kubernetes namespace to use | ||
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before | ||
-p, --profile string The devspace profile to use (if there is any) | ||
--profile-refresh If true will pull and re-download profile parent sources | ||
--silent Run in silent mode and prevents any devspace log output except panics & fatals | ||
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project | ||
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE) | ||
``` | ||
|
59 changes: 59 additions & 0 deletions
59
docs/versioned_docs/version-5.3/commands/devspace_add_image.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
title: "Command - devspace add image" | ||
sidebar_label: devspace add image | ||
--- | ||
|
||
|
||
Add an image | ||
|
||
## Synopsis | ||
|
||
|
||
``` | ||
devspace add image [flags] | ||
``` | ||
|
||
``` | ||
####################################################### | ||
############# devspace add image ###################### | ||
####################################################### | ||
Adds a new image to this project's devspace.yaml | ||
Examples: | ||
devspace add image my-image --image=dockeruser/devspaceimage2 | ||
devspace add image my-image --image=dockeruser/devspaceimage2 --tag=alpine | ||
devspace add image my-image --image=dockeruser/devspaceimage2 --context=./context | ||
devspace add image my-image --image=dockeruser/devspaceimage2 --dockerfile=./Dockerfile | ||
devspace add image my-image --image=dockeruser/devspaceimage2 --buildtool=docker | ||
devspace add image my-image --image=dockeruser/devspaceimage2 --buildtool=kaniko | ||
####################################################### | ||
``` | ||
|
||
|
||
## Flags | ||
|
||
``` | ||
--buildtool string Specify which engine should build the file. Should match this regex: docker|kaniko | ||
--context string The path of the images' context | ||
--dockerfile string The path of the images' dockerfile | ||
-h, --help help for image | ||
--image string The image name of the image (e.g. myusername/devspace) | ||
--tag string The tag of the image | ||
``` | ||
|
||
|
||
## Global & Inherited Flags | ||
|
||
``` | ||
--config string The devspace config file to use | ||
--debug Prints the stack trace if an error occurs | ||
--kube-context string The kubernetes context to use | ||
-n, --namespace string The kubernetes namespace to use | ||
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before | ||
-p, --profile string The devspace profile to use (if there is any) | ||
--profile-refresh If true will pull and re-download profile parent sources | ||
--silent Run in silent mode and prevents any devspace log output except panics & fatals | ||
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project | ||
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE) | ||
``` | ||
|
49 changes: 49 additions & 0 deletions
49
docs/versioned_docs/version-5.3/commands/devspace_add_plugin.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
title: "Command - devspace add plugin" | ||
sidebar_label: devspace add plugin | ||
--- | ||
|
||
|
||
Add a plugin to devspace | ||
|
||
## Synopsis | ||
|
||
|
||
``` | ||
devspace add plugin [flags] | ||
``` | ||
|
||
``` | ||
####################################################### | ||
############### devspace add plugin ################### | ||
####################################################### | ||
Adds a new plugin to devspace | ||
devspace add plugin https://github.com/my-plugin/plugin | ||
####################################################### | ||
``` | ||
|
||
|
||
## Flags | ||
|
||
``` | ||
-h, --help help for plugin | ||
--version string The git tag to use | ||
``` | ||
|
||
|
||
## Global & Inherited Flags | ||
|
||
``` | ||
--config string The devspace config file to use | ||
--debug Prints the stack trace if an error occurs | ||
--kube-context string The kubernetes context to use | ||
-n, --namespace string The kubernetes namespace to use | ||
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before | ||
-p, --profile string The devspace profile to use (if there is any) | ||
--profile-refresh If true will pull and re-download profile parent sources | ||
--silent Run in silent mode and prevents any devspace log output except panics & fatals | ||
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project | ||
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE) | ||
``` | ||
|
50 changes: 50 additions & 0 deletions
50
docs/versioned_docs/version-5.3/commands/devspace_add_port.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
title: "Command - devspace add port" | ||
sidebar_label: devspace add port | ||
--- | ||
|
||
|
||
Add a new port forward configuration | ||
|
||
## Synopsis | ||
|
||
|
||
``` | ||
devspace add port [flags] | ||
``` | ||
|
||
``` | ||
####################################################### | ||
################ devspace add port #################### | ||
####################################################### | ||
Add a new port mapping to this project's devspace.yaml | ||
Format is port(:remotePort) comma separated, e.g. | ||
devspace add port 8080:80,3000 | ||
####################################################### | ||
``` | ||
|
||
|
||
## Flags | ||
|
||
``` | ||
-h, --help help for port | ||
--label-selector string Comma separated key=value label-selector list (e.g. release=test) | ||
``` | ||
|
||
|
||
## Global & Inherited Flags | ||
|
||
``` | ||
--config string The devspace config file to use | ||
--debug Prints the stack trace if an error occurs | ||
--kube-context string The kubernetes context to use | ||
-n, --namespace string The kubernetes namespace to use | ||
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before | ||
-p, --profile string The devspace profile to use (if there is any) | ||
--profile-refresh If true will pull and re-download profile parent sources | ||
--silent Run in silent mode and prevents any devspace log output except panics & fatals | ||
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project | ||
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE) | ||
``` | ||
|
49 changes: 49 additions & 0 deletions
49
docs/versioned_docs/version-5.3/commands/devspace_add_provider.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
title: "Command - devspace add provider" | ||
sidebar_label: devspace add provider | ||
--- | ||
|
||
|
||
Adds a new cloud provider to the configuration | ||
|
||
## Synopsis | ||
|
||
|
||
``` | ||
devspace add provider [flags] | ||
``` | ||
|
||
``` | ||
####################################################### | ||
############## devspace add provider ################## | ||
####################################################### | ||
Add a new cloud provider. | ||
Example: | ||
devspace add provider app.devspace.cloud | ||
####################################################### | ||
``` | ||
|
||
|
||
## Flags | ||
|
||
``` | ||
-h, --help help for provider | ||
--host string The URL DevSpace should use for this provider | ||
``` | ||
|
||
|
||
## Global & Inherited Flags | ||
|
||
``` | ||
--config string The devspace config file to use | ||
--debug Prints the stack trace if an error occurs | ||
--kube-context string The kubernetes context to use | ||
-n, --namespace string The kubernetes namespace to use | ||
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before | ||
-p, --profile string The devspace profile to use (if there is any) | ||
--silent Run in silent mode and prevents any devspace log output except panics & fatals | ||
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project | ||
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE) | ||
``` | ||
|
Oops, something went wrong.