Skip to content

Commit 2fc1af0

Browse files
committed
Add examples readme
1 parent 983da7b commit 2fc1af0

2 files changed

Lines changed: 13 additions & 2 deletions

File tree

docs/docs/configuration/config.yaml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ In this section you can define additional settings for connecting to the tiller
141141

142142
## cluster
143143
The `cluster` field specifies:
144-
- `kubeContext` *string* the kubernetes context to use from $HOME/.kube/config
144+
- `kubeContext` *string* the kubernetes context to use (if omitted and apiServer is not defined the current kubectl context is used)
145145
- `cloudProvider` *string* the cloud provider to use to automatically create a devspace namespace (currently only 'devspace-cloud' is supported)
146146
- `namespace` *string* the default namespace that should be used (will override the namespace in the kubernetes context)
147147
- `apiServer` *string* Kubernetes API-Server URL

examples/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
11
# DevSpace Examples
22

3-
This folder contains several examples how to use the devspace cli for various use cases. Below is a table that summarizes the examples:
3+
This folder contains several examples how to use the devspace cli for various use cases. Below is a table with the examples:
4+
5+
| Name | Builder | Registry | Deployment | Description |
6+
|:------|:----------:|:----------:|:----------:|:-------------|
7+
| [`quickstart`](https://github.com/covexo/devspace/tree/master/examples/quickstart) | docker | remote registry | helm | Simple nodejs example how to use devspace with helm |
8+
| [`quickstart-kubectl`](https://github.com/covexo/devspace/tree/master/examples/quickstart-kubectl) | docker | remote registry | kubectl | Simple nodejs example how to use devspace with kubectl apply |
9+
| [`minikube`](https://github.com/covexo/devspace/tree/master/examples/minikube) | minikube-docker | local registry | helm | Minikube example with local registry |
10+
| [`offline-development`](https://github.com/covexo/devspace/tree/master/examples/offline-development) | minikube-docker | local registry | helm | Example how to develop without internet connection |
11+
| [`php-mysql-example`](https://github.com/covexo/devspace/tree/master/examples/php-mysql-example) | docker | remote registry | helm | Example how to easily deploy php and mysql |
12+
| [`microservices`](https://github.com/covexo/devspace/tree/master/examples/microservices) | docker | remote registry | helm & kubectl | Example with simple nodejs and php application that interact |
13+
| [`kaniko`](https://github.com/covexo/devspace/tree/master/examples/kaniko) | kaniko | remote registry | helm | Example how to use kaniko instead of docker |
14+
| [`kaniko-minikube`](https://github.com/covexo/devspace/tree/master/examples/kaniko-minikube) | kaniko | local registry | helm | Example how to use kaniko locally instead of docker |

0 commit comments

Comments
 (0)