python-operator 介绍以及使用文档

python-operator 介绍以及使用文档

operator简介:

Operator用于扩展Kubernetes API,特定的应用进程控制器,它用来创建、配置和管理复杂的有状态应用,如数据库、缓存和监控系统。Operator基于 Kubernetes 的资源和控制器概念之上构建,但同时又包含了应用进程特定的领域知识。创建Operator 的关键是CRD(自定义资源)的设计。Kubernetes 1.7 版本以来就引入了自定义控制器的概念,该功能可以让开发人员扩展添加新功能,更新现有的功能,并且可以自动执行一些管理任务,这些自定义的控制器就像 Kubernetes 原生的组件一样。

开发operator的两个必要条件

1.自研控制器(也就是这个项目中的python-operator程序,使用kopf模块开发)

2.crd 以及rbac权限文件(由运维人员提供李雷or张安宁,开发operator控制器人员不需要管理)

kopf开发过程以及模块使用文档

1.安装python3环境,安装pip3工具,搭建本地python环境

参考python官网https://www.python.org/
建议使用python 3.7.x版本

2.安装kopf kubernetes 等模块

sudo pip3 install kopf
sudo pip3 install kubernetes

3.kopf模块中装饰器的使用

1.创建编排的装饰器

@kopf.on.create("demo.crd.autohome.com","v1","TestDemo")
def create_fn(body,spec,**kwargs):
@kopf.on.create 装饰器为固定写法,demo.crd.autohome.com 为扩展api的路径,v1是版本号,TestDemo为自定义的CRD名字
def create_fn 为这个装饰器下的方法,固定名字body spec **kwargs 为可以使用的参数,除此之外还有name namespace 等,从body kwargs 可以获取整个crd yaml参数,spec获取spec一下内容

2.删除编排的装饰器

@kopf.on.delete("demo.crd.autohome.com","v1","TestDemo")
def delete(body, **kwargs):
@kopf.on.delete 删除装饰器,以及装饰器下面的固定方法名def delete(body, **kwargs):

3.监听装饰器

@kopf.timer("demo.crd.autohome.com", "v1", "TestDemo", interval=5, initial_delay=10 )
def monitor_key(body,spec, **kwargs):
@kopf.timer 为监听装饰器固定写法,固定方法def monitor_key,interval 为间隔多长时间执行一次监听方法,initial_delay为服务启动后延迟多少,开始执行监听方法

4.更新编排装饰器

@kopf.on.update("demo.crd.autohome.com","v1","TestDemo")
def update_fn(body, **kwargs):
@kopf.on.update 为监听装饰器固定写法,固定方法def update_fn

5.更多的kopf使用方式可以参看官网https://kopf.readthedocs.io/en/stable/

4.kubernetes模块介绍以及使用

kubernetes模块是谷歌官方提供的python版本的sdk,方便使用python来调用k8s api接口,集成了所有k8s编排的创建,更新,删除工作,有一定的学习成本,同时对k8s需要有一定的了解,以下是部分代码的说明

api_core = kubernetes.client.CoreV1Api() 获取CoreV1Api对象,可以操作CoreV1Api编排下(例如service)的各种方法

api_apps = kubernetes.client.AppsV1Api() 获取CoreV1Api对象,可以操作CoreV1Api编排下(例如deployment statefulset)的各种方法

kubernetes模块下的各种对象以及方法参照谷歌官方https://github.com/kubernetes-client/python

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,744评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,505评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,105评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,242评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,269评论 6 389
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,215评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,096评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,939评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,354评论 1 311
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,573评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,745评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,448评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,048评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,683评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,838评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,776评论 2 369
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,652评论 2 354

推荐阅读更多精彩内容