Skip to content

Commit

Permalink
docs: Automatic docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
DO! DevOps bot authored and dploeger committed Oct 28, 2024
1 parent cfb9bf1 commit ccf89c0
Showing 1 changed file with 34 additions and 8 deletions.
42 changes: 34 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,23 @@ Following features and tools are supported:
* ⛵️ Helm
* 🛠 JQ
* 🐾 k9s
* ⌨️ kc Quick Kubernetes Context switch
* ⌨️ kc Quick Kubernetes Context switch ⚠️ Deprecated: The `kc` feature will be deprecated in one of the next major CloudControl versions. As an alternative, configure
the `krew` feature and use the cs plugin:
```
- USE_krew=yes
- KREW_VERSION=<current version of krew>
- KREW_PLUGINS=cs
```

To make the transition as easy as possible, you can also configure the `run` feature and set an alias to
`kubectl cs`:

```
- USE_run=yes
- RUN_COMMANDS="alias kc='kubectl cs'"
```

See [https://github.com/dodevops/kc](the kc website) for details.
* 🟦 krew
* 🐚 Kubectlnodeshell
* 🐳 Kubernetes
Expand Down Expand Up @@ -467,7 +483,23 @@ Installs [k9s](https://k9scli.io/)
* K9S_VERSION (required): Version to install (or use the FEATURES variable instead)
* DEBUG_k9s: Debug this feature

### <a id="kc"></a> kc Quick Kubernetes Context switch
### <a id="kc"></a> kc Quick Kubernetes Context switch ⚠️ Deprecated: The `kc` feature will be deprecated in one of the next major CloudControl versions. As an alternative, configure
the `krew` feature and use the cs plugin:
```
- USE_krew=yes
- KREW_VERSION=<current version of krew>
- KREW_PLUGINS=cs
```

To make the transition as easy as possible, you can also configure the `run` feature and set an alias to
`kubectl cs`:

```
- USE_run=yes
- RUN_COMMANDS="alias kc='kubectl cs'"
```

See [https://github.com/dodevops/kc](the kc website) for details.

Installs [kc](https://github.com/dodevops/cloudcontrol/blob/master/feature/kc/kc.sh), a quick context switcher for kubernetes.

Expand Down Expand Up @@ -866,9 +898,3 @@ flowchart TD
click F "https://github.com/dodevops/cloudcontrol/blob/develop/.github/workflows/test.yml" "Test workflow"
click H "https://github.com/dodevops/cloudcontrol/blob/develop/.github/workflows/release.yml" "Release workflow"
```mermaid
com/dodevops/cloudcontrol/blob/develop/.github/workflows/check_commits.yml" "Check workflow"
click F "https://github.com/dodevops/cloudcontrol/blob/develop/.github/workflows/test.yml" "Test workflow"
click H "https://github.com/dodevops/cloudcontrol/blob/develop/.github/workflows/release.yml" "Release workflow"
```mermaid
ase workflow"
```mermaid

0 comments on commit ccf89c0

Please sign in to comment.