产品战略专家梁宁确认出席AICon北京站,分享AI时代下的商业逻辑与产品需求 了解详情
写点什么

我的第一款 Drone 插件

  • 2019-11-28
  • 本文字数:2046 字

    阅读完需:约 7 分钟

我的第一款 Drone 插件

前言

Drone 是一款基于 Docker 的 CI 工具,不仅运行环境是容器化的,甚至于 CI 流中的每一个插件也是 docker 容器。基于容器的 Drone 插件一大特色就是允许我们使用任何语言去开发插件,Python, PHP, Nodejs, bash… 这些都是可以的。每个开发者都可以使用自己熟悉的语言去开发自己想要的插件。Drone 的官方插件市场罗列了很多插件,并且在文档提供了 Golang 和 Bash 版本的插件开发文档,并开源了一个插件脚手架。


官方插件里有一个 drone-telegram 插件,不过插件目前是不支持自定义 telegrame 请求地址的,对于我这种机器部署在国内需要使用反代的方式访问 telegram 的用户来说不是很方便。搜索到 node-telegram-api 这个模块可以配置,下面我就简单说说基于 Nodejs 写一个 Telegram 消息通知的插件。


1 原理

Docker 容器在启动的时候可以设置一个启动命令,这样我们就可以做到实例化插件容器的时候就执行插件脚本。另外 Drone 运行插件的时候会将本次 CI 构建相关的信息以及插件配置信息以环境变量的形式注入到插件容器实例中。所有的语言都是可以去读取系统环境变量的,这也让其支持所有语言成为了可能。


  • 插件配置会以 PLUGIN_xxx 的形式注入,例如 PLUGIN_TOKEN。

  • 构建相关的信息会以 CI_xxx 或者 DRONE_xxx 的形式注入,例如 DRONE_COMMIT, CI_COMMIT_AUTHOR_NAME。

2 编写插件

编写插件很简单,只需要注意需要获取的配置使用 PLUGIN_ 获取即可,例如 telegram 需要使用的 PLUGIN_TOKEN 等。下面是具体的插件代码:


const render = require('drone-render');const TelegramBot = require('node-telegram-bot-api');
const { PLUGIN_TOKEN, PLUGIN_TO, TELEGRAM_TOKEN, TELEGRAM_TO, PLUGIN_LANG, PLUGIN_MESSAGE, PLUGIN_BASE_API_URL} = process.env;
const TOKEN = PLUGIN_TOKEN || TELEGRAM_TOKEN;const TO = PLUGIN_TO || TELEGRAM_TO;
if(PLUGIN_LANG) { render.locale(PLUGIN_LANG);}const bot = new TelegramBot(TOKEN, { baseApiUrl: PLUGIN_BASE_API_URL});bot.sendMessage(TO, render(PLUGIN_MESSAGE));
复制代码


可以看到其实代码非常的简单。

3 Dockerfile

插件写好之后就需要创建 Dockerfile 文件制作镜像了。由于 Dockerfile 的每一个指令都会为容器创建一个 layer,所以这里有个小技巧是将 npm install 依赖安装这种不怎么会变化的操作提前,频繁变化的插件脚本的拷贝置后。这样在多次打包发布的时候会占优势,仅仅只会传后面变化的部分,减小传输体积。


FROM mhart/alpine-node:8.9.3
WORKDIR /telegram-nodeCOPY package.json /telegram-node/package.jsonRUN npm install
COPY index.js /telegram-node/index.jsENTRYPOINT [ "node", "/telegram-node/index.js" ]
复制代码


最后就是编译并发布我们的 docker 容器以供其它人方便使用:


docker build lizheming/drone-telegram-node .docker push lizheming/drone-telegram-node
复制代码

4 测试

本地使用如下命令启动镜像即可测试插件是否工作:


docker run --rm \    -e PLUGIN_TOKEN=xxxxxxx \    -e PLUGIN_TO=xxxxxxx \    -e PLUGIN_MESSAGE=test \    -e PLUGIN_BASE_API_URL=xxxx \    lizheming/drone-telegram-node
复制代码

5 问题

secrets 参数获取

经常有些密钥之类的参数不想写在 .drone.yml 配置文件中暴露给所有项目可见的用户,这时候我们就会使用 drone secrets 添加变量,具体可参考我之前写的文章《如何使用Drone》


这里需要注意的是 secrets 定义的变量名即最后 drone 注入进入的环境变量名称,所以不能随意使用。例如你的配置是:


pipline:  telegram:    image: lizheming/drone-telegram-node    secrets: [ telegram_token, telegram_to ]    message: hello
复制代码


最后你在插件内部就能使用 process.env.TELEGTAM_TOKEN 来获取对应的密钥变量。

插件不生效

在编写插件的时候我碰到的一个问题是我最开始的 Dockerfile 是如下这样的:


FROM mhart/alpine-node:8.9.3
WORKDIR /telegram-nodeCOPY package.json /telegram-node/package.jsonRUN npm install
COPY index.js /telegram-node/index.jsENTRYPOINT [ "node", "index.js" ]
复制代码


由于我设置了 WORKDIR 工作目录,正常的 docker run 是可以找到我的入口文件为 ${WORKDIR}/index.js 的。但是 drone 在执行插件的时候由于需要访问项目代码,所以会通过命令覆盖掉镜像的 WORKDIR 配置。导致了我的插件正常运行没问题,但是上到 drone 怎么也执行不了。最后查了才发现是因为复现了工作目录配置后入口文件找不到压根就没执行我的插件的问题。

6 后记

插件的所有代码已经发布在Github



镜像 lizheming/drone-telegram-node 也已发布到 docker hub 上。本插件相对于官方的插件的优势是能够设置 telegram API 接口的地址,对于国内服务使用反代的方式来说比较适合。如果想要在国内服务器上使用 drone telegram 消息通知的可以使用。不知道如何设置 telegram API 反代的也可以参考我的文章《反代访问Telegram》


本文转载自公众号 360 云计算(ID:hulktalk)。


原文链接:


https://mp.weixin.qq.com/s/-h1bZp4N-6F_89XmSH214g


2019-11-28 11:591063

评论

发布
暂无评论
发现更多内容

智能技术与生物技术共同绘就生命“藏宝图”,对你我意味着什么?

脑极体

网络攻防学习笔记 Day60

穿过生命散发芬芳

网络攻防 6月日更

聊聊知乎订单系统迁移

知一

监控 软件开发 系统架构 重构 订单系统

Linux之head命令

入门小站

Linux

在线图片转base64工具

入门小站

工具

Rust从0到1-函数式编程-性能比较

rust 函数式编程 Performance 性能比较

卢卡开专栏了

卢卡多多

数据库 MySQL 高可用 6月日更

革故鼎新:企业数字化转型繁荣互联网生态建设,驱动ICT设施升级

科技热闻

vue keep-alive(2):剖析keep-alive的实现原理—学习笔记整理

zhoulujun

Vue vue源码解读 keep-alive实现原理

【LeetCode】传递信息Java题解

Albert

算法 LeetCode 7月日更

【Flutter 专题】129 图解 ToggleButtons 按钮切换容器组

阿策小和尚

Flutter 小菜 0 基础学习 Flutter Android 小菜鸟 7月日更

华为云原生媒体网络,升级传统,赋能未来

华为云开发者联盟

云原生 直播 TechWave 媒体网络 云视频

Camtasia实用技巧之视频剪辑

淋雨

视频剪辑 Camtasia 录屏软件

双碳打开新机遇 华为互联网数据中心基础设施筑起“绿色基石”

科技热闻

《面试补习》- Java集合知识梳理

九灵

Java 面试 集合

推荐系统之数据与特征工程(二十三)

Databri_AI

数据 推荐系统 技术特征

我们常说的算法时间复杂度和空间复杂度到底是什么?

编程三昧

编程 算法复杂度

【源码系列】Spring 过滤器和拦截器

Alex🐒

spring 源码 Spring Framework

Java的多线程和高并发详解

北游学Java

Java 多线程

漏洞都有哪些分类

网络安全学海

网络安全 信息安全 渗透测试 漏洞 漏洞分析

2021,云原生避坑经验分享|CIC 阵容官宣

青云技术社区

容器 云原生

5分钟速读之Rust权威指南(三十三)Send&Sync

wzx

rust

智能运维(AIOps)系列之一:个人对智能运维的理解

micklongen

AIOPS 智能运维

vue keep-alive(1):vue router如何保证页面回退页面不刷新?

zhoulujun

Vue vue-router keep-alive 页面缓存

如何做好IT项目管理?

万事ONES

IT 项目经理 项目管理工具

构筑高质量的数据中心基础设施,华为助力创造互联网全新体验

科技热闻

开源商业化:满足各方底层需求

茶陵後

开源 开源社区 开源文化

SQL 居然还能在 Apache ShardingSphere 上实现这些功能?

SphereEx

如何实施 SCRUM ?

万事ONES

项目管理 Scrum 敏捷开发 看板 ONES

提升中台化体系产研效能的ParisFlow方法与实践

downgoon

中层管理者的工作五步法

石云升

读书笔记 职场经验 管理经验 6月日更

我的第一款 Drone 插件_服务革新_怡红公子_InfoQ精选文章