技术分享 | kubernetes operator 简介

爱可生开源社区 · · 763 次点击 · · 开始浏览    
这是一个创建于 的文章,其中的信息可能已经有所发展或是发生改变。

作者:沈亚军

爱可生研发团队成员,负责公司 DMP 产品的后端开发,爱好太广,三天三夜都说不完,低调低调...

本文来源:原创投稿

*爱可生开源社区出品,原创内容未经授权不得随意使用,转载请联系小编并注明来源。


k8s operator 介绍

k8s Operator 是一种用于特定应用的控制器,可扩展 Kubernetes API 的功能,来代表 k8s 用户创建、配置和管理复杂应用的实例,它基于基本 k8s 资源和控制器概念构建,但又涵盖了特定领域或应用的知识,用于实现其所管理的应用生命周期的自动化,常见的有 etcd-operator、prometheus-operator 等,以下是 k8s operator 执行的一些最常见功能的列表:

  • 部署指定配置和数量的应用
  • 对应用进行扩缩容
  • 启动升级、自动备份和故障恢复
  • 执行任何其他可以作为代码呈现的管理应用的任务

operator 工作原理

k8s operator 是使用自定义资源(CR)管理应用及其组件的自定义 k8s 控制器,自定义资源是 k8s 中的 API 扩展机制。自定义资源定义(CRD)会声明 CR 并列出 Operator 用户可用的所有配置

当 operator 被部署到 k8s 集群中会通过连接 master 节点的 API server 监听特定资源类型的事件并基于用户在 CR 中提供的配置和嵌入在 operator 处理逻辑采取对应的操作,进行循环处理确保当前该资源的状态与理想状态相符

image

编写一个简单的 operator

operator SDK 是 CoreOS 公司开发和维护的用于快速创建 operator 的工具,可以ß助我们快速构建 operator 应用,类似的工具还有:

  • KUDO (Kubernetes 通用声明式 Operator)
  • kubebuilder,kubernetes SIG 在维护的一个项目
  • Metacontroller,可与 Webhook 结合使用,以实现自己的功能

接下来会使用 operator-sdk 构建一个简单的 operator 项目

开发环境:

<pre class="custom" data-tool="mdnice编辑器" style="margin-top: 10px; margin-bottom: 10px; border-radius: 5px; box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;">docker 20.10.5 operator-sdk 1.9.0 golang 1.16.3 kubernetes 1.19 macOS 11.4 </pre>

1.使用 operator-sdk CLI 创建 nginx-operator 项目

<pre class="custom" data-tool="mdnice编辑器" style="margin-top: 10px; margin-bottom: 10px; border-radius: 5px; box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;">mkdir -p $HOME/nginx-operator && cd $HOME/nginx-operator operator-sdk init --domain example.com --repo github.com/example/nginx-operator </pre>

2.创建新的 CRD API 指定组为 proxy 类型为 Nginx 版本为 v1alpha1

<pre class="custom" data-tool="mdnice编辑器" style="margin-top: 10px; margin-bottom: 10px; border-radius: 5px; box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;">operator-sdk create api --group proxy --version v1alpha1 --kind Nginx --resource --controller </pre>

该命令生成的 api/v1alpha1/nginx_types.gocontrollers/nginx_controller.go 文件是需要我们分别实现 CR 的配置和控制器的处理逻辑

3.定义 Nginx 资源类型 CR 并生成 CRD

修改文件 api/v1alpha1/nginx_types.go 中的 NginxSpecNginxStatus 如下

<pre class="custom" data-tool="mdnice编辑器" style="margin-top: 10px; margin-bottom: 10px; border-radius: 5px; box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;">// NginxSpec defines the desired state of Nginx type NginxSpec struct { Count int32json:"count"`
}

// NginxStatus defines the observed state of Nginx
type NginxStatus struct {
// Nodes are the names of the nginx pods
Nodes []string json:"nodes"
}` </pre>

执行下面的命令生成 CR 资源相关代码,每次修改 CR 的定义都需执行该命令

<pre class="custom" data-tool="mdnice编辑器" style="margin-top: 10px; margin-bottom: 10px; border-radius: 5px; box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;">make generate </pre>

执行下面的命令会生成 CRD 定义文件 nginx-operator/config/crd/bases/proxy.example.com_nginxes.yaml

<pre class="custom" data-tool="mdnice编辑器" style="margin-top: 10px; margin-bottom: 10px; border-radius: 5px; box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;">make manifests </pre>

4.控制器处理逻辑实现

需要在 controllers/nginx_controller.go 实现以下逻辑,可参考 nginx_controller.go

实现 SetupWithManager 方法设置要监听的资源对象,如下代码中指定了主要监听对象为 Nginx,次要监听对象为 Deployment:

<pre class="custom" data-tool="mdnice编辑器" style="margin-top: 10px; margin-bottom: 10px; border-radius: 5px; box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;">func (r *NginxReconciler) SetupWithManager(mgr ctrl.Manager) error { return ctrl.NewControllerManagedBy(mgr). For(&proxyv1alpha1.Nginx{}). Owns(&appsv1.Deployment{}). Complete(r) } </pre>

Reconcile 方法中用来维护前 k8s 环境中监听的对象使其达到预期的状态,每当被监听的资源对象触发新的事件该方法会被调用

<pre class="custom" data-tool="mdnice编辑器" style="margin-top: 10px; margin-bottom: 10px; border-radius: 5px; box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;">`func (r *NginxReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
log := ctrllog.FromContext(ctx)

return ctrl.Result{}, nil

}` </pre>

5.部署 operator

1.编译并部署 operator 镜像 修改 Makefile

<pre class="custom" data-tool="mdnice编辑器" style="margin-top: 10px; margin-bottom: 10px; border-radius: 5px; box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;">-IMG ?= controller:latest +IMG ?= $(IMAGE_TAG_BASE):$(VERSION) </pre>

编译并部署 operator 到 k8s 集群

<pre class="custom" data-tool="mdnice编辑器" style="margin-top: 10px; margin-bottom: 10px; border-radius: 5px; box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;">make docker-build make deploy </pre>

2.查看 deployment

<pre class="custom" data-tool="mdnice编辑器" style="margin-top: 10px; margin-bottom: 10px; border-radius: 5px; box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;">$ kubectl get deployment -n nginx-operator-system NAME READY UP-TO-DATE AVAILABLE AGE nginx-operator-controller-manager 1/1 1 1 5m14s </pre>

3.创建 Nginx CR 修改文件 config/samples/proxy_v1alpha1_nginx.yaml 如下:

<pre class="custom" data-tool="mdnice编辑器" style="margin-top: 10px; margin-bottom: 10px; border-radius: 5px; box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;">apiVersion: proxy.example.com/v1alpha1 kind: Nginx metadata: name: nginx-sample spec: count: 3 </pre>

执行命令 kubectl apply -f config/samples/proxy_v1alpha1_nginx.yaml 创建 CR

获取创建的 pod

<pre class="custom" data-tool="mdnice编辑器" style="margin-top: 10px; margin-bottom: 10px; border-radius: 5px; box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;">$ kubectl get pods NAME READY STATUS RESTARTS AGE nginx-sample-66b6c48dd5-bcqc8 1/1 Running 0 15m nginx-sample-66b6c48dd5-thnx6 1/1 Running 0 15m nginx-sample-66b6c48dd5-xrd9l 1/1 Running 0 15m </pre>

4.检查 CR 的状态

<pre class="custom" data-tool="mdnice编辑器" style="margin-top: 10px; margin-bottom: 10px; border-radius: 5px; box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;">`$ kubectl get nginx/nginx-sample -o yaml
apiVersion: proxy.example.com/v1alpha1
kind: Nginx
metadata:
name: nginx-sample
namespace: default
...
spec:
count: 3
status:
nodes:

  • nginx-sample-66b6c48dd5-bcqc8
  • nginx-sample-66b6c48dd5-thnx6
  • nginx-sample-66b6c48dd5-xrd9l` </pre>

若需要清理执行以下命令

<pre class="custom" data-tool="mdnice编辑器" style="margin-top: 10px; margin-bottom: 10px; border-radius: 5px; box-shadow: rgba(0, 0, 0, 0.55) 0px 2px 10px;">kubectl delete -f config/samples/proxy_v1alpha1_nginx.yaml make undeploy </pre>


有疑问加站长微信联系(非本文作者)

本文来自:简书

感谢作者:爱可生开源社区

查看原文:技术分享 | kubernetes operator 简介

入群交流(和以上内容无关):加入Go大咖交流群,或添加微信:liuxiaoyan-s 备注:入群;或加QQ群:701969077

763 次点击  
加入收藏 微博
暂无回复
添加一条新回复 (您需要 登录 后才能回复 没有账号 ?)
  • 请尽量让自己的回复能够对别人有帮助
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
  • 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet
  • 图片支持拖拽、截图粘贴等方式上传