docs(autok3s): update README.md

1. update UI pictures 2. add tl;dr section Signed-off-by: Jason-ZW <zhenyang@rancher.com>
cnrancher · Feb 25, 2021 · 79f80b9 · 79f80b9
1 parent 96bae0b
commit 79f80b9
Show file tree

Hide file tree

Showing 15 changed files with 135 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,15 @@
-# AutoK3s
-
-[![Build Status](http://drone-pandaria.cnrancher.com/api/badges/cnrancher/autok3s/status.svg)](http://drone-pandaria.cnrancher.com/cnrancher/autok3s)
-[![Go Report Card](https://goreportcard.com/badge/github.com/cnrancher/autok3s)](https://goreportcard.com/report/github.com/cnrancher/autok3s)
-![GitHub release](https://img.shields.io/github/v/release/cnrancher/autok3s.svg)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?color=blue)](http://github.com/cnrancher/autok3s/pulls)
-
-English / [简体中文](docs/i18n/zh_cn/README.md)
+<div align="center">
+  <h1>AutoK3s</h1>
+  <p>
+    <img alt="Build Status" src="http://drone-pandaria.cnrancher.com/api/badges/cnrancher/autok3s/status.svg">
+    <img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/cnrancher/autok3s">
+    <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/cnrancher/autok3s?color=default&label=release&logo=github">
+    <img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/cnrancher/autok3s?include_prereleases&label=pre-release&logo=github">
+  </p>
+  <span>English / </span> <a href="docs/i18n/zh_cn/README.md">简体中文</a>
+</div>
+
+<hr />
 
 ## What is AutoK3s
 
@@ -19,6 +23,7 @@ AutoK3s is a lightweight tool for simplifying the cluster management of K3s, it
 - [Supported Providers](#supported-providers)
 - [Frequently-used commands](#frequently-used-commands)
 - [Frequently-used parameters](#frequently-used-parameters)
+- [Install Script (tl;dr)](#install-script-tldr) 
 - [Quick Start](#quick-start)
 - [User Guide](#user-guide)
 - [Local Mode](#local-mode)
@@ -42,10 +47,11 @@ AutoK3s is a lightweight tool for simplifying the cluster management of K3s, it
 
 Autok3s can support the following providers, we are happy to add more if you need:
 
+- [aws](docs/i18n/en_us/aws/README.md) - Bootstrap K3s onto Amazon EC2
 - [alibaba](docs/i18n/en_us/alibaba/README.md) - Bootstrap K3s onto Alibaba ECS
 - [tencent](docs/i18n/en_us/tencent/README.md) - Bootstrap K3s onto Tencent CVM
 - [native](docs/i18n/en_us/native/README.md) - Bootstrap K3s onto any VM
-- [aws](docs/i18n/en_us/aws/README.md) - Bootstrap K3s onto Amazon EC2
+
 
 ## Frequently-used Commands
 
@@ -64,6 +70,14 @@ These parameters are frequently used in AutoK3s:
 - `--master`: To specify the number of master nodes that you want to create or add.
 - `--worker`: To specify the number of worker nodes that you want to create or add.
 
+## Install Script (tl;dr)
+
+AutoK3s is distributed as a static Go binary. You can use the shell script on MacOS and Linux, or visit the Releases page to download the executable for Windows.
+
+```bash
+curl -sS http://rancher-mirror.cnrancher.com/autok3s/install.sh  | sh
+```
+
 ## Quick Start
 
 The commands below can create a K3s cluster on Alibaba ECS.
@@ -126,7 +140,24 @@ autok3s -d join --provider alibaba --name myk3s --worker 1
 
 If you want to enable the local UI, please run `autok3s serve`.
 
-![autok3s-local-ui](./docs/assets/autok3s-local-ui.png)
+<table>
+  <tr>
+      <td width="50%" align="center"><b>Quick Start</b></td>
+      <td width="50%" align="center"><b>Clusters Detail</b></td>
+  </tr>
+  <tr>
+     <td><img src="./docs/assets/quick-start.jpg"/></td>
+     <td><img src="./docs/assets/cluster-detail.jpg"/></td>
+  </tr>
+  <tr>
+      <td width="50%" align="center"><b>Operate Cluster Resources</b></td>
+      <td width="50%" align="center"><b>SSH Cluster Nodes</b></td>
+  </tr>
+  <tr>
+     <td><img src="./docs/assets/kubectl.jpg"/></td>
+     <td><img src="./docs/assets/node-ssh.jpg"/></td>
+  </tr>
+</table>
 
 ## Rancher Mode
 

diff --git a/docs/assets/autok3s-local-ui.png b/docs/assets/autok3s-local-ui.png
diff --git a/docs/assets/cluster-detail.jpg b/docs/assets/cluster-detail.jpg
diff --git a/docs/assets/kubectl.jpg b/docs/assets/kubectl.jpg
diff --git a/docs/assets/node-ssh.jpg b/docs/assets/node-ssh.jpg
diff --git a/docs/assets/quick-start.jpg b/docs/assets/quick-start.jpg
diff --git a/docs/i18n/en_us/alibaba/README.md b/docs/i18n/en_us/alibaba/README.md
@@ -25,6 +25,8 @@ Please visit [here](https://www.alibabacloud.com/help/doc-detail/54235.htm) to b
 
 This provider needs certain permissions to access Alibaba Cloud. Therefore, you need to create some RAM policies to grant these permissions for your ECS instance. The code below is an example of setting up a set of RAM policies such that you can access your ECS instance:
 
+<details>
+
 ```json
 {
   "Version": "1",
@@ -102,10 +104,14 @@ This provider needs certain permissions to access Alibaba Cloud. Therefore, you
 }
 ```
 
+</details>
+
 ### Setting up Security Group
 
 The ECS instance needs to apply the following **minimum** Security Group Rules:
 
+<details>
+
 ```bash
 Rule        Protocol    Port      Source             Description
 InBound     TCP         22        ALL                SSH Connect Port
@@ -117,6 +123,8 @@ InBound     TCP         2379,2380 K3s server nodes   (Optional) Required only fo
 OutBound    ALL         ALL       ALL                Allow All
 ```
 
+</details>
+
 ## Creating a K3s cluster
 
 Please use `autok3s create` command to create a cluster in your ECS instance.

diff --git a/docs/i18n/en_us/aws/README.md b/docs/i18n/en_us/aws/README.md
@@ -25,7 +25,7 @@ Please refer [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.ht
 
 Please make sure your account has permission to manage EC2 instance or other relative resources.
 
-For example:
+<details>
 
 ```json
 {
@@ -60,10 +60,14 @@ For example:
 }
 ```
 
+</details>
+
 ### Setting up Security Group
 
 The EC2 instances need to apply the following **minimum** Security Group Rules:
 
+<details>
+
 ```bash
 Rule        Protocol    Port      Source             Description
 InBound     TCP         22        ALL                SSH Connect Port
@@ -75,6 +79,8 @@ InBound     TCP         2379,2380 K3s server nodes   (Optional) Required only fo
 OutBound    ALL         ALL       ALL                Allow All
 ```
 
+</details>
+
 ## Creating a K3s cluster
 
 Please use `autok3s create` command to create a cluster in your EC2 instance.

diff --git a/docs/i18n/en_us/native/README.md b/docs/i18n/en_us/native/README.md
@@ -16,6 +16,8 @@ You will need a VM that is capable of running popular Linux distributions such a
 
 The VM needs to apply the following **minimum** Security Group Rules:
 
+<details>
+
 ```bash
 Rule        Protocol    Port      Source             Description
 InBound     TCP         22        ALL                SSH Connect Port
@@ -27,6 +29,8 @@ InBound     TCP         2379,2380 K3s server nodes   (Optional) Required only fo
 OutBound    ALL         ALL       ALL                Allow All
 ```
 
+</details>
+
 ## Creating a K3s cluster
 
 Please use `autok3s create` command to create a cluster in your VM.

diff --git a/docs/i18n/en_us/tencent/README.md b/docs/i18n/en_us/tencent/README.md
@@ -23,6 +23,8 @@ export CVM_SECRET_KEY='<secret-key>'
 
 This provider needs certain permissions to access Tencent Cloud, so need to create a few RAM policies for your CVM instances:
 
+<details>
+
 ```json
 {
   "version": "2.0",
@@ -73,10 +75,14 @@ This provider needs certain permissions to access Tencent Cloud, so need to crea
 }
 ```
 
+</details>
+
 ### Setting up Security Group
 
 The CVM instances need to apply the following **minimum** Security Group Rules:
 
+<details>
+
 ```bash
 Rule        Protocol    Port      Source             Description
 InBound     TCP         22        ALL                SSH Connect Port
@@ -88,6 +94,8 @@ InBound     TCP         2379,2380 K3s server nodes   (Optional) Required only fo
 OutBound    ALL         ALL       ALL                Allow All
 ```
 
+</details>
+
 ## Creating a K3s cluster
 
 ### Normal Cluster

diff --git a/docs/i18n/zh_cn/README.md b/docs/i18n/zh_cn/README.md
@@ -1,11 +1,15 @@
-# AutoK3s
-
-[![Build Status](http://drone-pandaria.cnrancher.com/api/badges/cnrancher/autok3s/status.svg)](http://drone-pandaria.cnrancher.com/cnrancher/autok3s)
-[![Go Report Card](https://goreportcard.com/badge/github.com/cnrancher/autok3s)](https://goreportcard.com/report/github.com/cnrancher/autok3s)
-![GitHub release](https://img.shields.io/github/v/release/cnrancher/autok3s.svg?color=blue)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?color=blue)](http://github.com/cnrancher/autok3s/pulls)
-
-简体中文 / [English](../../../README.md)
+<div align="center">
+  <h1>AutoK3s</h1>
+  <p>
+    <img alt="Build Status" src="http://drone-pandaria.cnrancher.com/api/badges/cnrancher/autok3s/status.svg">
+    <img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/cnrancher/autok3s">
+    <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/cnrancher/autok3s?color=default&label=release&logo=github">
+    <img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/cnrancher/autok3s?include_prereleases&label=pre-release&logo=github">
+  </p>
+  <span>简体中文 / </span> <a href="../../../README.md">English</a>
+</div>
+
+<hr />
 
 ## 什么是 AutoK3s
 
@@ -19,6 +23,7 @@ AutoK3s 是用于简化 K3s 集群管理的轻量级工具，您可以使用 Aut
 - [支持的云提供商](#支持的云提供商)
 - [常用命令](#常用命令)
 - [常用参数](#常用参数)
+- [安装脚本](#安装脚本)
 - [快速体验](#快速体验)
 - [使用指南](#使用指南)
 - [Local Mode](#local-mode)
@@ -61,6 +66,14 @@ AutoK3s 命令中常用的参数如下：
 - `--master`：指定创建的 master 节点数量。
 - `--worker`：指定创建的 worker 节点数量。
 
+## 安装脚本
+
+在MacOS或者Linux系统环境使用以下脚本安装AutoK3s，Windows用户请前往Releases页面下载对应的可执行程序。
+
+```bash
+curl -sS http://rancher-mirror.cnrancher.com/autok3s/install.sh  | INSTALL_AUTOK3S_MIRROR=cn sh
+```
+
 ## 快速体验
 
 运行以下命令，即可在阿里云 ECS 上快速创建和启动一个 K3s 集群。
@@ -125,7 +138,24 @@ autok3s -d join --provider alibaba --name myk3s --worker 1
 
 如果要启用本地 UI，请运行 `autok3s serve`，如下图所示。
 
-![autok3s-local-ui](../../assets/autok3s-local-ui.png)
+<table>
+  <tr>
+      <td width="50%" align="center"><b>快速开始</b></td>
+      <td width="50%" align="center"><b>集群详情</b></td>
+  </tr>
+  <tr>
+     <td><img src="./docs/assets/quick-start.jpg"/></td>
+     <td><img src="./docs/assets/cluster-detail.jpg"/></td>
+  </tr>
+  <tr>
+      <td width="50%" align="center"><b>操作集群资源</b></td>
+      <td width="50%" align="center"><b>SSH集群节点</b></td>
+  </tr>
+  <tr>
+     <td><img src="./docs/assets/kubectl.jpg"/></td>
+     <td><img src="./docs/assets/node-ssh.jpg"/></td>
+  </tr>
+</table>
 
 ## Rancher Mode
 

diff --git a/docs/i18n/zh_cn/alibaba/README.md b/docs/i18n/zh_cn/alibaba/README.md
@@ -25,6 +25,8 @@ export ECS_ACCESS_KEY_SECRET='<secret-access>'
 
 您需要以下权限来访问阿里云，因此需要确保为 ECS 实例创建以下 RAM 规则。
 
+<details>
+
 ```json
 {
   "Version": "1",
@@ -102,10 +104,14 @@ export ECS_ACCESS_KEY_SECRET='<secret-access>'
 }
 ```
 
+</details>
+
 ### 设置安全组
 
 ECS 实例**至少**需要应用以下安全组规则：
 
+<details>
+
 ```bash
 Rule        Protocol    Port      Source             Description
 InBound     TCP         22        ALL                SSH Connect Port
@@ -117,6 +123,8 @@ InBound     TCP         2379,2380 K3s server nodes   (Optional) Required only fo
 OutBound    ALL         ALL       ALL                Allow All
 ```
 
+</details>
+
 ## 创建集群
 
 请使用`autok3s create`命令在阿里云 ECS 实例中创建集群。

diff --git a/docs/i18n/zh_cn/aws/README.md b/docs/i18n/zh_cn/aws/README.md
@@ -25,6 +25,8 @@ export AWS_SECRET_ACCESS_KEY='<secret-key>'
 
 您的账号需要创建 EC2 及相关资源的权限，因此需要确保具有以下资源的权限：
 
+<details>
+
 ```json
 {
   "Version": "2012-10-17",
@@ -58,10 +60,14 @@ export AWS_SECRET_ACCESS_KEY='<secret-key>'
 }
 ```
 
+</details>
+
 ### 设置安全组
 
 EC2 实例**至少**需要应用以下安全组规则：
 
+<details>
+
 ```bash
 Rule        Protocol    Port      Source             Description
 InBound     TCP         22        ALL                SSH Connect Port
@@ -73,6 +79,8 @@ InBound     TCP         2379,2380 K3s server nodes   (Optional) Required only fo
 OutBound    ALL         ALL       ALL                Allow All
 ```
 
+</details>
+
 ## 创建集群
 
 请使用`autok3s create`命令在 AWS EC2 实例中创建集群。

diff --git a/docs/i18n/zh_cn/native/README.md b/docs/i18n/zh_cn/native/README.md
@@ -16,6 +16,8 @@
 
 VM 实例**至少**需要应用以下安全组规则：
 
+<details>
+
 ```bash
 Rule        Protocol    Port      Source             Description
 InBound     TCP         22        ALL                SSH Connect Port
@@ -27,6 +29,8 @@ InBound     TCP         2379,2380 K3s server nodes   (Optional) Required only fo
 OutBound    ALL         ALL       ALL                Allow All
 ```
 
+</details>
+
 ## 创建集群
 
 请使用`autok3s create`命令在 VM 实例中创建集群。

diff --git a/docs/i18n/zh_cn/tencent/README.md b/docs/i18n/zh_cn/tencent/README.md
@@ -23,6 +23,8 @@ export CVM_SECRET_KEY='<secret-key>'
 
 您需要以下权限来访问腾讯云，因此需要确保为 CVM 实例创建以下 RAM 规则。
 
+<details>
+
 ```json
 {
   "version": "2.0",
@@ -73,10 +75,14 @@ export CVM_SECRET_KEY='<secret-key>'
 }
 ```
 
+</details>
+
 ### 设置安全组
 
 CVM 实例**至少**需要应用以下安全组规则：
 
+<details>
+
 ```bash
 Rule        Protocol    Port      Source             Description
 InBound     TCP         22        ALL                SSH Connect Port
@@ -88,6 +94,8 @@ InBound     TCP         2379,2380 K3s server nodes   (Optional) Required only fo
 OutBound    ALL         ALL       ALL                Allow All
 ```
 
+</details>
+
 ## 创建集群
 
 请使用`autok3s create`命令在腾讯云 CVM 实例中创建集群。