update README and LOGO #1037
update README and LOGO #1037
Conversation
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: pixiake The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
ks-ci-bot
added
approved
|
/cc @kubesphere/sig-docs |
README.md
Outdated
|
|
||
| There are three scenarios to use KubeKey. | ||
| KubeKey is an open source lightweight tool for deploying kubernetes clusters. It provides a flexible, rapid and convenient way to install Kubernetes/k3s only, both Kubernetes/k3s and KubeSphere, and related cloud-native add-ons. It is also an efficient tool to scale and upgrade your cluster. |
There was a problem hiding this comment.
open source -> open-source
kubernetes -> Kubernetes
flexible, rapid and convenient -> flexible, rapid, and convenient
README.md
Outdated
| There are three scenarios to use KubeKey. | ||
| KubeKey is an open source lightweight tool for deploying kubernetes clusters. It provides a flexible, rapid and convenient way to install Kubernetes/k3s only, both Kubernetes/k3s and KubeSphere, and related cloud-native add-ons. It is also an efficient tool to scale and upgrade your cluster. | ||
|
|
||
| In addition, KubeKey also supports customized Air-Gap package, which is convenient for users to quickly deploy clusters in offline environment. |
There was a problem hiding this comment.
Air-Gap package -> air-gap packages (As I understand it, KK supports more than one type of air-gap package? Also, if Air-Gap is written to emphasize the air-gap feature, then I'm fine with the capitalization and you can keep it that way.)
offline environment -> offline environments
There was a problem hiding this comment.
Yes, air-gap is a new feature.
README.md
Outdated
|
|
||
| > **Important:** If you have existing clusters, please refer to [ks-installer (Install KubeSphere on existing Kubernetes cluster)](https://github.com/kubesphere/ks-installer). | ||
| There are three scenarios to use KubeKey. |
There was a problem hiding this comment.
There are three scenarios to use KubeKey. -> Use KubeKey in the following three scenarios.
README.md
Outdated
| ## Motivation | ||
| * Install Kubernetes/k3s only | ||
| * Install Kubernetes/k3s and KubeSphere together in one command | ||
| * Install Kubernetes/k3s first, then deploy KubeSphere on it using [ks-installer](https://github.com/kubesphere/ks-installer) |
There was a problem hiding this comment.
I think all k3s should be updated to K3s.
README.md
Outdated
| * KubeKey uses Kubeadm to install K8s cluster on nodes in parallel as much as possible in order to reduce installation complexity and improve efficiency. It will greatly save installation time compared to the older installer. | ||
| * KubeKey supports for scaling cluster from allinone to multi-node cluster, even an HA cluster. | ||
| * KubeKey aims to install cluster as an object, i.e., CaaO. | ||
| > **Important:** If you have existing kubernetes clusters, please refer to [ks-installer (Install KubeSphere on existing Kubernetes cluster)](https://github.com/kubesphere/ks-installer). |
README.md
Outdated
| @@ -43,6 +42,14 @@ There are three scenarios to use KubeKey. | |||
| * **v1.22**:   *v1.22.1* | |||
| > Looking for more supported versions [Click here](./docs/kubernetes-versions.md) | |||
|
|
|||
| ### Container Manager | |||
| * **Docker** / **Containerd** / **CRI-O** / **iSula** | |||
README.md
Outdated
| @@ -43,6 +42,14 @@ There are three scenarios to use KubeKey. | |||
| * **v1.22**:   *v1.22.1* | |||
| > Looking for more supported versions [Click here](./docs/kubernetes-versions.md) | |||
|
|
|||
| ### Container Manager | |||
| * **Docker** / **Containerd** / **CRI-O** / **iSula** | |||
| > `Kata Containers` can be set to automatically install and configure runtime class for it when the container manager is Containerd or CRI-O. | |||
docs/developer-guide.md
Outdated
|
|
||
| * `Action`: The most basic unit. It represents one operation performed on one node; | ||
| * `Task`: The one that manages `Action`. It contains fields such as `Action`, nodes, whether to retry, whether to execute in parallel, etc. In short, it represents executing an `Action` on the specified nodes as required; |
There was a problem hiding this comment.
It contains fields such as
Action, nodes, whether to retry, whether to execute in parallel, etc.
This sentence looks strange to me, especially the part after Action.
There was a problem hiding this comment.
Task is the structure defined in the code, the following content describes some fields contained in this structure.
pixiake
force-pushed
the
doc
branch
4 times, most recently
from
a38c1b2
to
467185b
Compare
Signed-off-by: feng <guofeng@yunify.com>
|
/lgtm |
|
LGTM label has been added. Git tree hash: 71e156944659902ce292184cf9b5225dc4301469
|
What does this PR do?
Signed-off-by: feng guofeng@yunify.com