Skip to content

Commit ec635fd

Browse files
author
gentele
committed
update docs
1 parent fcd7b1c commit ec635fd

7 files changed

Lines changed: 99 additions & 34 deletions

File tree

docs/docs/cli/add.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: devspace add
3+
---
4+
5+
With `devspace add`, you can add ports for portForwarding and paths to the sync configuration.
6+
7+
```bash
8+
Usage:
9+
devspace add [command]
10+
11+
Available Commands:
12+
port Lists port forwarding configuration
13+
sync Add a sync path to the devspace
14+
15+
Flags:
16+
-h, --help help for add
17+
```

docs/docs/cli/init.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Flags:
1313
-l, --language string Programming language of your project
1414
-o, --overwrite Overwrite existing chart files and Dockerfile
1515
-r, --reconfigure Change existing configuration
16-
--templateRepoPath string Local path for cloning chart template repository (uses temp
17-
folder if not specified)
16+
--templateRepoPath string Local path for cloning chart template repository (uses temp folder
17+
if not specified)
1818
--templateRepoUrl string Git repository for chart templates (default "https://github.com/covexo/devspace-templates.git")
1919
```
2020

docs/docs/cli/remove.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: devspace remove
3+
---
4+
5+
With `devspace remove`, you can remove ports from the portForwarding and paths from the sync configuration.
6+
7+
```bash
8+
Usage:
9+
devspace remove [command]
10+
11+
Available Commands:
12+
port Removes forwarded ports from a devspace
13+
sync Remove sync paths from the devspace
14+
15+
Flags:
16+
-h, --help help for remove
17+
```

docs/docs/cli/up.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ Usage:
99
devspace up [flags]
1010

1111
Flags:
12-
-b, --build Build image if Dockerfile has been modified (default true)
13-
-h, --help help for up
14-
--init-registry Install or upgrade Docker registry (default true)
15-
--no-sleep Enable no-sleep
16-
-o, --open string Install/upgrade tiller (default "cmd")
17-
--portforwarding Enable port forwarding (default true)
18-
-s, --shell string Shell command (default: bash, fallback: sh)
19-
--sync Enable code synchronization (default true)
20-
--tiller Install/upgrade tiller (default true)
12+
-b, --build Build image if Dockerfile has been modified (default true)
13+
-d, --deploy Deploy chart
14+
-h, --help help for up
15+
--init-registries Initialize registries (and install internal one) (default true)
16+
--no-sleep Enable no-sleep
17+
--portforwarding Enable port forwarding (default true)
18+
-s, --shell string Shell command (default: bash, fallback: sh)
19+
--sync Enable code synchronization (default true)
20+
--tiller Install/upgrade tiller (default true)
2121
```
2222
2323
**Note**: Every time you run `devspace up`, your containers will be re-deployed. This way, you will always start with a clean state.

docs/docs/configuration/config.yaml.md

Lines changed: 50 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ This is an example of a [.devspace/config.yaml](#)
77
version: v1
88
devSpace:
99
release:
10-
name: devspace-cloud-com
11-
namespace: dev-gentele
10+
name: my-project
11+
namespace: my-namespace
1212
portForwarding:
1313
- resourceType: pod
1414
labelSelector:
@@ -24,23 +24,43 @@ devSpace:
2424
release: my-app
2525
localSubPath: ./
2626
containerPath: /app
27-
image:
28-
name: devspace
29-
services:
30-
registry:
31-
internal:
32-
release:
33-
name: devspace-registry
34-
namespace: dev-gentele
27+
images:
28+
default:
29+
name: devspace-user/devspace
30+
tag: 9u5ye0G
31+
registry: default
32+
build:
33+
engine:
34+
docker:
35+
enabled: true
36+
preferMinikube: true
37+
database:
38+
name: devspace-user/devspace
39+
tag: 62i5e2p
40+
registry: internal
41+
build:
42+
engine:
43+
kaniko:
44+
enabled: true
45+
registries:
46+
default:
47+
url: hub.docker.com
48+
internal:
3549
user:
3650
username: user-XXXXX
3751
password: XXXXXXXXXX
52+
services:
53+
internalRegistry:
54+
release:
55+
name: devspace-registry
56+
namespace: my-namespace
3857
tiller:
58+
appNamespaces:
59+
- my-namespace
3960
release:
40-
namespace: dev-gentele
61+
namespace: my-namespace
4162
cluster:
4263
useKubeConfig: true
43-
4464
```
4565
A [.devspace/config.yaml](#) contains any public/shared configuration for running a DevSpace for the respective project. It is highly recommended to put this file under version control (e.g. git add).
4666
@@ -72,22 +92,31 @@ To comfortably sync code to a DevSpace, the DevSpace CLI allows to configure rea
7292

7393
In the example above, the entire code within the project would be synchronized with the folder `/app` inside the DevSpace.
7494

75-
## image
76-
An image is defined by:
95+
## images
96+
This section of the config defines a map of images that can be used in the helm chart that is deployed during `devspace up`. An image is defined by:
7797
- `name` of the image that is being pushed to the registry
7898
- `tag` stating the latest tag pushed to the registry
79-
- `buildTime` (time of the latest image build process, i.e. docker build)
99+
- `registry` referencing one of the keys defined in the `registries` map
100+
- `build` defining the build procedure for this image
80101

81-
## services
82-
Defines additional services for your DevSpace.
102+
## images[*].build
103+
An image build is mainly defined by the build engine. There are 2 build engines currently supported:
104+
- `docker` uses the local Docker daemon or a Docker daemon running inside a Minikube cluster (if `preferMinikube` == true)
105+
- `kaniko` builds images in userspace within a build pod running inside the Kubernetes cluster
83106

84-
### services.registry
85-
The `registry` field specifies:
86-
- `external` tells the DevSpace CLI to push to an external registry (format: myregistry.com:port)
87-
- `internal` defines a private cluster-internal registry by defining a `release` for it
107+
## registries
108+
This section of the config defines a map of image registries. You can use any external registry or link to the [services.internalRegistry](#services-internal-registry)
109+
- `url` of the registry (format: myregistry.com:port)
88110
- `user` credentials (`username`, `password`) for pushing to / pulling from the registry
89111
- `insecure` flag to allow pushing to registries without HTTPS
90112

113+
## services
114+
Defines additional services for your DevSpace.
115+
116+
### services.internalRegistry
117+
The `internalRegistry` is used to tell the DevSpace CLI to deploy a private registry inside the Kubernetes cluster:
118+
- `release` for deploying the registry (see [Type: Release](#type-release))
119+
91120
### services.tiller
92121
The `tiller` service is defined by:
93122
- `release` definition for tiller (see [Type: Release](#type-release))

docs/docs/configuration/dockerfile.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: /Dockerfile
33
---
44

5-
The Dockerfile specifies how your main development image has to be built. You can add files, install dependencies, set environment variables and run any other command.
5+
A Dockerfile specifies how a build engine (e.g. Docker or kaniko) will assemble a Docker image. You can add files, install dependencies, set environment variables and run any other command.
66

7-
When you run `devspace init` or `devspace up`, the DevSpace CLI will add an exemplary Dockerfile for your project. You can modify the Dockerfile according to your needs.
7+
When you run `devspace init` or `devspace up`, the DevSpace CLI will add an exemplary Dockerfile for your project if you do not already have one, yet. You can modify the Dockerfile according to your needs. You can also have multiple Dockerfiles within your project and let the DevSpace CLI build and push them accordingly (see [config.yaml](config.ymal.html)).
88

99
See the official Docker documentation for **"[Best practices for writing Dockerfiles](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/)"**
1010

docs/website/sidebars.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
"cli/up",
1414
"cli/down",
1515
"cli/reset",
16+
"cli/add",
17+
"cli/remove",
1618
"cli/install",
1719
"cli/upgrade"
1820
],

0 commit comments

Comments
 (0)