Skip to content

Commit

Permalink
docs: update format and fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
willemswang authored and tke-robot committed Aug 27, 2020
1 parent b730ab4 commit 6d16a50
Show file tree
Hide file tree
Showing 33 changed files with 201 additions and 247 deletions.
13 changes: 7 additions & 6 deletions docs/guide/zh-CN/QuickStart/examples/创建简单nginx服务.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# 创建简单的nginx服务

## 操作场景

本文档旨在帮助大家了解如何快速创建一个容器集群内的 nginx 服务。

## 前提条件
>- 已部署 [TKEStack 控制台](../../installation/installation-procedures.md)
>- 已创建集群。如没有另外创建集群,可以先使用global集群。如要尝试创建新集群,请参见 [创建集群](../../products/platform/cluster.md)
## 操作步骤

### 创建 Nginx 服务
## 创建 Nginx 服务

1. 登录TKEStack 控制台 。

Expand Down Expand Up @@ -35,18 +36,18 @@
![](../../../../images/nginx-6.png)


### 访问 Nginx 服务
## 访问 Nginx 服务

可通过以下两种方式访问 nginx 服务。

#### 通过主机节点端口访问 nginx 服务
### 通过主机节点端口访问 nginx 服务

在本地主机的浏览器地址栏输入`集群任意节点IP:30000 端口`,例如`10.0.0.1:30000`即可访问服务。如果服务创建成功,访问服务时直接进入 nginx 服务器的默认欢迎页。如下图所示:

> 注意:如果本地主机在集群内网中,输入节点的内网IP地址即可;如果本地主机不在集群内网中,需要输入节点的外网IP地址
![](https://main.qcloudimg.com/raw/37246241fe0abd1d3796c080b1661217.png)

#### 通过服务名称访问 nginx 服务
### 通过服务名称访问 nginx 服务

集群内的其他服务或容器可以直接通过服务名称访问。
21 changes: 9 additions & 12 deletions docs/guide/zh-CN/QuickStart/examples/编写Hello-World程序.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@
- 已部署 [TKEStack 控制台](../../installation/installation-procedures.md)
- 已创建集群。如没有另外创建集群,可以先使用global集群。如要尝试创建新集群,请参见 [创建集群](../../products/platform/cluster.md)

## 操作步骤
### 编写代码制作镜像
#### 编写应用程序
## 制作镜像
### 编写应用程序

以CentOS 7.6为例

Expand Down Expand Up @@ -58,7 +57,7 @@ node server.js
> 注意:如果本地主机不在该节点所在的内网,IP地址应该是该节点的外网地址

#### 创建 Docker 镜像
### 创建 Docker 镜像
1. 在 hellonode 文件夹下,创建 Dockerfile 文件。
```
[root@VM_1_98_centos hellonode]# vim Dockerfile
Expand All @@ -83,7 +82,7 @@ docker images
![](../../../../images/helloworld-3.png)


#### 上传该镜像到镜像仓库
### 上传该镜像到镜像仓库
>- 已在[【组织资源】](../../../zh-CN/products/platform/resource.md)中的【镜像仓库管理】创建命名空间。
>- 已在[【组织资源】](../../../zh-CN/products/platform/resource.md)中的【访问凭证】创建访问凭证。
Expand All @@ -100,13 +99,13 @@ sudo docker push default.registry.tke.com/【命名空间】/helloworld:v1
显示以下结果,则说明镜像上传成功。
![](../../../../images/helloworld-4.png)

#### 在镜像仓库命名空间中进行确认
### 在镜像仓库命名空间中进行确认

![](../../../../images/helloworld-6.png)



### 通过该镜像创建 Hello World 服务
## 通过该镜像创建 Hello World 服务

1. 登录 TKEStack 控制台。
2. 单击左侧导航栏中【集群管理】,进入“集群管理”页面。
Expand All @@ -122,19 +121,17 @@ sudo docker push default.registry.tke.com/【命名空间】/helloworld:v1
>2. 服务所在集群的安全组需要放通节点网络及容器网络,同时需要放通30000 - 32768端口,否则可能会出现容器服务无法使用问题。
5. 单击【创建Workload】,完成 Hello World 服务的创建。

### 访问 Hello World 服务
## 访问 Hello World 服务
可通过以下两种方式访问 Hello World 服务。
#### 通过主机节点端口访问 Hello World 服务
### 通过主机节点端口访问 Hello World 服务
1. 选择【服务】>【Service】,在“Service”管理页面,看到与名为helloworld的Deployment同名的 helloworld Service已经运行,如下图所示:![](../../../../images/helloworld-11.png)

2. 在本地主机的浏览器地址栏输入`集群任意节点IP:30000 端口`,例如`10.0.0.1:30000`即可访问服务。如果服务创建成功,访问服务时页面会返回` Hello World! `

> 注意:如果本地主机在集群内网中,输入节点的内网IP地址即可;如果本地主机不在集群内网中,需要输入节点的外网IP地址
#### 通过服务名称访问 Hello World 服务
### 通过服务名称访问 Hello World 服务

集群内的其他服务或容器可以直接通过服务名称访问。



更多关于Docker 镜像请参见 [如何构建 Docker 镜像](https://github.com/tkestack/docs/blob/master/QuickStart/%E5%85%A5%E9%97%A8%E7%A4%BA%E4%BE%8B/%E5%A6%82%E4%BD%95%E6%9E%84%E5%BB%BAdocker%E9%95%9C%E5%83%8F.md)
57 changes: 15 additions & 42 deletions docs/guide/zh-CN/QuickStart/快速入门.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,76 +5,52 @@

TKEStack是一款面向私有化环境的开源容器编排引擎。在本教程中,您将了解如何创建 TKEStack 控制台,并使用控制台创建和管理容器集群,在集群内快速、弹性地部署您的服务。

## 平台安装

参考:[安装步骤](../installation/installation-procedures.md)

## 操作步骤

### 平台安装

参考:[installation-procedures](../installation/installation-procedures.md)

### 集群
## 集群

平台安装之后,可在【平台管理】控制台的【集群管理】中看到global集群。如下图所示:
![Global集群](../../../images/cluster.png)

TKEStack还可以另外**新建独立集群**以及**导入已有集群**实现**多集群的管理**
TKEStack还可以另外**新建独立集群**以及**【导入集群】**实现**多集群的管理**

> 注意:**新建独立集群****导入已有集群**都属于[TKEStack架构](../installation/installation-architecture.md)中的**业务集群**
#### 新建独立集群

1. 登录 TKEStack,右上角会出现当前登录的用户名,示例为admin。

2. 切换至【平台管理】控制台。

3. 在“集群管理”页面中,单击【新建独立集群】。如下图所示:
![新建独立集群](../../../images/createCluster.png)

4. 在“新建独立集群”页面,填写集群的基本信息。新建的集群需满足[installation requirements](../../../../docs/guide/zh-CN/installation/installation-requirement.md)的需求,在满足需求之后,TKEStack的集群添加非常便利。如下图所示,只需填写【集群名称】、【目标机器】、【密码】,其他保持默认即可添加新的集群。

4. 在“新建独立集群”页面,填写集群的基本信息。新建的集群需满足[部署环境要求](../../../../docs/guide/zh-CN/installation/installation-requirement.md),在满足需求之后,TKEStack的集群添加非常便利。如下图所示,只需填写【集群名称】、【目标机器】、【SSH端口】、【密码】,其他保持默认即可添加新的集群。
> 注意:若【保存】按钮是灰色,单击附近空白处即可变蓝
![集群基本信息0.png](../../../images/ClusterInfo.png)

- **集群名称:** 支持**中文**,小于60字符即可

+ **集群名称:** 支持**中文**,小于60字符即可
+ **Kubernetes版本:** 选择合适的kubernetes版本,各版本特性对比请查看 [Supported Versions of the Kubernetes Documentation](https://kubernetes.io/docs/home/supported-doc-versions/)。(**建议使用默认值**

+ **网卡名称:** 最长63个字符,只能包含小写字母、数字及分隔符(' - '),且必须以小写字母开头,数字或小写字母结尾。(**建议使用默认值eth0**

+ **VIP** :高可用 VIP 地址。(**按需使用**

+ **GPU**:选择是否安装 GPU 相关依赖。(**按需使用**
+ **pGPU**:平台会自动为集群安装 [GPUManager](https://github.com/tkestack/docs/blob/master/features/gpumanager.md) 扩展组件
+ **vGPU**:平台会自动为集群安装 [Nvidia-k8s-device-plugin](https://github.com/NVIDIA/k8s-device-plugin)

+ **容器网络** :将为集群内容器分配在容器网络地址范围内的 IP 地址,您可以自定义三大私有网段作为容器网络, 根据您选择的集群内服务数量的上限,自动分配适当大小的 CIDR 段用于 kubernetes service;根据您选择 Pod 数量上限/节点,自动为集群内每台云服务器分配一个适当大小的网段用于该主机分配 Pod 的 IP 地址。(**建议使用默认值**
+ **CIDR**: 集群内 Sevice、 Pod 等资源所在网段。

+ **Pod数量上限/节点**: 决定分配给每个 Node 的 CIDR 的大小。

+ **Service数量上限/集群** :决定分配给 Sevice 的 CIDR 大小。

+ **目标机器**

+ **目标机器**:节点的内网地址。(建议: Master&Etcd 节点配置**4核**及以上的机型)

+ **SSH端口**: 请确保目标机器安全组开放 22 端口和 ICMP 协议,否则无法远程登录和 PING 云服务器。(**建议使用默认值22**

+ **主机label**:给主机设置Label,可用于指定容器调度。(**按需使用**

+ **认证方式**:连接目标机器的方式
+ **密码认证**
+ **密码**:目标机器密码
+ **密钥认证**
+ **私钥**:目标机器秘钥
+ **私钥密码**:目标机器私钥密码,可选填

+ **GPU**: 使用GPU机器需提前安装驱动和runtime。(**按需使用**

> 输入以上信息后单击【保存】后还可**继续添加集群的节点**
5. **提交**: 集群信息填写完毕后,【提交】按钮变为可提交状态,单击即可提交。

#### 导入已有集群
Expand All @@ -83,22 +59,20 @@ TKEStack还可以另外**新建独立集群**以及**导入已有集群**实现*
2. 切换至【平台管理】控制台。
3. 在“集群管理”页面,单击【导入集群】。如下图所示:
![导入集群](../../../images/importCluster-1.png)

4. 在“导入集群”页面,填写被导入的集群信息。如下图所示:
![导入集群信息](../../../images/importCluster-2.png)
- **名称**: 被导入集群的名称,最长60字符
- **API Server**: 被导入集群的API server的域名或IP地址
- **CertFile**: 输入被导入集群的 CertFile 文件内容
- **Token**: 输入被导入集群创建时的token值
1. 单击最下方 【提交】 按钮 。

- **名称**: 被导入集群的名称,最长60字符
- **API Server**
- 被导入集群的API server的域名或IP地址,注意域名不能加上https://
- **CertFile**: 输入被导入集群的cert 文件内容
- **Token**: 输入被导入集群创建时的token值
## 业务

5. 单击最下方 【提交】 按钮 。
TKEStack独创的概念,业务可以实现跨集群资源的使用

### 创建业务

> 注:业务可以实现跨集群资源的使用
1. 登录 TKEStack。
2. 在【平台管理】控制台的【业务管理】中,单击 【新建业务】。如下图所示:
![新建业务](../../../images/createbusiness.png)
Expand All @@ -121,7 +95,6 @@ TKEStack还可以另外**新建独立集群**以及**导入已有集群**实现*
![业务id](../../../images/businessid.png)

3. 单击【Namespace列表】。如下图标签1所示:

> 该页面可以更改业务名称、成员、以及业务下集群资源的限制。
![命名空间列表](../../../images/businessns.png)
Expand Down Expand Up @@ -234,7 +207,7 @@ TKEStack还可以另外**新建独立集群**以及**导入已有集群**实现*

![](../../../images/business-svc.png)

### 删除资源
### 删除业务下的资源

在本节中,启动了`my-business`业务下的 Deployment 和 Service 两种资源,此步骤介绍如何清除所有资源。

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/zh-CN/catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
* [Job ](products/business-control-pannel/application/workload/job.md)
* [CronJob ](products/business-control-pannel/application/workload/cron-job.md)
* [TApp ](products/business-control-pannel/application/workload/tapp.md)
* [设置工作负载的资源限制](products/business-control-pannel/application/workload/resource-limit.md)
* [工作负载的请求与限制](products/business-control-pannel/application/workload/resource-limit.md)
* [服务](products/business-control-pannel/application/services)
* [Service ](products/business-control-pannel/application/services/service.md)
* [Ingress ](products/business-control-pannel/application/services/ingress.md)
Expand Down
35 changes: 17 additions & 18 deletions docs/guide/zh-CN/installation/installation-procedures.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# 安装步骤

## 1. 需求检查
## 一、需求检查

仔细检查每个节点的硬件和软件需求:[installation requirements](../../../../docs/guide/zh-CN/installation/installation-requirement.md)
仔细检查每个节点的硬件和软件需求:[部署环境要求](../../../../docs/guide/zh-CN/installation/installation-requirement.md)

## 2. Installer安装
## 二、Installer安装

为了简化平台安装过程,TKEStack基于 tke-installer 安装器提供了一个向导式的图形化安装指引界面。

Expand All @@ -20,7 +20,7 @@ arch=arm64 version=v1.3.1 && wget https://tke-release-1251707795.cos.ap-guangzho

> 您可以查看 TKEStack [Release](https://github.com/tkestack/tke/releases) 按需选择版本进行安装,建议您安装最新版本。
>
> tke-installer 约为 7GB,包含安装所需的所有资源。
> tke-installer 约为 8GB,包含安装所需的所有资源。


Expand All @@ -30,27 +30,26 @@ arch=arm64 version=v1.3.1 && wget https://tke-release-1251707795.cos.ap-guangzho


## 3. 控制台安装
## 三、控制台 和 Global 集群安装

> 注意:控制台是运行在global集群之上,控制台安装就是在安装global集群
> 注意:控制台是运行在global集群之上,控制台安装的同时在安装global集群
1. 填写 TKEStack 控制台基本配置信息

![img](../../../images/step-1.png)

- **用户名**:TKEStack 控制台管理员名称(**例如:admin**
- **密码**:TKEStack 控制台管理员密码
- **高可用设置**(按需使用,可直接选择【**不设置**】)
- **TKE提供**在所有 master 节点额外安装 Keepalived 完成 VIP 的配置与连接
- **使用已有**对接配置好的外部 LB 实例
- **不设置**访问第一台 master 节点 APIServer
- **用户名**:TKEStack 控制台管理员名称(**例如:admin**
- **密码**:TKEStack 控制台管理员密码
- **高可用设置**(按需使用,可直接选择【**不设置**】)
- **不设置**访问第一台 master 节点 APIServer
- **TKE提供**用户只需提供可用的IP地址,TKE部署Keepalive,配置该IP为Master集群的VIP,以实现Global集群和控制台的高可用,此时该VIP和所有master节点IP地址都是APIserver地址。
- **使用已有**对接配置好的外部 LB 实例,VIP绑定Master集群的80(tke控制台)、443(tke控制台)、6443(kube-apiserver端口)端口,同时确保该VIP有至少两个LB后端(Master节点),以避免LB单后端不可用风险。

2. 填写 TKEStack 控制台集群设置信息

![img](../../../images/step-2.png)

- **网卡名称**:集群节点使用的网卡,根据实际环境填写正确的网卡名称,默认为eth0(**建议使用默认值**

- **GPU 类型**:(按需使用,可直接选择【**不设置**】)
- **不使用**:不安装 Nvidia GPU 相关驱动
- **Virtual**:平台会自动为集群安装 [GPUManager](https://github.com/tkestack/docs/blob/master/features/gpumanager.md) 扩展组件
Expand All @@ -65,7 +64,7 @@ arch=arm64 version=v1.3.1 && wget https://tke-release-1251707795.cos.ap-guangzho
- **访问地址:** Master 节点**内网 IP**,请配置**至少 8 Cores & 16G内存** 及以上的机型,**否则会部署失败**
- **SSH 端口**:请确保目标机器安全组开放 SSH 端口和 ICMP 协议,否则无法远程登录和 PING 服务器(建议使用**22**
- **用户名和密码:** 均为添加的节点的用户名和密码
- 可以通过节点下面的【添加机器】蓝色字体增加master节点(**按需添加**
- 可以通过节点下面的**【添加机器】**蓝色字体增加master节点(**按需添加**

![img](../../../images/step-3-2.png)

Expand All @@ -83,7 +82,7 @@ arch=arm64 version=v1.3.1 && wget https://tke-release-1251707795.cos.ap-guangzho

![img](../../../images/step-4.png)

- **镜像仓库类型:**
- **镜像仓库类型(Installer里的所有镜像都会上传到该仓库)**
- **TKE提供**:使用 TKE 自带的镜像仓库
- **第三方仓库**:对接配置好的外部镜像仓库,此时,TKEStack 将不会再安装镜像仓库,而是使用您提供的镜像仓库作为默认镜像仓库服务

Expand Down Expand Up @@ -116,7 +115,7 @@ arch=arm64 version=v1.3.1 && wget https://tke-release-1251707795.cos.ap-guangzho

![img](../../../images/step-8.png)

9. 开始安装 TKEStack 控制台,**安装需要30min左右,请耐心等待**。安装成功后界面如下,最下面出现【查看指引】的按钮。
9. 开始安装 TKEStack 控制台,**安装需要60min左右,请耐心等待**。安装成功后界面如下,最下面出现【查看指引】的按钮。

![img](../../../images/step-9.png)

Expand All @@ -131,12 +130,12 @@ arch=arm64 version=v1.3.1 && wget https://tke-release-1251707795.cos.ap-guangzho

> 注意:这里域名的【IP】地址默认为**内网地址**,如果本地主机不在集群内网,域名的IP地址应该填该内网地址所对应的**外网地址**
## 4. 访问控制台
## 四、访问控制台

在本地主机的浏览器地址输入 https://console.tke.com ,可访问Global集群的控制台界面,输入控制台安装创建的用户名和密码后即可使用TKEStack。

# 安装常见问题

安装失败请首先检查硬件和软件需求:[installation requirements](../../../../docs/guide/zh-CN/installation/installation-requirement.md)
安装失败请首先检查硬件和软件需求:[部署环境要求](../../../../docs/guide/zh-CN/installation/installation-requirement.md)

可参考[FAQ installation](../FAQ/installation)获得更多帮助。
6 changes: 1 addition & 5 deletions docs/guide/zh-CN/installation/installation-requirement.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
> **特别注意**
>
> 1. 安装的时候,至少需要**一个Installer节点****一个作为Global集群的master节点****v1.3.0之后的版本可直接使用all-in-one的安装模式,此时installer节点也可以作为global集群的节点。**但注意:此时Installer的节点配置要以global集群的节点配置为准,否则Installer节点配置太低很容易安装失败。
> 2. **Installer节点**:是单独的用作安装的节点,不能作为Global集群的节点使用。**v1.3.0之后支持作为global集群的节点使用,但注意此时Installer节点配置已global集群的节点为准**因为在安装Global集群时,需要多次重启docker,此时如果Global集群里面有Installer节点,重启docker会中断Global集群的安装。该节点需要一台**系统盘100G**的机器,系统盘要保证剩余**50GB可用的空间**
> 2. **Installer节点**:是单独的用作安装的节点,不能作为Global集群的节点使用。因为在安装Global集群时,需要多次重启docker,此时如果Global集群里面有Installer节点,重启docker会中断Global集群的安装。该节点需要一台**系统盘100G**的机器,系统盘要保证剩余**50GB可用的空间****v1.3.0之后Installer节点支持作为global集群的节点使用,但注意此时Installer节点配置以global集群的节点为准**
> 3. **Global集群**:至少需要一台**8核16G内存,100G系统盘**的机器。
> 4. **业务集群**:业务集群是在部署完Global集群之后再添加的。
Expand Down Expand Up @@ -95,10 +95,6 @@
<td>>3</td>
</tr>
</table>




## 软件要求

> **注意,以下要求针对所有节点。**
Expand Down
Loading

0 comments on commit 6d16a50

Please sign in to comment.