专栏首页腾讯云TStack专栏介绍一个不太小的工具:Shell Operator

介绍一个不太小的工具:Shell Operator

点击上方“腾讯云TStack”关注我们

获取最in云端资讯和海量技术干货

本文作者 / 龙哥

开源软件、自动化爱好者。

资深马拉松酱油选手。

Shell Operator 是个冷僻又有点用的东西。这个工具的角度比较刁钻——使用的特定事件来触发 Shell 脚本。

这个工具的使用方式也很有趣,要定义某个任务:

  • 编写任务脚本
  • 使用它的基础镜像,加入任务脚本,打包生成一个 Docker 镜像并推送
  • 把镜像部署到集群之中
  • 对应事件出现时,将执行该任务脚本。

一、触发方法

Shell Operator 支持多种事件触发,包括 Kubernetes、启动时执行以及定期执行。

定期执行方式可以使用类似 Crontab 的语法,定义特定时间内执行指定脚本。

启动时执行只会执行一次。

Kubernetes 事件触发条件和 Admission Webhook 类似,但是更加细致,支持多种对象的 AddedModifiedDeleted 操作。可以根据名称、标签、特定字段、命名空间进行过滤,还可以使用 jq 语法进行进一步的过滤。

二、写个脚本

项目 README.md 就提供了一个简单的例子,大致体现了 Shell Operator 的功能和用法。

首先生成一个脚本文件,并设置权限为可执行:

#!/usr/bin/env bashif [[ $1 == "--config" ]] ; then
  cat <<EOF
configVersion: v1
kubernetes:
- apiVersion: v1
  kind: Pod
  executeHookOnEvent: ["Added"]
EOFelse
  podName=$(jq -r .[0].object.metadata.name $BINDING_CONTEXT_PATH)  echo "Pod '${podName}' added"fi

这个小脚本体现了 Hook 的基本用法,如果使用 --config 参数启动,则会输出一个 YAML 格式的配置文件,其中表明该脚本会在 Kubernetes 中加入新的 Pod 时候触发。

configVersion: v1
kubernetes:
- apiVersion: v1
  kind: Pod
  executeHookOnEvent: ["Added"]

在无参数启动时,则会运行这个 Hook 的主逻辑,在 Hook 被触发时,会把触发时的上下文内容以 JSON 的形式保存到一个文件,文件名会保存到 $BINDING_CONTEXT_PATH。这里会用 jq 从文件的 JSON 中获取 Pod 名称,并展示出来。

三、构建镜像并运行

项目提供了一个基础镜像 flant/shell-operator:latest,其中内置了 bashkubectljq 以及 shell-operator 的可执行文件。把脚本加入镜像:

FROM flant/shell-operator:latest
ADD pods-hook.sh /hooks

构建镜像并推送到镜像库之后,为了让任务正常运行,要给它创建命名空间以及具备合适权限的 ServiceAccount

$ kubectl create namespace example-monitor-pods
...
$ kubectl create serviceaccount monitor-pods-acc \
    --namespace example-monitor-pods
...
$ kubectl create clusterrole monitor-pods \
    --verb=get,watch,list --resource=pods
...
$ kubectl create clusterrolebinding monitor-pods \
    --clusterrole=monitor-pods \
    --serviceaccount=example-monitor-pods:monitor-pods-acc
...

monitor-pods-acc 具备了对 Pod 对象进行 getwatch 以及 list 操作的能力。我们用这个 ServiceAccount 以及前面生成的镜像,生成一个 Pod:

apiVersion: v1
kind: Pod
metadata:
  name: shell-operator
  namespace: example-monitor-pods
  annotations:
    prometheus.io/scrape: 'true'
    prometheus.io/port: '9115'
spec:
  containers:
  - name: shell-operator
    image: dustise/shell-operator:monitor-pods
    imagePullPolicy: Always
  serviceAccountName: monitor-pods-acc

四、触发 Hook

这个 Pod 启动之后,新建一个 Deployment,再看 Hook 的日志:

$ kubectl create deployment sleep  --image=dustise/sleep:v0.9.5
deployment.apps/sleep created
$ kubectl logs -f shell-operator  -n example-monitor-pods
...
{"binding":"kubernetes","event":"kubernetes","hook":"pods-hook.sh","level":"info","msg":"Pod 'sleep-84d5994d88-qnc7c' added","output":"stdout","queue":"main","task":"HookRun","time":"2020-11-07T15:46:21Z"}
...

五、监控信息

细心的读者会看到,前面的 Pod 包含了一个 Prometheus 的注解,如果打开 Prometheus 就会看到其中多出了一系列 shell_operator_hook 前缀的监控指标,例如:

shell_operator_tasks_queue_action_duration_seconds_bucket{queue_action="AddLast",queue_name="main",le="0"} 0
shell_operator_tasks_queue_action_duration_seconds_bucket{queue_action="AddLast",queue_name="main",le="1e-06"} 0
shell_operator_tasks_queue_action_duration_seconds_bucket{queue_action="AddLast",queue_name="main",le="2e-06"} 0

并且,Shell Operator 还支持加入自定义的监控指标,只要将指标写入文件,并把文件名保存到 $METRICS_PATH 环境变量之中就可以。

六、用途

这东西非常适合急救——在一些特殊场合,根据特定条件,对指定对象进行一些操作,例如注解、标签、清除、重启等。

本文转载自“伪架构师”公众号

没看过瘾?这里还有

龙哥系列大作

●用 Sidecar 应用 Configmap 更新

●如何使用 Kyverno 定义 Kubernetes 策略?

Kustomize上篇丨Helm 和 Kustomize:不只是含谷量的区别

Kustomize下篇丨Kustomize 中的增删改查

听说长得好看的人都点了赞和在看!

本文分享自微信公众号 - 腾讯云TStack(gh_035269c8aa5f),作者:崔秀龙

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2020-11-20

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 介绍一个不太小的工具:Shell Operator

    Shell Operator 是个冷僻又有点用的东西。这个工具的角度比较刁钻——使用的特定事件来触发 Shell 脚本。

    崔秀龙
  • 介绍一个不太小的工具—Stash

    AppCode Stash 是一个构建在 Restic 基础之上的工具,用于备份 Kubernetes 上运行的有状态应用,它使用一个有趣的 Sidecar,能...

    崔秀龙
  • 介绍一个小工具:Kubedog

    Kubedog 是一个开源的 Golang 项目,使用 watch 方式对 Kubernetes 资源进行跟踪,能够方便的用于日常运维和 CI/CD 过程之中,...

    崔秀龙
  • 介绍一个小工具:Ksniff

    对于相当一部分读者来说,在 Kubernetes 环境中,针对 Pod 进行抓包是个常规操作,在 Pod 中、在 Node 中都能够完成,抓出文件之后现场查看或...

    崔秀龙
  • 介绍一个小工具:Kubeval

    这次要介绍的是一个用于验证 Kubernetes 对象文档结构的小工具:kubeval。它能够对一个或多个 Kubernetes 或 OpenShift 的对象...

    崔秀龙
  • 介绍一个小工具:Kubeseal

    今天更新 Homebrew 的时候,眼角余光撇到一个 kube 开头的 Formula:kubeseal,名字还挺酷的,brew home 看了一下项目主页,还...

    崔秀龙
  • 介绍一个小工具:Dyff

    YAML 工人经常需要对类似的 YAML 进行对比,查看其中的更新或者状态变化,通用的 diff 工具经常是能胜任的,例如:

    崔秀龙
  • 介绍一个小工具:SSL-exporter

    Kubeadm 安装时的证书有效期设置为 1 年,虽说有 sealos 这样的不知名安装器以及各种方案来更新证书,但是对于像我一样经常跟不知来源的 Kubern...

    崔秀龙
  • 介绍一个免费的云开发工具:Cloud Shell

    版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。 ...

    Jerry Wang
  • 介绍一个小工具:KubeNurse——集群网络监控

    Kubenurse:https://github.com/postfinance/kubenurse

    CNCF
  • 使用shell-operator实现Operator

    在本文我们(Flant)将介绍简化 Kubernetes Operator 创建的方法,并展示如何使用 shell-operator 轻松实现自己的 Opera...

    CNCF
  • 使用 shell-operator 实现 Operator

    在本文我们将介绍简化 Kubernetes Operator 创建的方法,并展示如何使用 shell-operator 轻松实现自己的 Operator。本文基...

    我是阳明
  • 介绍一个小工具:网络策略可视化编辑器

    既然是牛年第一篇,总要写点废话起个头。另外写小工具系列经常面对的一个难题就是——怎样凑够 300 字的原创门槛。

    崔秀龙
  • 在 Kubernetes 中检查镜像签名

    之前连续写了几篇 Shell Operator 的东西,后来又写了一篇 cosign 的介绍,细心的读者可能会猜到,最终我的目的就是会用 Shell Opera...

    CNCF
  • 在 Kubernetes 中检查镜像签名

    之前连续写了几篇 Shell Operator 的东西,后来又写了一篇 cosign 的介绍,细心的读者可能会猜到,最终我的目的就是会用 Shell Opera...

    崔秀龙
  • 揭秘|一探腾讯基于Kubeflow建立的多租户训练平台背后的技术架构

    作者薛磊,腾讯高级软件工程师,服务于腾讯星辰算力平台,是Kubeflow的maintainer以及Volcano、 Kubernetes等其他开源项目的贡献者,...

    腾讯云原生
  • 介绍一个很实用的R包——R包管理工具

    在浏览器中,可以使用Extension Manager插件来管理各种各样的插件,也可以使用油猴插件来管理各种各样的脚本。

    DataCharm
  • 今天介绍一个开源的视频转换工具——Handbrake

    简介:HandBrake是一个免费的开源视频转换工具。让我们看看它的主要功能是什么,以及如何使用它们将视频从一种格式转换为另一种格式。

    用户6543014
  • 介绍一个 Windows 10 清理右键菜单和新建菜单的小工具 ContextMenuManager

    使用 windows 10 一段时间之后,随着机器上安装软件的增加,右键菜单和新建菜单里的内容越来越庞杂。网上有很多对这两个菜单进行清理的工具,找了一圈之后,我...

    Jerry Wang

扫码关注云+社区

领取腾讯云代金券