You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/configuration/config.yaml.md
+50-21Lines changed: 50 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,8 +7,8 @@ This is an example of a [.devspace/config.yaml](#)
7
7
version: v1
8
8
devSpace:
9
9
release:
10
-
name: devspace-cloud-com
11
-
namespace: dev-gentele
10
+
name: my-project
11
+
namespace: my-namespace
12
12
portForwarding:
13
13
- resourceType: pod
14
14
labelSelector:
@@ -24,23 +24,43 @@ devSpace:
24
24
release: my-app
25
25
localSubPath: ./
26
26
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:
35
49
user:
36
50
username: user-XXXXX
37
51
password: XXXXXXXXXX
52
+
services:
53
+
internalRegistry:
54
+
release:
55
+
name: devspace-registry
56
+
namespace: my-namespace
38
57
tiller:
58
+
appNamespaces:
59
+
- my-namespace
39
60
release:
40
-
namespace: dev-gentele
61
+
namespace: my-namespace
41
62
cluster:
42
63
useKubeConfig: true
43
-
44
64
```
45
65
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).
46
66
@@ -72,22 +92,31 @@ To comfortably sync code to a DevSpace, the DevSpace CLI allows to configure rea
72
92
73
93
In the example above, the entire code within the project would be synchronized with the folder `/app` inside the DevSpace.
74
94
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:
77
97
- `name`of the image that is being pushed to the registry
78
98
- `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
80
101
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
83
106
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)
88
110
- `user`credentials (`username`, `password`) for pushing to / pulling from the registry
89
111
- `insecure`flag to allow pushing to registries without HTTPS
90
112
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
+
91
120
### services.tiller
92
121
The `tiller` service is defined by:
93
122
- `release` definition for tiller (see [Type: Release](#type-release))
Copy file name to clipboardExpand all lines: docs/docs/configuration/dockerfile.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@
2
2
title: /Dockerfile
3
3
---
4
4
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.
6
6
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)).
8
8
9
9
See the official Docker documentation for **"[Best practices for writing Dockerfiles](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/)"**
0 commit comments