diff --git a/README.md b/README.md index 9ab713295c..b1c927d036 100644 --- a/README.md +++ b/README.md @@ -62,8 +62,8 @@ Take a look at the [Getting Started Guide](https://devspace.covexo.com/docs/gett Here you can find some links to the most important pages of our documentation: - [Getting Started Guide](https://devspace.covexo.com/docs/getting-started/quickstart.html) - [Frequently Asked Questions (FAQ)](https://devspace.covexo.com/docs/getting-started/faq.html) +- [DevSpace Configuration Options](https://devspace.covexo.com/docs/configuration/config.yaml.html) - [CLI Documentation](https://devspace.covexo.com/docs/cli/init.html) -- [Configuration Options](https://devspace.covexo.com/docs/configuration/dockerfile.html) - [Architecture Documentation](https://devspace.covexo.com/docs/advanced/architecture.html) ## [DevSpace Cloud](https://devspace-cloud.com/) diff --git a/docs/docs/configuration/config.yaml.md b/docs/docs/configuration/config.yaml.md index 19abda0ffb..415271dc92 100644 --- a/docs/docs/configuration/config.yaml.md +++ b/docs/docs/configuration/config.yaml.md @@ -180,6 +180,7 @@ devSpace: # Label selector to select the correct pods labelSelector: release: devspace-default + # What to deploy within your project deployments: - name: devspace-default # this is also the release name, when using helm as deployment method helm: @@ -194,12 +195,10 @@ devSpace: - kube/additional/* # Automatically forwarded ports on `devspace up` (same functionality as running manually kubectl port-forward) portForwarding: - # Currently only pod is supported - - resourceType: pod # Map of key value matchLabel selectors - labelSelector: - release: my-app - # namespace where to select the pods from + - labelSelector: + release: devspace-default + # optional namespace where to select the pods from namespace: my-namespace # Array of port mappings portMappings: @@ -211,8 +210,7 @@ devSpace: remotePort: 80 sync: # Currently only resource type pod is supported - - resourceType: pod - labelSelector: + - labelSelector: release: devspace-default # The container within the pod to sync to containerName: default @@ -223,7 +221,7 @@ devSpace: # Exclude node_modules from up and download excludePaths: - node_modules/ -# A list of images that should be build during devspace up +# A map of images that should be build during devspace up images: default: # Image name with prefixed docker image registry @@ -256,7 +254,7 @@ images: privateRegistryImage: name: user/test registry: privateRegistry -# The registries the images should be pushed to +# Optional: the registries the images should be pushed to registries: # Internal registry that will be automatically deployed to the target # cluster if desired @@ -271,7 +269,7 @@ registries: auth: username: user-XXXXX password: XXXXXXXXXX # Can also be a token -# Optional: The deployed internal registry within the cluster +# Optional: Deploy internal registry within the cluster internalRegistry: deploy: true # Optional: Tiller server that should be used within the cluster (only necessary if you want to use helm as deployment)