Skip to content

Commit

Permalink
docs(autok3s): Update README [CI SKIP]
Browse files Browse the repository at this point in the history
  • Loading branch information
niusmallnan authored and Jason-ZW committed Feb 4, 2021
1 parent a511d69 commit 9d30b1d
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 62 deletions.
58 changes: 38 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@

English / [简体中文](docs/i18n/zh_cn/README.md)

AutoK3s is a lightweight tool for quickly creating and managing k3s clusters on multiple cloud providers.
It can help users quickly complete the personalized configuration of the k3s cluster, while providing convenient kubectl access capabilities.
[K3s](https://github.com/k3s-io/k3s) is a fully certified Kubernetes offering, it can replace the "full-fat" K8s in some cases.

AutoK3s is a lightweight tool for simplifying the cluster management of K3s, it can help you **Run K3s Everywhere**.

<!-- toc -->

Expand All @@ -21,26 +22,32 @@ It can help users quickly complete the personalized configuration of the k3s clu
<!-- /toc -->

## Key Features
- Bootstrap Kubernetes with k3s onto multiple cloud providers with `autok3s create`
- Join nodes into an existing k3s cluster with `autok3s join`
- Automatically generate `kubeconfig` file for the cluster which you created
- Integrate `kubectl` to provide access to the cluster
- Bootstrap a HA Kubernetes with k3s cluster
- Support `containerd` private registry with `--registry` flag
- Provide additional option to enable Kubernetes Cloud-Controller-Manager with `--cloud-controller-manager`
- Provide additional option to enable Kubernetes Dashboard UI with `--ui`
- Provide additional option to enable cloud platform's CNI plugin, e.g `--terway 'eni'`

- Quick provisioning time with API, CLI and UI dashboard
- Cloud provider Integration(simplify setting up [CCM](https://kubernetes.io/docs/concepts/architecture/cloud-controller) of each cloud)
- Flexible installation options, like K3s cluster HA and datastore(embedded etcd, RDS, SQLite, etc.)
- Low cost(try spot instances in each cloud)
- Simplify operations by UI dashboard
- Portability between clouds by leveraging tools like [backup-restore-operator](https://github.com/rancher/backup-restore-operator)

## Providers
See the providers' links below for more usage details:

- [alibaba](docs/i18n/en_us/alibaba/README.md) - Bootstrap Kubernetes with k3s onto Alibaba ECS
- [tencent](docs/i18n/en_us/tencent/README.md) - Bootstrap Kubernetes with k3s onto Tencent CVM
- [native](docs/i18n/en_us/native/README.md) - Bootstrap Kubernetes with k3s onto any VM
- [aws](docs/i18n/en_us/aws/README.md) - Bootstrap Kubernetes with k3s onto Amazon EC2
Autok3s can support the following providers, we are happy to add more if you need:

- [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

## Quick Start
The following command use the `alibaba` provider, with prerequisites that refer to the [alibaba](docs/i18n/en_us/alibaba/README.md) document.

Autok3s can run in two different modes: Local mode and Rancher mode.

### Local Mode

In this mode, you can use Autok3s via CLI or a local UI.

The following commands use the `alibaba` provider, please check the [prerequisites](docs/i18n/en_us/alibaba/README.md) before you run that:

```bash
export ECS_ACCESS_KEY_ID='<Your access key ID>'
Expand All @@ -49,18 +56,29 @@ export ECS_ACCESS_KEY_SECRET='<Your secret access key>'
autok3s -d create -p alibaba --name myk3s --master 1 --worker 1
```

## Quick Start with UI
If you want to enable the local UI, please run `autok3s serve` .

If you want to use hosted UI instead of command line, please run `autok3s serve`
![autok3s-local-ui](./docs/assets/autok3s-local-ui.png)

### Rancher Mode

In this mode, you can put Autok3s into [Rancher](https://github.com/rancher/rancher).
It will serve as an extension that allows you to build the managed K3s service.

The K3s cluster created by Autok3s can be automatically imported into Rancher, and take full advantage of Rancher's Kubernetes management capabilities.

This mode is working in progress.

## Demo Video
The demo install Kubernetes (k3s) onto Alibaba ECS machines in around 1 minutes.

In the demo, we install K3s onto Alibaba ECS machines in around 1 minute.

Watch the demo:

[![asciicast](https://asciinema.org/a/EL5P2ILES8GAvdlhaxLMnY8Pg.svg)](https://asciinema.org/a/EL5P2ILES8GAvdlhaxLMnY8Pg)

## Developers' Guide

Use `Makefile` to manage project compilation, testing and packaging.
Of course, you can also choose to compile using `dapper`.
Install `dapper` please follow the [dapper](https://github.com/rancher/dapper) project.
Expand Down
Binary file added docs/assets/autok3s-local-ui.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
72 changes: 30 additions & 42 deletions docs/i18n/zh_cn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@

简体中文 / [English](../../../README.md)

快速创建并启动 k3s 集群,同时可以使用它来为 k3s 集群添加节点,提升公有云体验的同时,继承 kubectl 从而提供便捷的集群能力。
K3s是经过完全认证的Kubernetes产品,在某些情况下可以替代完整的K8s。

AutoK3s是用于简化K3s集群管理的轻量级工具,您可以使用Autok3s在任何地方运行K3s,Run K3s Everywhere。

<!-- toc -->

Expand All @@ -16,59 +18,60 @@
- [快速体验](#快速体验)
- [演示视频](#演示视频)
- [开发者指南](#开发者指南)
- [开源协议](#开源协议)

<!-- /toc -->

## 关键特性

- 使用 `autok3s create` 命令,在多个公有云提供商中快速启动 Kubernetes (k3s) 集群
- 使用 `autok3s join` 命令,添加节点至已存在的 Kubernetes (k3s) 集群
- 自动为创建的 Kubernetes (k3s) 集群生成可供访问的 `kubeconfig` 文件
- 集成 `kubectl` 以提供访问集群的能力
- 支持创建 Kubernetes k3s HA 集群
- 使用`--registry`以支持配置`containerd`私有镜像仓库
- 集成扩展参数 `--cloud-controller-manager` 以开启 Kubernetes Cloud-Controller-Manager 组件
- 集成扩展参数 `--ui` 以开启 Kubernetes Dashboard UI 组件
- 集成扩展参数 `例如 --terway 'eni'` 以开启公有云 CNI 网络插件
- 通过API,CLI和UI等方式快速创建K3s
- 云提供商集成(简化每个云的[CCM](https://kubernetes.io/docs/concepts/architecture/cloud-controller)设置)
- 灵活的安装选项,例如K3s群集HA和数据存储(内置etcd,RDS,SQLite等)
- 低成本(尝试每个云中的竞价实例)
- 通过UI简化操作
- 多云之间弹性迁移,借助诸如[backup-restore-operator](https://github.com/rancher/backup-restore-operator)这样的工具

## 支持的云提供商

有关更多用法的详细信息,请参见下面的链接
Autok3s可以支持以下云厂商,我们会根据社区反馈添加更多支持

- [alibaba](alibaba/README.md) - 在阿里云的 ECS 中初始化 Kubernetes (k3s) 集群
- [tencent](tencent/README.md) - 在腾讯云 CVM 中初始化 Kubernetes (k3s) 集群
- [native](native/README.md) - 在任意类型 VM 实例中初始化 Kubernetes (k3s) 集群
- [aws](aws/README.md) - 在亚马逊 EC2 中初始化 Kubernetes (k3s) 集群
- [alibaba](alibaba/README.md) - 在阿里云的 ECS 中初始化 k3s 集群
- [tencent](tencent/README.md) - 在腾讯云 CVM 中初始化 K3s 集群
- [native](native/README.md) - 在任意类型 VM 实例中初始化 K3s 集群
- [aws](aws/README.md) - 在亚马逊 EC2 中初始化 K3s 集群

## 快速体验

以下命令使用`alibaba`作为云提供商,相关的前置条件请参考[alibaba](alibaba/README.md)云提供商文档。
Autok3s可以两种不同的运行模式:Local Mode 和 Rancher Mode。

### Local Mode

在此模式下,可以使用CLI或本地UI。

以下命令使用Alibaba ECS Provider,请在运行之前检查[前提条件](alibaba/README.md)

```bash
export ECS_ACCESS_KEY_ID='<Your access key ID>'
export ECS_ACCESS_KEY_SECRET='<Your secret access key>'

autok3s -d create -p alibaba --name myk3s --master 1 --worker 1
```

### 添加 k3s 节点
如果要启用本地UI,请运行 `autok3s serve`

以下代码是为已有的 k3s 集群添加 k3s 节点的示例。名为“myk3s”的集群是已经运行在阿里云上 的 k3s 集群。这个命令使用了阿里云`alibaba`作为云提供商,为“myk3s”集群添加了 1 个 worker 节点。
![autok3s-local-ui](../../assets/autok3s-local-ui.png)

```bash
export ECS_ACCESS_KEY_ID='<Your access key ID>'
export ECS_ACCESS_KEY_SECRET='<Your secret access key>'
### Rancher Mode

autok3s join -p alibaba --name myk3s --worker 1
```
在这种模式下,您可以将Autok3s放入[Rancher](https://github.com/rancher/rancher)
它将作为Rancher的扩展,使您可以构建一套托管K3s服务。

## 快速体验 UI
Autok3s创建的K3s集群可以自动导入Rancher,并充分利用Rancher的Kubernetes管理功能。

如果您不想使用命令行工具体验,可以使用`autok3s`内置 UI 来体验相关功能,请运行命令 `autok3s serve`
此模式正在开发中。

## 演示视频

以下这个演示程序在 1 分钟左右就能将 Kubernetes (k3s)安装到阿里云的 ECS 实例上
在以下演示中,我们将在1分钟左右的时间内把K3s安装到 Alibaba ECS 云主机上

观看演示:

Expand All @@ -84,18 +87,3 @@ autok3s join -p alibaba --name myk3s --worker 1
- 测试: `BY=dapper make autok3s unit`
- 打包: `BY=dapper make autok3s package only`

# 开源协议

Copyright (c) 2020 [Rancher Labs, Inc.](http://rancher.com)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

0 comments on commit 9d30b1d

Please sign in to comment.