更新 Ingress 文档

This commit is contained in:
Shao Huan Qing
2021-11-16 21:12:36 +08:00
parent ada96aba3c
commit 1191e79b1e
12 changed files with 55 additions and 212 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 437 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 121 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 173 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 462 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 159 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 222 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 167 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 234 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

View File

@ -20,192 +20,16 @@ meta:
## Ingress
Ingress 是 Kubernetes 的一种 API 对象,将集群内部的 Service 通过 HTTP/HTTPS 方式暴露到集群外部,并通过规则定义 HTTP/HTTPS 的路由。Ingress 具备如下特性:集群外部可访问的 URL、负载均衡、SSL Termination、按域名路由name-based virtual hosting
Ingress 是 Kubernetes 的一种 API 对象,将集群内部的 Service 通过 HTTP/HTTPS 方式暴露到集群外部,并通过规则定义 HTTP/HTTPS 的路由。Ingress 具备如下特性:集群外部可访问的 URL、负载均衡、SSL Termination、按域名路由name-based virtual hostingIngress 的例子如下所示:
Ingress Controller (通常需要负载均衡器配合)负责实现 Ingress API 对象所声明的能力。如下图所示:
1. Ingress Controller 监听所有 worker 节点上的 80/443 端口
2. Ingress Controller 将所有对域名为 a.kuboard.cn 的 HTTP/HTTPS 请求路由到 Service B 的 9080 端口
3. Service B 将请求进一步转发到其标签所选择的 Pod 容器组(通过 targetPort 指定容器组上的端口号)
该图中,**请求被转发的过程为:**
0. 假设您将 a.kuboard.cn 的 DNS 解析到了集群中的一个 worker 节点的 IP 地址 `192.168.2.69`。(如果您的 worker 节点有外网地址,请使用外网地址,这样您可以从外网访问您的服务)
1. 从客户端机器执行命令 `curl http://a.kuboard.cn/abc/`,该请求您将被转发到 `192.168.2.69` 这个地址的 80 端口,并被 Ingress Controller 接收
2. Ingress Controller 根据请求的域名 `a.kuboard.cn` 和路径 `abc` 匹配集群中所有的 Ingress 信息,并最终找到 `Ingress B` 中有这个配置,其对应的 Service 为 `Service B``9080` 端口
3. Ingress Controller 通过 kube-proxy 将请求转发到 `Service B` 对应的任意一个 Pod 上 与 `Service B``9080` 端口对应的容器端口上。(从 Ingress Controller 到 Pod 的负载均衡由 kube-proxy + Service 实现)
<p style="max-width: 720px;">
<img src="./ingress.assets/image-20190910222649193.png" alt="Kubernetes教程Ingress及其Controller"></img>
</p>
## Ingress Controller
如上所述,您必须在 Kubernetes 集群中安装了 Ingress Controller您配置的 Ingress 才能生效。
::: tip 划重点
Ingress 只是 Kubernetes 中的一种配置信息Ingress Controller 才是监听 80/443 端口,并根据 Ingress 上配置的路由信息执行 HTTP 路由转发的组件。
:::
Ingress Controller 有多种实现可供选择,请参考 Kubernetes 官方文档 [Additional controllers](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/#additional-controllers),比较常用的有 [Traefic](https://github.com/containous/traefik) 、 [Nginx Ingress Controller for Kubernetes](https://www.nginx.com/products/nginx/kubernetes-ingress-controller) 等。
如果您参考 https://kuboard.cn 网站上提供的文档安装了 Kubernetes您应该已经完成了 [Nginx Ingress Controller for Kubernetes](https://www.nginx.com/products/nginx/kubernetes-ingress-controller) 在您 Kubernetes 集群中的安装。该 Ingress Controller 以 DaemonSet 的类型部署到 Kubernetes且监听了 hostPort 80/443YAML 片段如下所示:
> 如果您打算使用其他 Ingress Controller您可以 [卸载 Nginx Ingress Controller](/install/install-k8s.html#安装-ingress-controller);如果您尚未安装任何 Ingress Controller请参考 [安装 Nginx Ingress Controller](/install/install-k8s.html#安装-ingress-controller),以便可以完成本教程的后续内容。
``` yaml {2,23,26}
apiVersion: extensions/v1beta1
kind: DaemonSet
metadata:
name: nginx-ingress
namespace: nginx-ingress
# ...
spec:
selector:
matchLabels:
app: nginx-ingress
template:
metadata:
labels:
app: nginx-ingress
spec:
serviceAccountName: nginx-ingress
containers:
- image: nginx/nginx-ingress:1.5.3
name: nginx-ingress
ports:
- name: http
containerPort: 80
hostPort: 80
- name: https
containerPort: 443
hostPort: 443
```
::: tip
* Ingress Controller 并非只能监听 80/443 端口,您可以根据自己网络拓扑的需要,选择合适的端口
* 根据您安装 Ingress Controller 的方式不同,您的 Ingress Controller 并不一定监听了所有 worker 节点的 80/443 端口(本教程不涉及此主题)
* 您也可以在 Kubernetes 集群中安装多种 Ingress Controller请参考 [Using multiple Ingress controllers](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/#using-multiple-ingress-controllers)
:::
## 融入到网络拓扑中
如前所述Kubernetes Ingress 只能监听到节点的 80/443 端口,且 Ingress 可以完成 L7 路由的功能。由于 Kubernetes Ingress 配置更便捷,推荐使用 Kubernetes Ingress 替代常规的互联网应用架构中的 Nginx 反向代理。那么,如何使部署在内网的 Kubernetes 集群上的 Ingress Controller 的 80/443 端口可以在外网访问到呢?
本教程推荐如下两种做法,结合您自己对安全性、可靠性等因素的考量,您可以演化出适合自己的拓扑结构。
### 暴露单worker节点
如下图所示,暴露单个 worker 节点的步骤如下:
* 为您 Kubernetes 集群中的某一个 worker 节点配置外网 IP 地址 Z.Z.Z.Z
* 将您在 Ingress 中使用到的域名(假设是`a.demo.kuboard.cn`)解析到该外网 IP 地址 Z.Z.Z.Z
* 设置合理的安全组规则(开放该外网 IP 地址 80/443 端口的入方向访问)
> 文档 [安装 Kubernetes 单Master节点](/install/install-k8s.html) 中使用的就是这种拓扑结构。这种方式下Ingress Controller 存在单点故障的可能性。
![Kubernetes教程单IngressController节点](/images/topology/k8s.png)
### 使用外部负载均衡器
如下图所示,使用外部负载均衡器的步骤如下:
* 创建一个集群外部的负载均衡器,该负载均衡器拥有一个外网 IP 地址 Z.Z.Z.Z并监听 80/443 端口的 TCP 协议
* 将负载均衡器在 80/443 端口上监听到的 TCP 请求转发到 Kubernetes 集群中所有或某些worker 节点的 80/443 端口可开启按源IP地址的会话保持
* 将您在 Ingress 中使用到的域名(假设是`a.demo.kuboard.cn`)解析到该负载均衡器的外网 IP 地址 Z.Z.Z.Z
> 文档 [安装 Kubernetes 高可用](/install/install-kubernetes.html) 中使用的就是这种拓扑结构。
![Kubernetes教程LoadBalancer](/images/topology/kubernetes.png)
## 实战:通过 Ingress 使您的应用程序在互联网可用
<SharingBlock>
::: warning 前提
* 假设您已经完成了 [公布应用程序](/learning/k8s-basics/expose.html) 中的实战部分
* 假设您已经将 Ingress 融入到您的网络拓扑中,并且将 `*.demo.kuboard.cn` (请使用您自己的域名)解析到对应的外网 IP 地址
:::
<b-card>
<b-tabs content-class="mt-3">
<b-tab title="使用kubectl">
**创建文件 nginx-deployment.yaml**
``` sh
vim nginx-deployment.yaml
```
**文件内容如下**
``` yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: nginx-deployment
labels:
app: nginx
spec:
replicas: 1
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: nginx:1.7.9
```
**创建文件 nginx-service.yaml**
``` sh
vim nginx-service.yaml
```
**文件内容如下**
``` yaml
apiVersion: v1
kind: Service
metadata:
name: nginx-service
labels:
app: nginx
spec:
selector:
app: nginx
ports:
- name: nginx-port
protocol: TCP
port: 80
nodePort: 32600
targetPort: 80
type: NodePort
```
**创建文件 nginx-ingress.yaml**
``` sh
vim nginx-ingress.yaml
```
**文件内容如下**
``` yaml
apiVersion: networking.k8s.io/v1beta1
```yaml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: my-ingress-for-nginx # Ingress 的名字,仅用于标识
spec:
rules: # Ingress 中定义 L7 路由规则
- host: a.demo.kuboard.cn # 根据 virtual hostname 进行路由(请使用您自己的域名)
- host: demo.my-company.com # 根据 virtual hostname 进行路由(请使用您自己的域名)
http:
paths: # 按路径进行路由
- path: /
@ -214,36 +38,53 @@ spec:
servicePort: 80
```
Ingress Controller 通常是部署在集群中的一个 Deployment并且通过 NodePort Service 暴露自己的端口,使得用户可以在集群外通过其 NodePort 访问到 Ingress Controller假设该端口为 `32351`,并且 `demo.my-company.com` 这个域名被解析到集群中某一个节点的 IP或者被配置到浏览器所在机器的 hosts 文件),则当用户在浏览器中输入地址 `http://demo.my-company.com:32351` 时:
**执行命令**
1. 请求被转发到集群某节点的 `32351` 节点端口;
2. 根据 Service 的定义,请求被转发到 Ingress Controller 的 Web 端口;
3. Ingress Controller 根据请求域名 `demo.my-company.com` 以及请求路径,匹配到 Ingress 定义中该请求应该被路由到 `nginx-service``80` 端口;
4. Ingress Controller 执行 L7 路由转发,将请求发送到 `nginx-service``80` 端口。
``` sh
kubectl apply -f nginx-deployment.yaml
kubectl apply -f nginx-service.yaml
kubectl apply -f nginx-ingress.yaml
```
## 安装 Ingress Controller
**检查执行结果**
Kuboard 为您提供了一种快速安装 `ingress-nginx` 的方法,步骤如下所示:
``` sh
kubectl get ingress -o wide
```
> * Kubernetes 集群版本不低于 v1.19
> * Kuboard 版本不低于 v3.3.0.0
可查看到名称为 my-ingress-for-nginx 的 Ingress。
* 导航到集群的 `集群管理` --> `网络` --> `IngressClass` 列表页,如下图所示:
![IngressClass 列表](./ingress.assets/ingress-class-list.png)
**从互联网访问**
* 点击图中的 `安装 IngressNginxController 并创建 IngressClass` 的按钮,如下图所示:
> 假设名称为 `my-ingress-controller`
![IngressClass 创建](./ingress.assets/ingress-class-create.png)
* 完成 Ingress Controller 的创建后,将进入如下界面:
::: tip 负载均衡
1. 通常,您需要在集群外配置一个负载均衡器,并将负载均衡器接收到的所有请求转发到 Ingress Controller 对应的节点端口;
2. 为了快速验证,在不配置负载均衡器的情况下,可以将业务域名直接解析到集群的某一个节点,并在访问时,在域名后面增加节点端口;
:::
![IngressController 已创建](./ingress.assets/ingress-class-created.png)
## 实战:使用 Ingress 访问 Web 应用
<SharingBlock>
::: warning 前提
* 假设您已经完成了 [公布应用程序](/learning/k8s-basics/expose.html) 中的实战部分
* 假设您已经将 `demo.my-company.com` 解析到集群的某一个节点 IP (或者已配置到 hosts 文件中)
:::
``` sh
# 请使用您自己的域名
curl a.demo.kuboard.cn
```
</b-tab>
<b-tab title="使用Kuboard" active>
* 在 default 名称空间 点击左侧菜单栏中的 ***创建工作负载***,如下图所示:
![Kubernetes教程创建工作负载并配置Ingress](./ingress.assets/image-20210404192614291.png)
![Kubernetes教程创建工作负载并配置Ingress](./ingress.assets/use-ingress-01.png)
填写表单如下:
@ -255,9 +96,9 @@ curl a.demo.kuboard.cn
| 服务描述 | nginx部署 | |
| 副本数量 | 1 | 可以填写其他正整数 |
* 切换到 ***容器信息*** Tab 页,如下图所示:
* 切换到 ***容器信息*** Tab 页,并点击 `添加工作容器` 按钮,如下图所示:
![Kubernetes教程创建工作负载并配置Ingress](./ingress.assets/image-20210404193105147.png)
![Kubernetes教程创建工作负载并配置Ingress](./ingress.assets/use-ingress-02.png)
填写表单如下:
@ -269,32 +110,34 @@ curl a.demo.kuboard.cn
* 切换到 ***服务/应用路由*** Tab 页,如下图所示:
![Kubernetes教程创建工作负载并配置Ingress](./ingress.assets/image-20210404193435776.png)
![Kubernetes教程创建工作负载并配置Ingress](./ingress.assets/use-ingress-03.png)
填写表单如下:
| 字段名称 | 填写内容 | 备注 |
| -------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| 服务 | NodePortVPC内访问<br />协议: TCPport: 80nodePort: 32601targetPort: 80 | 服务对应 Kubernetes Service对象<br />工作负载编辑器为其使用与 Deployment 相同的名字 web-nginx |
| 应用路由 | 域名: a.demo.kuboard.cn<br />映射URL /<br />服务端口80 | 应用路由对应 Kubernetes Ingress对象<br />工作负载编辑器为其使用与 Deployment 相同的名字 web-nginx |
| 服务 | NodePortVPC内访问<br />协议: TCP<br />port: 80<br />targetPort: 80 | 服务对应 Kubernetes Service对象<br />工作负载编辑器为其使用与 Deployment 相同的名字 web-nginx |
| 应用路由 | IngressClassmy-ingress-controller <br/>域名: demo.my-company.com<br />映射URL /<br />服务端口80 | 应用路由对应 Kubernetes Ingress对象<br />工作负载编辑器为其使用与 Deployment 相同的名字 web-nginx |
::: tip
Kuboard 工作负载编辑器假设 kubernetes 中三个主要对象 Deployment/Service/Ingress 名称相同,并放在同一个编辑器界面中处理。
:::
::: tip
Kuboard 工作负载编辑器假设 kubernetes 中三个主要对象 Deployment/Service/Ingress 名称相同,并放在同一个编辑器界面中处理。
:::
* 点击 **保存**
* 点击 **应用**
* **从互联网访问**
* **从浏览器访问**
在浏览器打开 `http://a.demo.kuboard.cn` (请使用您自己的域名)
在浏览器打开 `http://demo.my-company.com:32351`,如下图所示:
</b-tab>
</b-tabs>
</b-card>
::: tip 节点端口
根据您安装 IngressController 的结果,您应该使用的端口号极有可能不是 `32351`,请使用您的在 [安装 Ingress Controller](./ingress.html#安装-ingress-controller) 这个步骤中获得的 IngressController 的节点端口。
:::
![KUbernetes教程访问Ingress](./ingress.assets/use-ingress-04.png)
</SharingBlock>