Skip to content

Commit 67ebe29

Browse files
committed
Improve full config.yaml example
1 parent 550128c commit 67ebe29

1 file changed

Lines changed: 8 additions & 10 deletions

File tree

docs/docs/configuration/config.yaml.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,7 @@ devSpace:
180180
# Label selector to select the correct pods
181181
labelSelector:
182182
release: devspace-default
183+
# What to deploy within your project
183184
deployments:
184185
- name: devspace-default # this is also the release name, when using helm as deployment method
185186
helm:
@@ -194,12 +195,10 @@ devSpace:
194195
- kube/additional/*
195196
# Automatically forwarded ports on `devspace up` (same functionality as running manually kubectl port-forward)
196197
portForwarding:
197-
# Currently only pod is supported
198-
- resourceType: pod
199198
# Map of key value matchLabel selectors
200-
labelSelector:
201-
release: my-app
202-
# namespace where to select the pods from
199+
- labelSelector:
200+
release: devspace-default
201+
# optional namespace where to select the pods from
203202
namespace: my-namespace
204203
# Array of port mappings
205204
portMappings:
@@ -211,8 +210,7 @@ devSpace:
211210
remotePort: 80
212211
sync:
213212
# Currently only resource type pod is supported
214-
- resourceType: pod
215-
labelSelector:
213+
- labelSelector:
216214
release: devspace-default
217215
# The container within the pod to sync to
218216
containerName: default
@@ -223,7 +221,7 @@ devSpace:
223221
# Exclude node_modules from up and download
224222
excludePaths:
225223
- node_modules/
226-
# A list of images that should be build during devspace up
224+
# A map of images that should be build during devspace up
227225
images:
228226
default:
229227
# Image name with prefixed docker image registry
@@ -256,7 +254,7 @@ images:
256254
privateRegistryImage:
257255
name: user/test
258256
registry: privateRegistry
259-
# The registries the images should be pushed to
257+
# Optional: the registries the images should be pushed to
260258
registries:
261259
# Internal registry that will be automatically deployed to the target
262260
# cluster if desired
@@ -271,7 +269,7 @@ registries:
271269
auth:
272270
username: user-XXXXX
273271
password: XXXXXXXXXX # Can also be a token
274-
# Optional: The deployed internal registry within the cluster
272+
# Optional: Deploy internal registry within the cluster
275273
internalRegistry:
276274
deploy: true
277275
# Optional: Tiller server that should be used within the cluster (only necessary if you want to use helm as deployment)

0 commit comments

Comments
 (0)