Alibaba Cloud Provider
Alibaba Cloud Provider简介
CloudProvider 提供kubernetes与云厂商基础服务的对接能力,由 cloud-controller-manager组件实现。
通过这个组件,可以让用户在创建k8s LoadBalancer 类型的service的时候自动的为用户创建一个阿里云SLB,同时动态的绑定与解绑SLB后端,并且提供了丰富的配置允许用户自定义生成的LoadBalancer.
基本使用方式 cloudprovider通过service上的annotation来控制创建Type: LoadBalancer类型的service时的行为。一个基本的annotation示例如下:
apiVersion: v1
kind: Service
metadata:
annotations:
# 这里填写相应的annotation, 用例
service.beta.kubernetes.io/alicloud-loadbalancer-id: lb-bp1hfycf39bbeb019pg7m
name: nginx
namespace: default
spec:
ports:
- name: web
port: 443
protocol: TCP
targetPort: 443
type: LoadBalancer
>> 注意事项:
- 如果您的集群的cloud-controller-manager版本大于等于v1.9.3,对于指定已有SLB的时候,系统默认不再为该SLB处理监听,用户需要手动配置该SLB的监听规则。
执行以下命令,可查看cloud-controller-manager的版本。
root@master # kubectl get po -n kube-system -o yaml|grep image:|grep cloud-con|uniq
image: registry-vpc.cn-....-controller-manager-amd64:v1.9.3
- 当您的集群cloudprovider不是最新版的时候,可能无法使用某些功能。参考如何手动升级CloudProvider。
创建LoadBalancer的正确姿势
前置条件。
>> 注意
- 保存以下yaml为svc.1.yaml , 然后使用 kubectl apply -f svc.1.yaml的方式来创建service.
1. 创建一个公网类型的负载均衡
apiVersion: v1
kind: Service
metadata:
name: nginx
namespace: default
spec:
ports:
- port: 80
protocol: TCP
targetPort: 80
selector:
run: nginx
type: LoadBalancer
2. 创建一个私网类型的负载均衡
apiVersion: v1
kind: Service
metadata:
annotations:
service.beta.kubernetes.io/alicloud-loadbalancer-address-type: "intranet"
name: nginx
namespace: default
spec:
ports:
- port: 80
protocol: TCP
targetPort: 80
selector:
run: nginx
type: LoadBalancer
3. 创建HTTP类型的负载均衡
apiVersion: v1
kind: Service
metadata:
annotations:
service.beta.kubernetes.io/alicloud-loadbalancer-protocol-port: "http:80"
name: nginx
namespace: default
spec:
ports:
- port: 80
protocol: TCP
targetPort: 80
selector:
run: nginx
type: LoadBalancer
4. 创建HTTPS类型的负载均衡
apiVersion: v1
kind: Service
metadata:
annotations:
service.beta.kubernetes.io/alicloud-loadbalancer-protocol-port: "https:443"
service.beta.kubernetes.io/alicloud-loadbalancer-cert-id: ${YOUR_CERT_ID}
name: nginx
namespace: default
spec:
ports:
- port: 443
protocol: TCP
targetPort: 443
selector:
run: nginx
type: LoadBalancer
>> 说明:
- 创建https类型的负载均衡需要您提供一个证书ID,如果还没有证书,请前往SLB控制台创建一个。
5. 限制负载均衡的带宽。
apiVersion: v1
kind: Service
metadata:
annotations:
service.beta.kubernetes.io/alicloud-loadbalancer-bandwidth: "100"
name: nginx
namespace: default
spec:
ports:
- port: 443
protocol: TCP
targetPort: 443
selector:
run: nginx
type: LoadBalancer
>> 说明:
- 只限制负载均衡的带宽。所有listener 共享该负载均衡的带宽。参考共享实例带宽
6. 指定负载均衡规格
apiVersion: v1
kind: Service
metadata:
annotations:
service.beta.kubernetes.io/alicloud-loadbalancer-spec: "slb.s1.small"
name: nginx
namespace: default
spec:
ports:
- port: 443
protocol: TCP
targetPort: 443
selector:
run: nginx
type: LoadBalancer
7. 绑定已有的负载均衡到Service
apiVersion: v1
kind: Service
metadata:
annotations:
service.beta.kubernetes.io/alicloud-loadbalancer-id: "${YOUR_LOADBALANCER_ID}"
name: nginx
namespace: default
spec:
ports:
- port: 443
protocol: TCP
targetPort: 443
selector:
run: nginx
type: LoadBalancer
>> 说明:
- 默认情况下,绑定已有SLB的时候CloudProvider只会为您的绑定和解绑SLB后端Server,不会处理监听。您需要指定service.beta.kubernetes.io/alicloud-loadbalancer-force-override-listeners: "true"来强制覆盖监听。注意这会删除您已有SLB上的非预期的监听。
8. 绑定已有负载均衡,并强制覆盖已有监听
apiVersion: v1
kind: Service
metadata:
annotations:
service.beta.kubernetes.io/alicloud-loadbalancer-id: "${YOUR_LOADBALANCER_ID}"
service.beta.kubernetes.io/alicloud-loadbalancer-force-override-listeners: "true"
name: nginx
namespace: default
spec:
ports:
- port: 443
protocol: TCP
targetPort: 443
selector:
run: nginx
type: LoadBalancer
9. 让SLB挂载具有指定label的worker节点作为后端server
apiVersion: v1
kind: Service
metadata:
annotations:
service.beta.kubernetes.io/alicloud-loadbalancer-backend-label: "failure-domain.beta.kubernetes.io/zone:ap-southeast-5a"
name: nginx
namespace: default
spec:
ports:
- port: 443
protocol: TCP
targetPort: 443
selector:
run: nginx
type: LoadBalancer
>> 注意
- 多个label以逗号分隔。 "k1:v1,k2:v2"
- 多个label之间是and的语义。
10. 为TCP类型的SLB配置会话保持SessionSticky
apiVersion: v1
kind: Service
metadata:
annotations:
service.beta.kubernetes.io/alicloud-loadbalancer-persistence-timeout: "1800"
name: nginx
namespace: default
spec:
ports:
- port: 443
protocol: TCP
targetPort: 443
selector:
run: nginx
type: LoadBalancer
>> 注意
- 该参数仅对TCP监听起作用。
- 如果service配置了多个TCP的监听端口,该会话保持默认应用到所有TCP监听端口
11. 为HTTP&HTTPS类型的SLB配置会话保持SessionSticky(insert cookie)
apiVersion: v1
kind: Service
metadata:
annotations:
service.beta.kubernetes.io/alicloud-loadbalancer-sticky-session: "on"
service.beta.kubernetes.io/alicloud-loadbalancer-sticky-session-type: "insert"
service.beta.kubernetes.io/alicloud-loadbalancer-cookie-timeout: "1800"
service.beta.kubernetes.io/alicloud-loadbalancer-protocol-port: "http:80"
name: nginx
namespace: default
spec:
ports:
- port: 80
protocol: TCP
targetPort: 80
selector:
run: nginx
type: LoadBalancer
>> 注意
- 仅HTTP & HTTPS。
- 会话保持类型为insert,植入Cookie.
- 如果service配置了多个HTTP或者HTTPS的监听端口,该会话保持默认应用到所有HTTP&HTTPS监听端口
12. 为HTTP&HTTPS类型的SLB配置会话保持SessionSticky(server cookie)
apiVersion: v1
kind: Service
metadata:
annotations:
service.beta.kubernetes.io/alicloud-loadbalancer-sticky-session: "on"
service.beta.kubernetes.io/alicloud-loadbalancer-sticky-session-type: "server"
service.beta.kubernetes.io/alicloud-loadbalancer-cookie: "${YOUR_COOKIE}"
service.beta.kubernetes.io/alicloud-loadbalancer-protocol-port: "http:80"
name: nginx
namespace: default
spec:
ports:
- port: 80
protocol: TCP
targetPort: 80
selector:
run: nginx
type: LoadBalancer
>> 注意
- 仅HTTP & HTTPS。
- 会话保持类型为server, 重写Cookie.
- 如果service配置了多个HTTP或者HTTPS的监听端口,该会话保持默认应用到所有HTTP&HTTPS监听端口
13. 创建的SLB时,指定其主备可用区
apiVersion: v1
kind: Service
metadata:
annotations:
service.beta.kubernetes.io/alicloud-loadbalancer-master-zoneid: "ap-southeast-5a"
service.beta.kubernetes.io/alicloud-loadbalancer-slave-zoneid: "ap-southeast-5a"
name: nginx
namespace: default
spec:
ports:
- port: 80
protocol: TCP
targetPort: 80
selector:
run: nginx
type: LoadBalancer
>> 注意
- 某些region的SLB不支持主备可用区,如ap-southeast-5
- 一旦创建,不支持修改主备可用区。
13. 指定SLB仅挂载Pod所在节点作为后端Server
apiVersion: v1
kind: Service
metadata:
name: nginx
namespace: default
spec:
externalTrafficPolicy: Local
ports:
- port: 80
protocol: TCP
targetPort: 80
selector:
run: nginx
type: LoadBalancer
>> 注意
- 某些region的SLB不支持主备可用区,如ap-southeast-5
- 一旦创建,不支持修改主备可用区。
附件:可用的Annotation参数及其说明
>> 注意
- 所有的annotation均为字符类型,使用双引号括起来。
可用注释(annotation) | 描述 | 默认值 |
---|---|---|
service.beta.kubernetes.io/alicloud-loadbalancer-protocol-port | 多个值之间由逗号分隔, 比如:https:443,http:80 |
无 |
service.beta.kubernetes.io/alicloud-loadbalancer-address-type | 创建公网类型或者私网类型的SLB, 取值可以是 internet 或者 intranet |
"internet" |
service.beta.kubernetes.io/alicloud-loadbalancer-slb-network-type | 负载均衡的网络类型, 取值可以是 classic 或者 vpc |
"classic" |
service.beta.kubernetes.io/alicloud-loadbalancer-charge-type | 取值可以是 paybytraffic 或者 paybybandwidth | "paybytraffic" |
service.beta.kubernetes.io/alicloud-loadbalancer-id | 指定已有负载均衡实例的 ID。 删除 service 时该 SLB 不会被删除。 |
无 |
service.beta.kubernetes.io/alicloud-loadbalancer-backend-label | 通过 label 指定 SLB 后端挂哪些节点。 | 无 |
service.beta.kubernetes.io/alicloud-loadbalancer-spec | SLB的规格。 slb.s1.small , slb.s2.small...... 参考API |
无 |
service.beta.kubernetes.io/alicloud-loadbalancer-sticky-session | 是否开启会话保持。 (仅对HTTP和HTTPS类型监听) 取值:on / off参考API |
"off" |
service.beta.kubernetes.io/alicloud-loadbalancer-sticky-session-type | cookie的处理方式。 取值: insert:植入Cookie。 server:重写Cookie。 (当StickySession的值为on时,必须指定该参数)(仅对HTTP和HTTPS类型监听)参考API |
无 |
service.beta.kubernetes.io/alicloud-loadbalancer-cookie-timeout | Cookie超时时间。 取值: 1-86400(秒) 当StickySession为on且StickySessionType为insert时,该参数必选。参考API |
无 |
service.beta.kubernetes.io/alicloud-loadbalancer-cookie | 服务器上配置的Cookie。 长度为1-200个字符,只能包含ASCII英文字母和数字字符, 不能包含逗号、分号或空格,也不能以$开头。 当StickySession为on且StickySessionType为server时,该参数必选。参考API |
无 |
service.beta.kubernetes.io/alicloud-loadbalancer-persistence-timeout | 会话保持时间。 (仅对TCP监听)取值:0-3600(秒) 默认值为0,关闭会话保持。参考API |
"0" |
service.beta.kubernetes.io/alicloud-loadbalancer-force-override-listeners | 当指定已有SLB的时候,是否强制覆盖该SLB的listener. 默认不覆盖 |
"false" |
service.beta.kubernetes.io/alicloud-loadbalancer-region | 负载均衡所在的地域 | 无 |
service.beta.kubernetes.io/alicloud-loadbalancer-bandwidth | 负载均衡的带宽 | “50” |
service.beta.kubernetes.io/alicloud-loadbalancer-cert-id | 阿里云上的认证 ID。您需要先上传证书 | “” |
service.beta.kubernetes.io/alicloud-loadbalancer-health-check-flag | 取值是 on 或者 off 1.默认为 off。 2.TCP 协议默认on, 且不可修改 |
off |
service.beta.kubernetes.io/alicloud-loadbalancer-health-check-type | 参见 HealthChecktcp / http | tcp |
service.beta.kubernetes.io/alicloud-loadbalancer-health-check-uri | 参见 HealthCheck | |
service.beta.kubernetes.io/alicloud-loadbalancer-health-check-connect-port | 参见 HealthCheck | |
service.beta.kubernetes.io/alicloud-loadbalancer-healthy-threshold | 参见 HealthCheck | |
service.beta.kubernetes.io/alicloud-loadbalancer-unhealthy-threshold | 参见 HealthCheck | |
service.beta.kubernetes.io/alicloud-loadbalancer-health-check-interval | 参见 HealthCheck | |
service.beta.kubernetes.io/alicloud-loadbalancer-health-check-connect-timeout | 参见 HealthCheck | |
service.beta.kubernetes.io/alicloud-loadbalancer-health-check-timeout | 参见 HealthCheck |