diff --git a/docs/_coverpage.md b/docs/_coverpage.md index 6eaec917..e8577aa4 100644 --- a/docs/_coverpage.md +++ b/docs/_coverpage.md @@ -2,6 +2,11 @@ Kubecm

+![Go version](https://img.shields.io/github/go-mod/go-version/sunny0826/kubecm?style=flat-square&logo=appveyor) +![Go](https://github.com/sunny0826/kubecm/workflows/Go/badge.svg?branch=master&style=flat-square&logo=appveyor) +[![Go Report Card](https://goreportcard.com/badge/github.com/sunny0826/kubecm?style=flat-square&logo=appveyor)](https://goreportcard.com/report/github.com/sunny0826/kubecm) +![GitHub](https://img.shields.io/github/license/sunny0826/kubecm.svg?style=flat-square&logo=appveyor) +[![GitHub release](https://img.shields.io/github/release/sunny0826/kubecm?style=flat-square&logo=appveyor)](https://github.com/sunny0826/kubecm/releases) [GitHub](https://github.com/sunny0826/kubecm) [Get Started](en-us/README) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index d6358642..9e518765 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,5 +1,5 @@ * [Install](/en-us/install.md) -* [Interactive operation](/en-us/interactive.md) +* [Introduction](/en-us/introduction.md) * CLI References * [kubecm add](/en-us/cli/kubecm_add.md) * [kubecm alias](/en-us/cli/kubecm_alias.md) diff --git a/docs/en-us/README.md b/docs/en-us/README.md index 94d70318..a00e54e4 100644 --- a/docs/en-us/README.md +++ b/docs/en-us/README.md @@ -10,6 +10,8 @@ [![codecov](https://codecov.io/gh/sunny0826/kubecm/branch/master/graph/badge.svg?token=KGTLBQ8HYZ)](https://codecov.io/gh/sunny0826/kubecm) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/6065/badge)](https://bestpractices.coreinfrastructure.org/projects/6065) +List, switch, add, delete and more interactive operations to manage kubeconfig. It also supports kubeconfig management from cloud. + ```text Manage your kubeconfig more easily. diff --git a/docs/en-us/_sidebar.md b/docs/en-us/_sidebar.md index 6997c51e..1391d921 100644 --- a/docs/en-us/_sidebar.md +++ b/docs/en-us/_sidebar.md @@ -1,5 +1,5 @@ +* [Introduction](/en-us/introduction.md) * [Install](/en-us/install.md) -* [Interactive operation](/en-us/interactive.md) * CLI References * [add](/en-us/cli/kubecm_add.md) * [cloud](/en-us/cli/kubecm_cloud.md) diff --git a/docs/en-us/cli/kubecm_namespace.md b/docs/en-us/cli/kubecm_namespace.md index e6a82c2c..bad8f4fb 100644 --- a/docs/en-us/cli/kubecm_namespace.md +++ b/docs/en-us/cli/kubecm_namespace.md @@ -12,6 +12,8 @@ Switch or change namespace interactively kubecm namespace [flags] ``` +![ns](../../static/ns.gif) + ### Examples ``` diff --git a/docs/en-us/interactive.md b/docs/en-us/interactive.md deleted file mode 100644 index 5deb3811..00000000 --- a/docs/en-us/interactive.md +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en-us/introduction.md b/docs/en-us/introduction.md new file mode 100644 index 00000000..6d6816a4 --- /dev/null +++ b/docs/en-us/introduction.md @@ -0,0 +1,66 @@ + +List, switch, add, delete and more interactive operations to manage kubeconfig. +It also supports kubeconfig management from cloud. + +## Quick start + +### Install + +Using [Krew](https://krew.sigs.k8s.io/): + +```bash +kubectl krew install kc +``` + +Using Homebrew: + +```bash +brew install kubecm +``` + +Source binary: + +[Download the binary](https://github.com/sunny0826/kubecm/releases) + +### Add kubeconfig + +```bash +# Merge test.yaml with $HOME/.kube/config +kubecm add -f test.yaml +# Add kubeconfig from stdin +cat /etc/kubernetes/admin.conf | kubecm add -f - +``` + +### List kubeconfig + +```bash +# List all the contexts in your KubeConfig file +kubecm list +``` + +### Switch kubeconfig + +```bash +# Switch Kube Context interactively +kubecm switch +# Quick switch Kube Context +kubecm switch dev +``` + +### Switch namespace + +```bash +# Switch Namespace interactively +kubecm namespace +# or +kubecm ns +# change to namespace of kube-system +kubecm ns kube-system +``` +![ns](../../static/ns.gif) + +### Interactive operation + + + +more commands, please see [CLI References](https://kubecm.cloud/en-us/cli/kubecm_add) \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 098b31bb..f2e00cdf 100644 --- a/docs/index.html +++ b/docs/index.html @@ -9,7 +9,8 @@ - + + @@ -123,10 +124,6 @@ - \ No newline at end of file diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md index ecaf885d..14f85898 100644 --- a/docs/zh-cn/README.md +++ b/docs/zh-cn/README.md @@ -10,6 +10,8 @@ [![codecov](https://codecov.io/gh/sunny0826/kubecm/branch/master/graph/badge.svg?token=KGTLBQ8HYZ)](https://codecov.io/gh/sunny0826/kubecm) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/6065/badge)](https://bestpractices.coreinfrastructure.org/projects/6065) +List, switch, add, delete and more interactive operations to manage kubeconfig. It also supports kubeconfig management from cloud. + ```text Manage your kubeconfig more easily. diff --git a/docs/zh-cn/_sidebar.md b/docs/zh-cn/_sidebar.md index eb656059..81df0b46 100644 --- a/docs/zh-cn/_sidebar.md +++ b/docs/zh-cn/_sidebar.md @@ -1,5 +1,5 @@ +* [介绍](/zh-cn/introduction.md) * [安装](/zh-cn/install.md) -* [交互式操作](/zh-cn/interactive.md) * CLI 参考 * [add](/zh-cn/cli/kubecm_add.md) * [cloud](/zh-cn/cli/kubecm_cloud.md) diff --git a/docs/zh-cn/interactive.md b/docs/zh-cn/interactive.md deleted file mode 100644 index 5deb3811..00000000 --- a/docs/zh-cn/interactive.md +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/zh-cn/introduction.md b/docs/zh-cn/introduction.md new file mode 100644 index 00000000..d24fda35 --- /dev/null +++ b/docs/zh-cn/introduction.md @@ -0,0 +1,66 @@ + +List, switch, add, delete and more interactive operations to manage kubeconfig. +It also supports kubeconfig management from cloud. + +## 快速开始 + +### 安装 + +使用 [Krew](https://krew.sigs.k8s.io/): + +```bash +kubectl krew install kc +``` + +使用 Homebrew: + +```bash +brew install kubecm +``` + +Source binary: + +[下载可执行文件](https://github.com/sunny0826/kubecm/releases) + +### 添加 kubeconfig + +```bash +# Merge test.yaml with $HOME/.kube/config +kubecm add -f test.yaml +# Add kubeconfig from stdin +cat /etc/kubernetes/admin.conf | kubecm add -f - +``` + +### 列举 kubeconfig + +```bash +# List all the contexts in your KubeConfig file +kubecm list +``` + +### 切换 kubeconfig + +```bash +# Switch Kube Context interactively +kubecm switch +# Quick switch Kube Context +kubecm switch dev +``` + +### 切换 namespace + +```bash +# Switch Namespace interactively +kubecm namespace +# or +kubecm ns +# change to namespace of kube-system +kubecm ns kube-system +``` +![ns](../../static/ns.gif) + +## 交互式操作 + + + +更多的信息, 请看 [CLI 参考](https://kubecm.cloud/zh-cn/cli/kubecm_add) \ No newline at end of file