Skip to content

Commit

Permalink
update readme with new config properties
Browse files Browse the repository at this point in the history
  • Loading branch information
petersutter committed Dec 8, 2021
1 parent a0214f9 commit 86b0a87
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,18 @@ ln -s /usr/local/bin/gardenlogin /usr/local/bin/kubectl-gardenlogin
```

## Configure Gardenlogin
`gardenlogin` requires a configuration file. The default location is in `~/.garden/gardenlogin.yaml`.
### Config Path Overwrite:
`gardenlogin` requires a configuration file. The default location is in `~/.garden/gardenlogin.yaml`.

If no configuration file is found, it falls back to the `gardenctl-v2` configuration file (`~/.garden/gardenctl-v2.yaml`) which shares the same configuration properties.

### Example Config
```yaml
gardens:
- identity: landscape-dev # Unique identity of the garden cluster. See cluster-identity ConfigMap in kube-system namespace of the garden cluster
kubeconfig: ~/path/to/garden-cluster/kubeconfig.yaml
```
### Config Path Overwrite
- The `gardenlogin` config path can be overwritten with the environment variable `GL_HOME`.
- The `gardenlogin` config name can be overwritten with the environment variable `GL_CONFIG_NAME`.

Expand All @@ -62,13 +72,6 @@ export GL_CONFIG_NAME=myconfig # without extension!
# config is expected to be under /alternate/garden/config/dir/myconfig.yaml
```

### Example Config:
```yaml
gardenClusters:
- clusterIdentity: landscape-dev # Unique identifier of the garden cluster. See cluster-identity ConfigMap in kube-system namespace of the garden cluster
kubeconfig: ~/path/to/garden-cluster/kubeconfig.yaml
```
## Usage
An example `kubeconfig` for a shoot cluster looks like the following:

Expand Down

0 comments on commit 86b0a87

Please sign in to comment.