Skip to content

Commit

Permalink
docs(autok3s): fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
yzeng25 authored and Jason-ZW committed Feb 9, 2021
1 parent 162eb19 commit 14fb4ab
Show file tree
Hide file tree
Showing 10 changed files with 32 additions and 32 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ English / [简体中文](docs/i18n/zh_cn/README.md)

## What is AutoK3s

[K3s](https://github.com/k3s-io/k3s) is a fully certified Kubernetes offering, it can replace the "full-fat" K8s in some cases.Using K3s to create K3s clusters in public cloud providers is a complicated process. In addtion, users are required to fill in different parameters and fields in different cloud providers to create K3s clusters in them. AutoK3s is made to simplify this process.
[K3s](https://github.com/k3s-io/k3s) is a fully certified Kubernetes offering, it can replace the "full-fat" K8s in some cases. Using K3s to create K3s clusters in public cloud providers is a complicated process. Users are required to fill in different parameters and fields in different cloud providers to create K3s clusters in them. AutoK3s is made to simplify this process.

AutoK3s is a lightweight tool for simplifying the cluster management of K3s, it can help you **Run K3s Everywhere**. You can use AutoK3s to create and launch K3s clusters, or to add nodes in existing K3s clusters. AutoK3s not only improves user experience of cluster management on public clouds, but also inherites kubectl, provides users with accessible cluster management abilities. Currently, AutoK3s supports **Alibaba, Tencent, and AWS** cloud services. If the cloud providers you are using are not listed above, you can always use **native** mode to bootstrap clusters in you VM instances. We will support more cloud providers based on our user community's feedbacks.
AutoK3s is a lightweight tool for simplifying the cluster management of K3s, it can help you **Run K3s Everywhere**. You can use AutoK3s to create and launch K3s clusters, or to add nodes in existing K3s clusters. AutoK3s not only improves user experience of cluster management on cloud providers, but also inherites kubectl, which can provide users with convenient cluster management abilities. Currently, AutoK3s supports **Alibaba, Tencent, and AWS** cloud services. If the cloud providers you are using are not listed above, you can always use **native** mode to bootstrap clusters in you VM instances. We will support more cloud providers based on our user community's feedbacks.

<!-- toc -->

Expand All @@ -31,8 +31,8 @@ AutoK3s is a lightweight tool for simplifying the cluster management of K3s, it

## Key Features

- 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).
- Shorter provisioning time with API, CLI and UI dashboard.
- Cloud provider Integration(simplifies the setup process of [CCM](https://kubernetes.io/docs/concepts/architecture/cloud-controller) on cloud providers).
- 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.
Expand All @@ -59,7 +59,7 @@ These commands are frequently used in AutoK3s:
These parameters are frequently used in AutoK3s:

- `-d` or `--debug`: To enable debug mode.
- `-p` or `--provider`: To specify which cloud provider to use, please see the description below for more details.
- `-p` or `--provider`: To specify which cloud provider to use.
- `-n` or `--name`: To specify the name of the cluster.
- `--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.
Expand Down
10 changes: 5 additions & 5 deletions docs/i18n/en_us/alibaba/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ English / [简体中文](https://github.com/cnrancher/autok3s/blob/master/docs/i

## Introduction

This article provides users with the instrcutions to create and launch a K3s cluster on an Alibaba ECS instance, and to add nodes for an existing K3s cluster on Alibaba ECS instance. In additon, this article provides guidance of advanced usages of running K3s on Alibaba ECS, such as enabling Alibaba Terway CNI, enabling Alibaba CCM, and enabling UI components.
This article provides users with the instructions to create and launch a K3s cluster on an Alibaba ECS instance, and to add nodes for an existing K3s cluster on Alibaba ECS instance. In additon, this article provides guidance of advanced usages of running K3s on Alibaba ECS, such as setting up private registry, enabling Alibaba Terway CNI, enabling Alibaba CCM, and enabling UI components.

## Prerequisites

Expand All @@ -23,7 +23,7 @@ export ECS_ACCESS_KEY_SECRET='<secret-access>'

Please visit [here](https://www.alibabacloud.com/help/doc-detail/54235.htm) to better understand RAM role in Alibaba.

This provider needs certain permissions to access Alibaba Cloud. Therefore, you need to create some RAM policies 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:
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
{
Expand Down Expand Up @@ -104,7 +104,7 @@ This provider needs certain permissions to access Alibaba Cloud. Therefore, you

### Setting up Security Group

The ECS instances need to apply the following **minimum** Security Group Rules:
The ECS instance needs to apply the following **minimum** Security Group Rules:

```bash
Rule Protocol Port Source Description
Expand Down Expand Up @@ -270,7 +270,7 @@ Nodes:

## Access K3s Cluster

After the cluster created, `autok3s` will automatically merge the `kubeconfig` which necessary for us to access the cluster.
After the cluster is created, `autok3s` will automatically merge the `kubeconfig` so that you can access the cluster.

```bash
autok3s kubectl config use-context myk3s.cn-hangzhou.alibaba
Expand All @@ -286,7 +286,7 @@ autok3s kubectl config use-context <context>

## SSH K3s Cluster's Node

Login to specified k3s cluster node via ssh, e.g myk3s.
Login to a specific k3s cluster node via ssh, e.g myk3s.

```bash
autok3s ssh --provider alibaba --name myk3s
Expand Down
12 changes: 6 additions & 6 deletions docs/i18n/en_us/aws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ English / [简体中文](https://github.com/cnrancher/autok3s/blob/master/docs/i

## Introduction

This article provides users with the instrcutions to create and launch a K3s cluster on an AWS EC2 instance, and to add nodes for an existing K3s cluster on AWS EC2 instance. In additon, this article provides guidance of advanced usages of running K3s on AWS EC2, such as setting up private registry, enabling AWS CCM, and enabling UI components.
This article provides users with the instructions to create and launch a K3s cluster on an AWS EC2 instance, and to add nodes for an existing K3s cluster on AWS EC2 instance. In additon, this article provides guidance of advanced usages of running K3s on AWS EC2, such as setting up private registry, enabling AWS CCM, and enabling UI components.

## Prerequisites

To ensure that EC2 instances can be created and accessed successfully, please follow the instructions below.

### Setting up Environment

Configure the following environment variables for the host which running `autok3s`.
Configure the following environment variables for the host on which you are running `autok3s`.

```bash
export AWS_ACCESS_KEY_ID='<access-key>'
Expand Down Expand Up @@ -106,7 +106,7 @@ The following requirements must be met before creating an HA K3s cluster with ex
- The number of master nodes in this cluster must be greater or equal to 1.
- The external database information must be specified within `--datastore "PATH"` parameter.

In the example below, `--master 2` specifies the number of master nodes to be 2, while `--datastore "PATH"` specifies the external database information. As a result, requirements listed above are met.
In the example below, `--master 2` specifies the number of master nodes to be 2, `--datastore "PATH"` specifies the external database information. As a result, requirements listed above are met.

Run the command below and create an HA K3s cluster with external database:

Expand Down Expand Up @@ -200,7 +200,7 @@ Nodes:

## Access K3s Cluster

After the cluster created, `autok3s` will automatically merge the `kubeconfig` which necessary for us to access the cluster.
After the cluster is created, `autok3s` will automatically merge the `kubeconfig` so that you can access the cluster.

```bash
autok3s kubectl config use-context myk3s.ap-southeast-2.aws
Expand All @@ -216,7 +216,7 @@ autok3s kubectl config use-context <context>

## SSH K3s Cluster's Node

Login to specified k3s cluster node via ssh, e.g myk3s.
Login to a specific k3s cluster node via ssh, e.g myk3s.

```bash
autok3s ssh --provider aws --name myk3s
Expand Down Expand Up @@ -250,7 +250,7 @@ configs:
ca_file: # path to the ca file used in the registry
```

When running `autok3s create` or `autok3s join` command, take effect with the`--registry /etc/autok3s/registries.yaml` flag, e.g:
When running `autok3s create` or `autok3s join` command, it will take effect with the`--registry /etc/autok3s/registries.yaml` flag, e.g:

```bash
autok3s -d create \
Expand Down
8 changes: 4 additions & 4 deletions docs/i18n/en_us/native/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ English / [简体中文](https://github.com/cnrancher/autok3s/blob/master/docs/i

## Introduction

This article provides users with the instrcutions to create and launch a K3s cluster on a virtual machine(VM), and to add nodes for an existing K3s cluster on the VM. In additon, this article provides guidance of advanced usages of running K3s on VM, such as setting up private registry, and enabling UI components.
This article provides users with the instructions to create and launch a K3s cluster on a virtual machine(VM), and to add nodes for an existing K3s cluster on the VM. In additon, this article provides guidance of advanced usages of running K3s on VM, such as setting up private registry, and enabling UI components.

## Prerequisites

Expand Down Expand Up @@ -68,7 +68,7 @@ The following requirements must be met before creating an HA K3s cluster with ex
- The number of master nodes in this cluster must be greater or equal to 1.
- The external database information must be specified within `--datastore "PATH"` parameter.

In the example below, `--master-ips <master-ip-1,master-ip-2>` specifies the number of master nodes to be 2, while `--datastore "PATH"` specifies the external database information. As a result, requirements listed above are met.
In the example below, `--master-ips <master-ip-1,master-ip-2>` specifies the number of master nodes to be 2, `--datastore "PATH"` specifies the external database information. As a result, requirements listed above are met.

Run the command below and create an HA K3s cluster with external database:

Expand Down Expand Up @@ -131,7 +131,7 @@ autok3s -d join \

## Access K3s Cluster

After the cluster created, `autok3s` will automatically merge the `kubeconfig` which necessary for us to access the cluster.
After the cluster is created, `autok3s` will automatically merge the `kubeconfig` so that you can access the cluster.

```bash
autok3s kubectl config use-context myk3s
Expand All @@ -155,7 +155,7 @@ We integrate some advanced components such as private registries and UI related

### Setting up Private Registry

When running `autok3s create` or `autok3s join` command, take effect with the`--registry /etc/autok3s/registries.yaml` flag, e.g:
When running `autok3s create` or `autok3s join` command, it takes effect with the`--registry /etc/autok3s/registries.yaml` flag, e.g:

```bash
autok3s -d create \
Expand Down
6 changes: 3 additions & 3 deletions docs/i18n/en_us/tencent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ English / [简体中文](https://github.com/cnrancher/autok3s/blob/master/docs/i

## Introduction

This article provides users with the instrcutions to create and launch a K3s cluster on an Tencent CVM instance, and to add nodes for an existing K3s cluster on Tencent CVM instance. In additon, this article provides guidance of advanced usages of running K3s on Tencent CVM, such as setting up private registry, enabling Tencent CCM, and enabling UI components.
This article provides users with the instructions to create and launch a K3s cluster on an Tencent CVM instance, and to add nodes for an existing K3s cluster on Tencent CVM instance. In additon, this article provides guidance of advanced usages of running K3s on Tencent CVM, such as setting up private registry, enabling Tencent CCM, and enabling UI components.

## Prerequisites

Expand Down Expand Up @@ -230,7 +230,7 @@ Nodes:

## Access K3s Cluster

After the cluster created, `autok3s` will automatically merge the `kubeconfig` which necessary for us to access the cluster.
After the cluster is created, `autok3s` will automatically merge the `kubeconfig` so that you can access the cluster.

```bash
autok3s kubectl config use-context myk3s.ap-guangzhou.tencent
Expand All @@ -246,7 +246,7 @@ autok3s kubectl config use-context <context>

## SSH K3s Cluster's Node

Login to specified k3s cluster node via ssh, e.g myk3s.
Login to a specific k3s cluster node via ssh, e.g myk3s.

```bash
autok3s ssh --provider tencent --name myk3s
Expand Down
10 changes: 5 additions & 5 deletions docs/i18n/zh_cn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

[K3s](https://github.com/k3s-io/k3s)是经过完全认证的 Kubernetes 产品,在某些情况下可以替代完整的 K8s。使用 K3s 在公有云中创建集群的过程比较复杂,在各个公有云中创建 K3s 集群所需填写的参数也有差异。为了降低 K3s 的使用门槛,简化使用 K3s 的过程,我们开发了 AutoK3s 这一款辅助工具。

AutoK3s 是用于简化 K3s 集群管理的轻量级工具,您可以使用 Autok3s 在任何地方运行 K3s,Run K3s Everywhere。您可以使用 AutoK3s 快速创建并启动 K3s 集群,也可以使用它来为已有的 K3s 集群添加节点,不仅提升公有云的使用体验,同时还继承了 kubectl,提供了便捷的集群能力。目前 AutoK3s 支持的云服务提供商包括**阿里云、腾讯云和 AWS**,如果您使用的云服务提供商不属于以上三家,您可以使用`native`模式,在任意类型的虚拟机实例中初始化 k3s 集群。在后续的开发过程中,我们会根据社区反馈,为其他云服务提供商提供适配。
AutoK3s 是用于简化 K3s 集群管理的轻量级工具,您可以使用 AutoK3s 在任何地方运行 K3s,Run K3s Everywhere。您可以使用 AutoK3s 快速创建并启动 K3s 集群,也可以使用它来为已有的 K3s 集群添加节点,不仅提升公有云的使用体验,同时还继承了 kubectl,提供了便捷的集群能力。目前 AutoK3s 支持的云服务提供商包括**阿里云、腾讯云和 AWS**,如果您使用的云服务提供商不属于以上三家,您可以使用`native`模式,在任意类型的虚拟机实例中初始化 K3s 集群。在后续的开发过程中,我们会根据社区反馈,为其他云服务提供商提供适配。

<!-- toc -->

Expand All @@ -30,12 +30,12 @@ AutoK3s 是用于简化 K3s 集群管理的轻量级工具,您可以使用 Aut

## 关键特性

- 通过 APICLI 和 UI 等方式快速创建 K3s。
- 通过 APICLI 和 UI 等方式快速创建 K3s。
- 云提供商集成(简化每个云的[CCM](https://kubernetes.io/docs/concepts/architecture/cloud-controller)设置)。
- 灵活的安装选项,例如 K3s 群集 HA 和数据存储(内置 etcdRDSSQLite 等)。
- 灵活的安装选项,例如 K3s 集群 HA 和数据存储(内置 etcdRDSSQLite 等)。
- 低成本(尝试每个云中的竞价实例)。
- 通过 UI 简化操作。
- 多云之间弹性迁移,借助诸如[backup-restore-operator](https://github.com/rancher/backup-restore-operator)这样的工具
- 多云之间弹性迁移,借助诸如[backup-restore-operator](https://github.com/rancher/backup-restore-operator)这样的工具进行弹性迁移

## 支持的云提供商

Expand All @@ -56,7 +56,7 @@ AutoK3s 可以支持以下云厂商,我们会根据社区反馈添加更多支
AutoK3s 命令中常用的参数如下:

- `-d``--debug`:开启 debug 模式。
- `-p``--provider`:provider,即云服务提供商,详情参考下文描述
- `-p``--provider`:provider,即云服务提供商。
- `-n``--name`:指定将要创建的集群的名称。
- `--master`:指定创建的 master 节点数量。
- `--worker`:指定创建的 worker 节点数量。
Expand Down
2 changes: 1 addition & 1 deletion docs/i18n/zh_cn/alibaba/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ autok3s kubectl config use-context myk3s.cn-hangzhou.alibaba
autok3s kubectl <sub-commands> <flags>
```

在多个群集的场景下,可以通过切换上下文来完成对不同群集的访问
在多个集群的场景下,可以通过切换上下文来完成对不同集群的访问

```bash
autok3s kubectl config get-contexts
Expand Down
2 changes: 1 addition & 1 deletion docs/i18n/zh_cn/aws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ autok3s kubectl config use-context myk3s.ap-southeast-2.aws
autok3s kubectl <sub-commands> <flags>
```

在多个群集的场景下,可以通过切换上下文来完成对不同群集的访问
在多个集群的场景下,可以通过切换上下文来完成对不同集群的访问

```bash
autok3s kubectl config get-contexts
Expand Down
2 changes: 1 addition & 1 deletion docs/i18n/zh_cn/native/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ autok3s kubectl config use-context myk3s
autok3s kubectl <sub-commands> <flags>
```

在多个群集的场景下,可以通过切换上下文来完成对不同群集的访问
在多个集群的场景下,可以通过切换上下文来完成对不同集群的访问

```bash
autok3s kubectl config get-contexts
Expand Down
2 changes: 1 addition & 1 deletion docs/i18n/zh_cn/tencent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ autok3s kubectl config use-context myk3s.ap-nanjing.tecent
autok3s kubectl <sub-commands> <flags>
```

在多个群集的场景下,可以通过切换上下文来完成对不同群集的访问
在多个集群的场景下,可以通过切换上下文来完成对不同集群的访问

```bash
autok3s kubectl config get-contexts
Expand Down

0 comments on commit 14fb4ab

Please sign in to comment.