From 833a63dbcd9cfdd7db701fb959541a03d96d328f Mon Sep 17 00:00:00 2001 From: Ray Zhou Date: Mon, 23 Nov 2020 18:31:51 +0800 Subject: [PATCH] Update Chinese doc: install on linux and K8s of quickstarts Signed-off-by: Ray Zhou --- .../quick-start/minimal-kubesphere-on-k8s.md | 29 ++++++------ content/zh/docs/quick-start/_index.md | 2 - .../docs/quick-start/all-in-one-on-linux.md | 12 ++--- .../quick-start/minimal-kubesphere-on-k8s.md | 47 +++++++++---------- 4 files changed, 42 insertions(+), 48 deletions(-) diff --git a/content/en/docs/quick-start/minimal-kubesphere-on-k8s.md b/content/en/docs/quick-start/minimal-kubesphere-on-k8s.md index 3d1483b5b..4aa786654 100644 --- a/content/en/docs/quick-start/minimal-kubesphere-on-k8s.md +++ b/content/en/docs/quick-start/minimal-kubesphere-on-k8s.md @@ -11,9 +11,9 @@ In addition to installing KubeSphere on a Linux machine, you can also deploy it {{< notice note >}} -- To install KubeSphere on Kubernetes, your Kubernetes version must be `1.15.x, 1.16.x, 1.17.x, or 1.18.x`; -- Make sure your machine meets the minimal hardware requirement: CPU > 1 Core, Memory > 2 G; -- A default Storage Class in your Kubernetes cluster needs to be configured before the installation; +- To install KubeSphere on Kubernetes, your Kubernetes version must be `1.15.x, 1.16.x, 1.17.x, or 1.18.x`. +- Make sure your machine meets the minimal hardware requirement: CPU > 1 Core, Memory > 2 G. +- A **default** Storage Class in your Kubernetes cluster needs to be configured before the installation. - The CSR signing feature is activated in kube-apiserver when it is started with the `--cluster-signing-cert-file` and `--cluster-signing-key-file` parameters. See [RKE installation issue](https://github.com/kubesphere/kubesphere/issues/1925#issuecomment-591698309). - For more information about the prerequisites of installing KubeSphere on Kubernetes, see [Prerequisites](../../installing-on-kubernetes/introduction/prerequisites/). @@ -25,28 +25,29 @@ After you make sure your machine meets the prerequisites, you can follow the ste - Execute the following commands: -```bash -kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/kubesphere-installer.yaml + ```bash + kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/kubesphere-installer.yaml -kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml -``` + kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml + ``` - Inspect the logs of installation: -```bash -kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f -``` + ```bash + kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f + ``` - Use `kubectl get pod --all-namespaces` to see whether all pods are running normally in relevant namespaces of KubeSphere. If they are, check the port (30880 by default) of the console through the following command: -```bash -kubectl get svc/ks-console -n kubesphere-system -``` + ```bash + kubectl get svc/ks-console -n kubesphere-system + ``` - Make sure port 30880 is opened in security groups and access the web console through the NodePort (`IP:30880`) with the default account and password (`admin/P@88w0rd`). + - After logging in the console, you can check the status of different components in **Components**. You may need to wait for some components to be up and running if you want to use related services. -![components](/images/docs/quickstart/kubesphere-components.png) + ![components](/images/docs/quickstart/kubesphere-components.png) ## Enable Pluggable Components (Optional) diff --git a/content/zh/docs/quick-start/_index.md b/content/zh/docs/quick-start/_index.md index 64a55c69e..30801cb5c 100644 --- a/content/zh/docs/quick-start/_index.md +++ b/content/zh/docs/quick-start/_index.md @@ -36,5 +36,3 @@ icon: "/images/docs/docs.svg" ## [启用可插拔组件](../quick-start/enable-pluggable-components/) 了解如何在 KubeSphere 上启用可拔插组件，以便您全方位地探索 KubeSphere。安装前和安装后均可启用可插拔组件。 - - diff --git a/content/zh/docs/quick-start/all-in-one-on-linux.md b/content/zh/docs/quick-start/all-in-one-on-linux.md index 7738075c8..9c9bcaa24 100644 --- a/content/zh/docs/quick-start/all-in-one-on-linux.md +++ b/content/zh/docs/quick-start/all-in-one-on-linux.md @@ -1,5 +1,5 @@ --- -title: "Linux 上的 All-in-one 安装" +title: "在 Linux 上安装 All-in-one KubeSphere" keywords: 'KubeSphere, Kubernetes, All-in-one, Installation' description: 'All-in-one Installation on Linux' @@ -41,7 +41,7 @@ weight: 3010 {{< notice note >}} -如果您想离线安装 KubeShpere，那么必须安装好 `docker`。 +如果您想离线安装 KubeSphere，那么必须预先安装好 `docker`。 {{}} @@ -58,19 +58,19 @@ KubeKey 可以将 Kubernetes 和 KubeSphere 一起安装。针对不同的 Kuber {{< notice info >}} -KubeKey 是用 Go 语言开发的，是一种全新的安装工具，可以代替以前使用的基于 ansible 的安装程序。KubeKey 为用户提供了灵活的安装选择，可以分别安装 KubeSphere 和 Kubernetes 或二者同时安装，既方便又高效。 +KubeKey 是用 Go 语言开发的一款全新的安装工具，可以代替以前基于 ansible 的安装程序。KubeKey 为用户提供了灵活的安装选择，可以分别安装 KubeSphere 和 Kubernetes 或二者同时安装，既方便又高效。 {{}} ### 网络和 DNS 配置 - 必须确保 `/etc/resolv.conf` 中的 DNS 配置是可用的，不然集群中的 DNS 可能会有问题。 -- 如果您的网络配置使用了防火墙或安全组，则必须确保基础组件可以通过特定端口相互通信，可以根据文档[需要开发的端口](../../installing-on-linux/introduction/port-firewall/)的指导将防火墙关闭。 +- 如果您的网络配置使用了防火墙或安全组，则必须确保基础组件可以通过特定端口相互通信，可以根据文档[需要开放的端口](../../installing-on-linux/introduction/port-firewall/)的指导将防火墙关闭。 {{< notice tip >}} - 建议操作系统处于干净的状态（不安装任何其他软件），否则可能会发生冲突。 -- 如果您无法从 dockerhub.io 下载容器镜像，建议提前准备好容器镜像或者配置镜像加速器。参考 [加速安装的配置](../../installing-on-linux/faq/configure-booster/)。 +- 如果您无法从 dockerhub.io 下载容器镜像，建议提前准备好容器镜像或者配置镜像加速器。参考[加速安装的配置](../../installing-on-linux/faq/configure-booster/)。 {{}} @@ -148,7 +148,7 @@ chmod +x kk kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f ``` -输出会显示 Web 控制台的 IP 地址和端口号，默认的 NodePort 是 `30880`。现在，您可以使用默认的帐户和密码（`admin /P@88w0rd`）通过 `EIP：30880` 访问控制台。 +输出会显示 Web 控制台的 IP 地址和端口号，默认的 NodePort 是 `30880`。现在可以使用默认的帐户和密码（`admin /P@88w0rd`）通过 `EIP：30880` 访问控制台。 ```bash ##################################################### diff --git a/content/zh/docs/quick-start/minimal-kubesphere-on-k8s.md b/content/zh/docs/quick-start/minimal-kubesphere-on-k8s.md index be5f3cbca..3a76647ae 100644 --- a/content/zh/docs/quick-start/minimal-kubesphere-on-k8s.md +++ b/content/zh/docs/quick-start/minimal-kubesphere-on-k8s.md @@ -1,62 +1,57 @@ --- -title: "在 Kubernetes 最小化安装 KubeSphere" +title: "在 Kubernetes 上最小化安装 KubeSphere" keywords: 'kubesphere, kubernetes, docker, multi-tenant' -description: '在 Kubernetes 最小化安装 KubeSphere' +description: '在已有 Kubernetes 集群上安装最小化 KubeSphere' -linkTitle: "在 Kubernetes 最小化安装 KubeSphere" +linkTitle: "在 Kubernetes 上最小化安装 KubeSphere" weight: 3020 --- -除了在 Linux 机器上安装 KubeSphere 之外，您还可以将其直接部署在现有的 Kubernetes 集群上。本快速入门指南将引导您完成在 Kubernetes 上最小化安装 KubeSphere 的一般步骤。有关更多信息，请参阅在 [Kubernetes 上安装](../../installing-on-kubernetes/)。 +除了在 Linux 机器上安装 KubeSphere 之外，您还可以将其直接部署在现有的 Kubernetes 集群上。本快速入门指南将引导您完成在 Kubernetes 上最小化安装 KubeSphere 的一般步骤。有关更多信息，请参阅在 [Kubernetes 上安装 KubeSphere](../../installing-on-kubernetes/)。 {{< notice note >}} - Kubernetes 版本必须为 “1.15.x，1.16.x，1.17.x 或 1.18.x”； - 确保您的计算机满足最低硬件要求：CPU > 1 核，内存 > 2 G； -- 在安装之前，需要配置 Kubernetes 集群中的默认存储类； -- 当使用 `--cluster-signing-cert-file` 和 `--cluster-signing-key-file` 参数启动时，在 kube-apiserver 中会激活 CSR 签名功能。 请参阅 [RKE 安装问题](https://github.com/kubesphere/kubesphere/issues/1925#issuecomment-591698309)； +- 在安装之前，需要配置 Kubernetes 集群中的**默认**存储类； +- 当使用 `--cluster-signing-cert-file` 和 `--cluster-signing-key-file` 参数启动时，在 kube-apiserver 中会激活 CSR 签名功能。请参阅 [RKE 安装问题](https://github.com/kubesphere/kubesphere/issues/1925#issuecomment-591698309)； - 有关在 Kubernetes 上安装 KubeSphere 的前提条件的详细信息，请参阅[前提条件](../../installing-on-kubernetes/introduction/prerequisites/)。 {{}} ## 部署 KubeSphere -确保您的计算机满足前提条件之后，您可以按照以下步骤安装 KubeSphere。 +确保您的计算机满足前提条件之后，可以按照以下步骤安装 KubeSphere。 - 在执行命令开始安装之前，请阅读以下注释： -```bash -kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/kubesphere-installer.yaml + ```bash + kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/kubesphere-installer.yaml -kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml -``` + kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml + ``` -{{< notice note >}} +- 检查安装日志： -如果您的服务器无法访问 GitHub，则可以分别复制 [kubesphere-installer.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/kubesphere-installer.yaml) 和 [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) 中的内容并将其粘贴到本地文件中。然后，您可以对本地文件使用 `kubectl apply -f` 来安装 KubeSphere。 - -{{}} - -检查安装日志： - -```bash -kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f -``` + ```bash + kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f + ``` - 使用 `kubectl get pod --all-namespaces` 查看所有 Pod 是否在 KubeSphere 的相关命名空间中正常运行。如果是，请通过以下命令检查控制台的端口（默认为 30880）： -```bash -kubectl get svc/ks-console -n kubesphere-system -``` + ```bash + kubectl get svc/ks-console -n kubesphere-system + ``` - 确保在安全组中打开了端口 30880，并通过 NodePort（IP：30880）使用默认帐户和密码（admin/P@88w0rd）访问 Web 控制台。 + - 登录控制台后，您可以在***组件***中检查不同组件的状态。如果要使用相关服务，可能需要等待某些组件启动并运行。 -![components](/images/docs/quickstart/kubesphere-components-zh.png) + ![components](/images/docs/quickstart/kubesphere-components-zh.png) ## 启用可插拔组件（可选） -上面的指南默认情况下仅用于最小化安装。要在 KubeSphere 中启用其他组件，请参阅[启用可插拔组件](../../pluggable-components/)以获取更多详细信息。 +上面的指南默认情况下仅用于最小化安装，要在 KubeSphere 中启用其他组件，请参阅[启用可插拔组件](../../pluggable-components/)以获取更多详细信息。 ## 示例