+
+
## 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`.
-
+
+
+
Quick Start
+
Clusters Detail
+
+
+
+
+
+
+
Operate Cluster Resources
+
SSH Cluster Nodes
+
+
+
+
+
+
## Rancher Mode
diff --git a/docs/assets/autok3s-local-ui.png b/docs/assets/autok3s-local-ui.png
deleted file mode 100644
index 8d7e56a0..00000000
Binary files a/docs/assets/autok3s-local-ui.png and /dev/null differ
diff --git a/docs/assets/cluster-detail.jpg b/docs/assets/cluster-detail.jpg
new file mode 100644
index 00000000..086f644b
Binary files /dev/null and b/docs/assets/cluster-detail.jpg differ
diff --git a/docs/assets/kubectl.jpg b/docs/assets/kubectl.jpg
new file mode 100644
index 00000000..fd3fcc06
Binary files /dev/null and b/docs/assets/kubectl.jpg differ
diff --git a/docs/assets/node-ssh.jpg b/docs/assets/node-ssh.jpg
new file mode 100644
index 00000000..f58b65d5
Binary files /dev/null and b/docs/assets/node-ssh.jpg differ
diff --git a/docs/assets/quick-start.jpg b/docs/assets/quick-start.jpg
new file mode 100644
index 00000000..b3ee9b04
Binary files /dev/null and b/docs/assets/quick-start.jpg differ
diff --git a/docs/i18n/en_us/alibaba/README.md b/docs/i18n/en_us/alibaba/README.md
index 0e5277fe..206ddf0e 100644
--- 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:
+
+
```json
{
"Version": "1",
@@ -102,10 +104,14 @@ This provider needs certain permissions to access Alibaba Cloud. Therefore, you
}
```
+
+
### Setting up Security Group
The ECS instance needs to apply the following **minimum** Security Group Rules:
+
+
```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
```
+
+
## 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
index a1bef072..ce7b11f1 100644
--- 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:
+
```json
{
@@ -60,10 +60,14 @@ For example:
}
```
+
+
### Setting up Security Group
The EC2 instances need to apply the following **minimum** Security Group Rules:
+
+
```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
```
+
+
## 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
index ec5bbd27..5f4d2863 100644
--- 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:
+
+
```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
```
+
+
## 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
index 7657c282..cca17041 100644
--- a/docs/i18n/en_us/tencent/README.md
+++ b/docs/i18n/en_us/tencent/README.md
@@ -23,6 +23,8 @@ export CVM_SECRET_KEY=''
This provider needs certain permissions to access Tencent Cloud, so need to create a few RAM policies for your CVM instances:
+
+
```json
{
"version": "2.0",
@@ -73,10 +75,14 @@ This provider needs certain permissions to access Tencent Cloud, so need to crea
}
```
+
+
### Setting up Security Group
The CVM instances need to apply the following **minimum** Security Group Rules:
+
+
```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
```
+
+
## Creating a K3s cluster
### Normal Cluster
diff --git a/docs/i18n/zh_cn/README.md b/docs/i18n/zh_cn/README.md
index 9c77a471..47a4d262 100644
--- a/docs/i18n/zh_cn/README.md
+++ b/docs/i18n/zh_cn/README.md
@@ -1,11 +1,15 @@
-# AutoK3s
-
-[](http://drone-pandaria.cnrancher.com/cnrancher/autok3s)
-[](https://goreportcard.com/report/github.com/cnrancher/autok3s)
-
-[](http://github.com/cnrancher/autok3s/pulls)
-
-简体中文 / [English](../../../README.md)
+
+ 
