Skip to content

Commit

Permalink
Merge pull request #1121 from LukasGentele/docs-v4.13
Browse files Browse the repository at this point in the history
docs: add v4.13
  • Loading branch information
FabianKramm authored Jun 19, 2020
2 parents c29f25a + 92e0761 commit 97b6c20
Show file tree
Hide file tree
Showing 167 changed files with 11,246 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
![Total Downloads (GitHub Releases)](https://img.shields.io/github/downloads/devspace-cloud/devspace/total?style=for-the-badge&label=Total%20Downloads&color=%23007ec6)
![NPM Installs per Month](https://img.shields.io/npm/dm/devspace?label=NPM%20Installs&style=for-the-badge&color=%23007ec6)

[![Join us on Slack!](static/img/slack.svg)](https://kubernetes.slack.com/?redir=%2Fmessages%2Fdevspace#/)
[![Join us on Slack!](static/img/slack.svg)](https://slack.k8s.io/#devspace)

### Client-Only Developer Tool for Cloud-Native Development with Kubernetes
- **Build, test and debug applications directly inside Kubernetes**
Expand Down Expand Up @@ -1198,7 +1198,7 @@ docker run --net=host --ipc=host --uts=host --pid=host -it --security-opt=seccom

Help us make DevSpace the best tool for developing, deploying and debugging Kubernetes apps.

[![Join us on Slack!](static/img/slack.svg)](https://kubernetes.slack.com/?redir=%2Fmessages%2Fdevspace#/)
[![Join us on Slack!](static/img/slack.svg)](https://slack.k8s.io/#devspace)

### Reporting Issues

Expand Down
3 changes: 1 addition & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,13 @@ If you are using GitHub pages for hosting, this command is a convenient way to b

## Creating New Versions

### 1. Generate Command Docs
### 1. Generate Command Docs
```bash
cd ../ # main project directory
go run -mod= ./hack/gen-docs.go
```

### 2. Create Version
```bash
cd website
yarn run docusaurus docs:version 4.5
```
7 changes: 4 additions & 3 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,18 @@ module.exports = {
target: '_self'
},
{
to: 'docs/introduction',
href: __webpack_public_path__ + 'docs/' + (process.env.NODE_ENV == 'production' ? '' : 'next/') + 'introduction',
label: 'Docs',
position: 'left'
position: 'left',
target: '_self'
},
{
href: 'https://devspace.cloud/blog',
label: 'Blog',
position: 'left'
},
{
href: 'https://kubernetes.slack.com/?redir=%2Fmessages%2Fdevspace#/',
href: 'https://slack.k8s.io/#devspace',
className: 'slack-link',
'aria-label': 'Slack',
position: 'right',
Expand Down
37 changes: 37 additions & 0 deletions docs/versioned_docs/version-4.13/commands/devspace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
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)
--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
40 changes: 40 additions & 0 deletions docs/versioned_docs/version-4.13/commands/devspace_add.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
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)
--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)
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
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)
--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)
```

58 changes: 58 additions & 0 deletions docs/versioned_docs/version-4.13/commands/devspace_add_image.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
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)
--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 docs/versioned_docs/version-4.13/commands/devspace_add_port.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
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)
--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 docs/versioned_docs/version-4.13/commands/devspace_add_provider.md
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)
```

Loading

0 comments on commit 97b6c20

Please sign in to comment.