docs(autok3s): add docs for new list and describe command

cnrancher · Dec 24, 2020 · d093ae8 · d093ae8
1 parent a1b7c82
commit d093ae8
Show file tree

Hide file tree

Showing 6 changed files with 332 additions and 0 deletions.
diff --git a/docs/i18n/en_us/alibaba/README.md b/docs/i18n/en_us/alibaba/README.md
@@ -200,6 +200,71 @@ This command will list the clusters that you have created on this machine.
 autok3s list
 ```
 
+> Note：Cluster name will show as `<clusterName>.<region>` for alibaba provider.
+
+```bash
+       NAME         REGION     PROVIDER  STATUS   MASTERS  WORKERS    VERSION
+myk3s.cn-hangzhou  cn-hangzhou  alibaba   Running  2        2        v1.19.5+k3s2
+myk3s              -            native    Running  1        1        v1.19.5+k3s2
+myk3s.ap-nanjing   ap-nanjing   tencent   Running  2        1        v1.19.5+k3s2
+```
+
+### Describe k3s cluster
+This command will show detail information of specified cluster, such as instance status, node IP, kubelet version, etc.
+
+```bash
+autok3s describe cluster <clusterName>
+```
+> Note：Cluster name should be `<clusterName>.<region>` as list command result, for example: `autok3s describe cluster myk3s.cn-hangzhou`
+
+```bash
+Name: myk3s.cn-hangzhou
+Provider: alibaba
+Region: cn-hangzhou
+Zone: cn-hangzhou-i
+Master: 2
+Worker: 2
+Status: Running
+Version: v1.19.5+k3s2
+Nodes:
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status: Running
+    instance-id: xxxxx
+    roles: etcd,master
+    status: Ready
+    hostname: xxxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status: Running
+    instance-id: xxxxxx
+    roles: <none>
+    status: Ready
+    hostname: xxxxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status: Running
+    instance-id: xxxxxxxx
+    roles: etcd,master
+    status: Ready
+    hostname: xxxxxxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status: Running
+    instance-id: xxxxxxx
+    roles: <none>
+    status: Ready
+    hostname: xxxxxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+```
+
 ### Access K3s Cluster
 After the cluster created, `autok3s` will automatically merge the `kubeconfig` which necessary for us to access the cluster.
 

diff --git a/docs/i18n/en_us/native/README.md b/docs/i18n/en_us/native/README.md
@@ -100,6 +100,51 @@ This command will list the clusters that you have created on this machine.
 autok3s list
 ```
 
+```bash
+       NAME         REGION     PROVIDER  STATUS   MASTERS  WORKERS    VERSION
+myk3s.cn-hangzhou  cn-hangzhou  alibaba   Running  2        2        v1.19.5+k3s2
+myk3s              -            native    Running  1        1        v1.19.5+k3s2
+myk3s.ap-nanjing   ap-nanjing   tencent   Running  2        1        v1.19.5+k3s2
+```
+
+### Describe k3s cluster
+This command will show detail information of specified cluster, such as instance status, node IP, kubelet version, etc.
+
+```bash
+autok3s describe cluster <clusterName>
+```
+> Note：Cluster name should be `<clusterName>` as list command result, for example: `autok3s describe cluster myk3s`
+
+```bash
+Name: myk3s
+Provider: native
+Region: -
+Zone: -
+Master: 1
+Worker: 1
+Status: Running
+Version: v1.19.5+k3s2
+Nodes:
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status:
+    instance-id:
+    roles: master,etcd
+    status: Ready
+    hostname: xxxxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status:
+    instance-id:
+    roles: <none>
+    status: Ready
+    hostname: xxxxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+```
+
 ### Access K3s Cluster
 After the cluster created, `autok3s` will automatically merge the `kubeconfig` which necessary for us to access the cluster.
 

diff --git a/docs/i18n/en_us/tencent/README.md b/docs/i18n/en_us/tencent/README.md
@@ -155,6 +155,62 @@ This command will list the clusters that you have created on this machine.
 autok3s list
 ```
 
+> Note：Cluster name will show as `<clusterName>.<region>` for tencent provider.
+
+```bash
+       NAME         REGION     PROVIDER  STATUS   MASTERS  WORKERS    VERSION
+myk3s.cn-hangzhou  cn-hangzhou  alibaba   Running  2        2        v1.19.5+k3s2
+myk3s              -            native    Running  1        1        v1.19.5+k3s2
+myk3s.ap-nanjing   ap-nanjing   tencent   Running  2        1        v1.19.5+k3s2
+```
+
+### Describe k3s cluster
+This command will show detail information of specified cluster, such as instance status, node IP, kubelet version, etc.
+
+```bash
+autok3s describe cluster <clusterName>
+```
+> Note：Cluster name should be `<clusterName>.<region>` as list command result, for example: `autok3s describe cluster myk3s.ap-nanjing`
+
+```bash
+Name: myk3s.ap-nanjing
+Provider: tencent
+Region: ap-nanjing
+Zone: ap-nanjing-1
+Master: 2
+Worker: 1
+Status: Running
+Version: v1.19.5+k3s2
+Nodes:
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status: RUNNING
+    instance-id: xxxxx
+    roles: etcd,master
+    status: Ready
+    hostname: xxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status: RUNNING
+    instance-id: xxxxx
+    roles: <none>
+    status: Ready
+    hostname: xxxxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status: RUNNING
+    instance-id: xxxxxx
+    roles: etcd,master
+    status: Ready
+    hostname: xxxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+```
+
 ### Access K3s Cluster
 After the cluster created, `autok3s` will automatically merge the `kubeconfig` which necessary for us to access the cluster.
 

diff --git a/docs/i18n/zh_cn/alibaba/README.md b/docs/i18n/zh_cn/alibaba/README.md
@@ -199,6 +199,71 @@ autok3s -d delete --provider alibaba --name myk3s
 autok3s list
 ```
 
+> 注意：使用公有云Provider创建的集群名称会使用`<clusterName>.<region>`显示。
+
+```bash
+       NAME         REGION     PROVIDER  STATUS   MASTERS  WORKERS    VERSION
+myk3s.cn-hangzhou  cn-hangzhou  alibaba   Running  2        2        v1.19.5+k3s2
+myk3s              -            native    Running  1        1        v1.19.5+k3s2
+myk3s.ap-nanjing   ap-nanjing   tencent   Running  2        1        v1.19.5+k3s2
+```
+
+### 查看集群详细信息
+显示具体的k3s信息，包括实例状态、主机ip、集群版本等信息。
+
+```bash
+autok3s describe cluster <clusterName>
+```
+> 注意：这里`<clusterName>`需要按照list显示的格式输入，例如`autok3s describe cluster myk3s.cn-hangzhou`
+
+```bash
+Name: myk3s.cn-hangzhou
+Provider: alibaba
+Region: cn-hangzhou
+Zone: cn-hangzhou-i
+Master: 2
+Worker: 2
+Status: Running
+Version: v1.19.5+k3s2
+Nodes:
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status: Running
+    instance-id: xxxxx
+    roles: etcd,master
+    status: Ready
+    hostname: xxxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status: Running
+    instance-id: xxxxxx
+    roles: <none>
+    status: Ready
+    hostname: xxxxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status: Running
+    instance-id: xxxxxxxx
+    roles: etcd,master
+    status: Ready
+    hostname: xxxxxxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status: Running
+    instance-id: xxxxxxx
+    roles: <none>
+    status: Ready
+    hostname: xxxxxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+```
+
 ### Kubectl
 集群创建完成后, `autok3s` 会自动合并 `kubeconfig` 文件。
 

diff --git a/docs/i18n/zh_cn/native/README.md b/docs/i18n/zh_cn/native/README.md
@@ -101,6 +101,51 @@ autok3s -d delete --provider native --name myk3s
 autok3s list
 ```
 
+```bash
+       NAME         REGION     PROVIDER  STATUS   MASTERS  WORKERS    VERSION
+myk3s.cn-hangzhou  cn-hangzhou  alibaba   Running  2        2        v1.19.5+k3s2
+myk3s              -            native    Running  1        1        v1.19.5+k3s2
+myk3s.ap-nanjing   ap-nanjing   tencent   Running  2        1        v1.19.5+k3s2
+```
+
+### 查看集群详细信息
+显示具体的k3s信息，包括实例状态、主机ip、集群版本等信息。
+
+```bash
+autok3s describe cluster <clusterName>
+```
+> 注意：这里`<clusterName>`需要按照list显示的格式输入，例如`autok3s describe cluster myk3s`
+
+```bash
+Name: myk3s
+Provider: native
+Region: -
+Zone: -
+Master: 1
+Worker: 1
+Status: Running
+Version: v1.19.5+k3s2
+Nodes:
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status:
+    instance-id:
+    roles: master,etcd
+    status: Ready
+    hostname: xxxxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status:
+    instance-id:
+    roles: <none>
+    status: Ready
+    hostname: xxxxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+```
+
 ### Kubectl
 集群创建完成后, `autok3s` 会自动合并 `kubeconfig` 文件。
 

diff --git a/docs/i18n/zh_cn/tencent/README.md b/docs/i18n/zh_cn/tencent/README.md
@@ -154,6 +154,62 @@ autok3s -d delete --provider tencent --name myk3s
 autok3s list
 ```
 
+> 注意：使用公有云Provider创建的集群名称会使用`<clusterName>.<region>`显示。
+
+```bash
+       NAME         REGION     PROVIDER  STATUS   MASTERS  WORKERS    VERSION
+myk3s.cn-hangzhou  cn-hangzhou  alibaba   Running  2        2        v1.19.5+k3s2
+myk3s              -            native    Running  1        1        v1.19.5+k3s2
+myk3s.ap-nanjing   ap-nanjing   tencent   Running  2        1        v1.19.5+k3s2
+```
+
+### 查看集群详细信息
+显示具体的k3s信息，包括实例状态、主机ip、集群版本等信息。
+
+```bash
+autok3s describe cluster <clusterName>
+```
+> 注意：这里`<clusterName>`需要按照list显示的格式输入，例如`autok3s describe cluster myk3s.ap-nanjing`
+
+```bash
+Name: myk3s.ap-nanjing
+Provider: tencent
+Region: ap-nanjing
+Zone: ap-nanjing-1
+Master: 2
+Worker: 1
+Status: Running
+Version: v1.19.5+k3s2
+Nodes:
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status: RUNNING
+    instance-id: xxxxx
+    roles: etcd,master
+    status: Ready
+    hostname: xxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status: RUNNING
+    instance-id: xxxxx
+    roles: <none>
+    status: Ready
+    hostname: xxxxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+  - internal-ip: x.x.x.x
+    external-ip: x.x.x.x
+    instance-status: RUNNING
+    instance-id: xxxxxx
+    roles: etcd,master
+    status: Ready
+    hostname: xxxxx
+    container-runtime: containerd://1.4.3-k3s1
+    version: v1.19.5+k3s2
+```
+
 ### Kubectl
 集群创建完成后, `autok3s` 会自动合并 `kubeconfig` 文件。