Devops-蓝鲸篇-05-蓝盾插件开发指引

于 2024-12-11 03:00:10 发布
阅读量1k 收藏 11
点赞数 30
分类专栏： devops 文章标签： devops 运维
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_41004932/article/details/144388091
版权

写在前面

开发插件前，先进入插件工作台初始化一个插件，确定插件在平台中的唯一标识

工作台

可以在这里进行新增/发布/下架等管理插件的操作

功能区介绍

在这里插入图片描述

  1. 切换资源类型
  2. 新增插件
  3. 单个插件的管理入口
  4. 升级、下架、删除插件快捷入口
  5. 指引文档和插件 UI 调试工具入口

新增插件

在这里插入图片描述

  1. 标识
  • 插件在平台中的唯一标识，建议取和插件功能相关的可读性好的英文标识
  1. 调试项目
  • 插件发布过程中，可以在调试项目下将插件添加到流水线执行，对插件进行测试，保证插件功能满足预期。
  • 建议新增专用的插件调试项目，避免测试过程中影响到业务。
  1. 开发语言
  • 支持四种语言开发插件：
    • Java（推荐）
    • Python
    • Golang
    • Nodejs

开发插件

初始化好插件之后，可以开始开发插件

插件私有配置

插件级别的敏感信息，如 token、用户名密码、IP、域名等，不建议直接提交到代码库，通过工作台私有配置界面管理

在这里插入图片描述

Golang 插件开发

插件开发框架说明

插件最终打包成一个命令行可执行的命令即可，对开发框架无硬性要求 下边以 demo 插件为例示范

示例插件代码工程的整体结构如下

|- <你的插件标识>
    |- cmd
        |- application
            |- main.go
    |- hello
        |- hello.go

如何开发插件：

参考 plugin-demo-golang

Demo示例研读

将 plugin-demo-golang clone到本地。
来看下项目结构：

.
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── README.md
├── go.mod
├── go.sum
├── i18n
│   ├── message_en_US.properties
│   └── message_zh_CN.properties
├── main.go
├── task.json
└── translation
    └── translation.go

3 directories, 11 files

咦！和上面说的插件代码工程的整体架构不一样：

|- <你的插件标识>
    |- cmd
        |- application
            |- main.go
    |- hello
        |- hello.go

不过，这不重要，只要插件最终能够打包成一个命令行可执行的命令即可。

这里i18n是实现中英文国际化使用的，

├── i18n
│   ├── message_en_US.properties
│   └── message_zh_CN.properties

看下内容对比：
message_en_US.properties：

input.desc.label=desc
100001=input param [{0}] invitated

message_zh_CN.properties

input.desc.label=描述
100001=输入参数[{0}]非法

那我们就可以猜测，这里是实现输入参数[{0}]非法这句话的中英文，其中[{0}]会使用具体的参数填充。

然后i18ngenerator则是根据properties文件的配置，生成translation代码，如translation.go：

// Code generated by "i18ngenerator"; DO NOT EDIT.

package translation

// Translations
var Translations map[string][][]string = make(map[string][][]string)

func init() {
    Translations["en-US"] = [][]string{
       {
          "100001",
          "input param [{0}] invitated",
       },
       {
          "input.desc.label",
          "desc",
       },
    }
    Translations["zh-CN"] = [][]string{
       {
          "100001",
          "输入参数[{0}]非法",
       },
       {
          "input.desc.label",
          "描述",
       },
    }
}

该文件是由i18ngenerator自动生成的，不要自己改。

main函数内，实现了一个小的输出功能，简单看下源码，然后去进行测试：

package main

import (
    "fmt"
    "io/ioutil"
    "os"
    "runtime"
    "time"

    "github.com/ci-plugins/golang-plugin-sdk/api"
    "github.com/ci-plugins/golang-plugin-sdk/log"
    "github.com/ci-plugins/plugin-demo-golang/translation"
)

//go:generate i18ngenerator i18n ./translation/translation.go

type greetingParam struct {
    UserName string `json:"userName"`
    Greeting string `json:"greeting"`
}

func (a *greetingParam) String() string {
    return fmt.Sprintf("userName: %v, greeting: %v", a.UserName, a.Greeting)
}

func main() {
    runtime.GOMAXPROCS(4)
    log.Info("atom-demo-glang starts")
    defer func() {
       if err := recover(); err != nil {
          log.Error("panic: ", err)
          api.FinishBuild(api.StatusError, "panic occurs")
       }
    }()

    api.InitI18n(translation.Translations, api.GetRuntimeLanguage())
    msg, err := api.Localize("input.desc.label")
    if err != nil {
       log.Error(err)
    }
    log.Info(msg)

    helloBuild()
}

func helloBuild() {
    // 获取单个输入参数
    userName := api.GetInputParam("userName")
    log.Info("userName: ", userName)

    // 打屏
    log.Info("\nBuildInfo:")
    log.Info("Project Name:     ", api.GetProjectDisplayName())
    log.Info("Pipeline Id:      ", api.GetPipelineId())
    log.Info("Pipeline Name:    ", api.GetPipelineName())
    log.Info("Pipeline Version: ", api.GetPipelineVersion())
    log.Info("Build Id:         ", api.GetPipelineBuildId())
    log.Info("Build Num:        ", api.GetPipelineBuildNumber())
    log.Info("Start Type:       ", api.GetPipelineStartType())
    log.Info("Start UserId:     ", api.GetPipelineStartUserId())
    log.Info("Start UserName:   ", api.GetPipelineStartUserName())
    log.Info("Start Time:       ", api.GetPipelineStartTimeMills())
    log.Info("Workspace:        ", api.GetWorkspace())

    // 输入参数解析到对象
    paramData := new(greetingParam)
    api.LoadInputParam(paramData)
    log.Info(fmt.Sprintf("\n%v，%v\n", paramData.Greeting, paramData.UserName))

    // 业务逻辑
    log.Info("start build")
    build()
    time.Sleep(2 * time.Second)

    // 输出
    // 字符串输出
    strData := api.NewStringData("test")
    api.AddOutputData("strData_01", strData)

    // 文件归档输出
    artifactData := api.NewArtifactData()
    artifactData.AddArtifact("result.dat")
    api.AddOutputData("artifactData_02", artifactData)

    // 报告输出
    reportData := api.NewReportData("label_01", api.GetWorkspace()+"/report", "report.htm")
    api.AddOutputData("report_01", reportData)

    api.WriteOutput()
    log.Info("build done")
}

func build() {
    log.Info("write result.dat")
    ioutil.WriteFile(api.GetWorkspace()+"/result.dat", []byte("content"), 0644)
    log.Info("write report.htm")
    os.Mkdir(api.GetWorkspace()+"/report", os.ModePerm)
    ioutil.WriteFile(api.GetWorkspace()+"/report/report.htm", []byte("<html><head><title>Report</title></head><body><H1>This is a Report</H1></body></html>"), 0644)
}

在根目录下已经给我们预设了一个task.json文件，后面可以简单修改下这个文件来实现测试：

{
  "atomCode": "goDemo",
  "execution": {
    "language": "golang",
    "packagePath": "goDemo",
    "demands": [
      "chmod +x goDemo"
    ],
    "target": "./goDemo"
  },
  "input": {
    "greeting": {
      "label": "欢迎词",
      "default": "Glad to see you",
      "placeholder": "欢迎词",
      "type": "vuex-input",
      "desc": "欢迎词",
      "required": true,
      "disabled": false,
      "hidden": false,
      "isSensitive": false
    },
    "userName": {
      "label": "姓名",
      "default": "Mr. Huang",
      "placeholder": "姓名",
      "type": "vuex-input",
      "desc": "姓名",
      "required": true,
      "disabled": false,
      "hidden": false,
      "isSensitive": false
    }
  },
  "output": {
    "strData_01": {
      "description": "测试",
      "type": "string",
      "isSensitive": false
    }
  }
}

如何打包发布

1、进入插件代码工程目录下
2、打包
2.1、如果按照正常的demo的目录结构是需要进入cmd/application内执行build命令，因为main在此

cd cmd/application
GO111MODULE=on GOOS=linux GOARCH=amd64 go build -o bin/${executable}

2.2、这次用的demo则直接在根目录下执行build命令，因为main在根目录下

GO111MODULE=on GOOS=linux GOARCH=amd64 go build -o bin/${executable}

这里go build -o bin/ e x e c u t a b l e 会在 b i n 目录下，生成可执行文件，文件名是 {executable}会在bin目录下，生成可执行文件，文件名是 executable会在bin目录下，生成可执行文件，文件名是{executable}，即项目名。

也可以自定义一个名字，如GO111MODULE=on GOOS=linux GOARCH=amd64 go build -o bin/kingtest

  1. 在任意位置新建文件夹，命名示例：release_pkg = <你的插件标识>_release
  2. 将步骤 2 生产的执行包拷贝到 <release_pkg> 下
  3. 添加 task.json 文件到 <release_pkg> 下 task.json 见示例，按照插件功能配置。
mkdir kingtest_release
cp bin/kingtest kingtest_release/kingtest
touch kingtest_release/task.json

插件配置规范: 插件配置规范
task.json 示例：

{
  "atomCode": "king-test",                  # atomCode 要与工作台录入的一致
  "execution": {
    "language": "golang",
    "packagePath": "kingtest",              # 发布包中插件安装包的相对路径
    "demands": [
      "echo start run chmod +x kingtest",   # 插件启动前需要执行的安装命令，顺序执行
      "chmod +x kingtest",                  # 插件启动前需要执行的安装命令，顺序执行
      "echo stop run chmod +x kingtest",    # 插件启动前需要执行的安装命令，顺序执行
    ],
    "target": "./kingtest"
  },
  "input": {
    "greeting": {
      "label": "欢迎词",
      "default": "Glad to see you",
      "placeholder": "欢迎词",
      "type": "vuex-input",
      "desc": "欢迎词",
      "required": true,
      "disabled": false,
      "hidden": false,
      "isSensitive": false
    },
    "userName": {
      "label": "姓名",
      "default": "Mr. Huang",
      "placeholder": "姓名",
      "type": "vuex-input",
      "desc": "姓名",
      "required": true,
      "disabled": false,
      "hidden": false,
      "isSensitive": false
    }
  },
  "output": {
    "strData_01": {
      "description": "测试",
      "type": "string",
      "isSensitive": false
    }
  }
}
  1. 在 <release_pkg> 目录下，把所有文件打成 zip 包即可
cd kingtest_release && zip kingtest_release.zip kingtest task.json

zip包结构示例：

|- kingtest_release.zip         # 发布包
   |- kingtest                  # 插件执行包
   |- task.json                 # 插件配置文件

打包完成后，在插件工作台提单发布，即可测试或发布插件

上传一个流水线插件

开发好插件之后，通过研发商店工作台，将插件发布到研发商店，提供给用户添加到流水线中使用。

入口

在工作台列表，点击如下入口发起发布流程：
在这里插入图片描述
首次发布时，入口名为上架
后续更新版本时，入口名为升级

或者在插件发布管理->版本管理界面发起发布流程：
在这里插入图片描述

填写插件相关信息/上传插件发布包

上架/升级插件时，可以修改插件的基本信息，如下所示：
在这里插入图片描述

  1. 适用 Job 类型：
  • 和流水线 Job 类型对应，请按照插件实际适用情况选择
  • 若选错，需新增版本修改
  1. 发布包：
  • task.json 中的 atomCode 需和 新增插件时填写的标识一致，否则上传会失败

测试/发布插件

填写好信息，提交后，进入发布流程，可以测试->重新传包->测试，直至插件满足预期后，手动继续流程将插件发布到研发商店

在这里插入图片描述

  1. 测试：点击后跳转到插件调试项目的流水线服务下，可以将当前插件添加到流水线，验证 UI、功能是否满足预期
  2. 重新传包：当测试发现问题，修复后，重新上传发布包，再次进行测试
  3. 继续：测试 OK，满足预期后，确认提交发布
  4. 取消发布：发布过程中，随时可以终止发布

遇见的几个错误

无权限执行

在测试中遇见一个问题：无权限执行
在这里插入图片描述
在execution->demands增加一个命令chmod +x kingtest即可解决

发布进度里重新传包持续报错task.json格式错误

还有个问题，在发布进度里重新传包时，一直报错task.json格式错误，但实际格式是对的！
触发的原因暂不知道，但是确实是一个隐藏的bug。

在这里插入图片描述
直接点击继续，然后走升级插件的方式可以正常使用。

cannot execute binary file: Exec format error

这里的问题是我造成的，最初我在mac环境下编译的可执行文件，命令是：

# mac下执行
go build -o bin/kingtest

但是插件里选择的编译环境是linux。
在这里插入图片描述
解决方式：让插件选择的编译环境和可执行文件的平台统一。

我这里选择重新编译下可执行文件，采用在mac平台交叉编译linux平台可执行文件的方式。

GO111MODULE=on GOOS=linux GOARCH=amd64 go build -o bin/kingtest

也可以新建一个插件，编译环境选择mac。

运行结果

流水线结果：
在这里插入图片描述
输出结果：

[Plugin info]
=====================================================================
Task           : king-test
Description    : bk插件测试
Version        : 1.0.3
Author         : huari
Help           : More Information
=====================================================================
-----
[Input]
input(normal): (欢迎词)greeting=Glad to see you
input(normal): (姓名)userName=Mr. Huang
-----
[Install plugin]
-----
start run chmod +x kingtest
stop run chmod +x kingtest
atom-demo-glang starts
描述
userName:  Mr. Huang

BuildInfo:
Project Name:      GOPS
Pipeline Id:       p-8967ed52b08847c8a5b0140937db0975
Pipeline Name:     king-test
Pipeline Version:  11
Build Id:          b-78947b5c39f34b32bbafb803042d1e22
Build Num:         15
Start Type:        MANUAL
Start UserId:      huari
Start UserName:    huari
Start Time:        1733298107286
Workspace:         /data/devops/workspace

Glad to see you，Mr. Huang
start build
write result.dat
write report.htm
build done
[Output]
1 file match: 
  /data/devops/workspace/result.dat
prepare to upload 7 B
1/1 file(s) finished
output(except): artifactData_02=result.dat
入口文件检测完成
上传自定义产出物成功，共产生了1个文件
output(except): report_01=report.htm
output(normal): strData_01=test
-----
基于腾讯蓝盾平台建立的CI CD流水线案例
weixin_41756748的博客
07-25 3729
1:在CI CD平台上创建项目 此流水线是在腾讯自研的蓝盾平台上进行创建，此平台的基本思路和思想和外部常用的 Jenkins是完全一致的。 登陆http://devops.oa.com/console/pipeline/devop2020-/list 2：添加一个编译 触发事件 3：添加构建环境 4：添加拉取源代码的步骤 5： 添加编译打包源代码的bash脚本命令 cd ${WORKSPACE} rm -f iwiki-home.zip iwiki-h...
Devops-蓝鲸篇-04-蓝盾流水线详细介绍
最新发布
一叶知秋
12-11 1335
通过研发商店，你可以开发自己的插件，目前已支持 Java/Python/NodeJS/Go 4 种主流语言合理的使用常量/变量可以更便捷的维护流水线，BK-CI 提供了很多系统常量/变量。用法：插件配置中，输入 $ 即可获取对应变量的值。如 $因历史原因，部分常量并未做覆盖限制，但不建议修改常量的值。Variable样例流水线 ID，34 位长度，全局唯一构建启动方式，MANUAL/TIME_TRIGGER/WEB_HOOK/SERVICE/PIPELINE/REMOTE 中取值。
Devops-蓝鲸篇-02-蓝盾简介
一叶知秋
12-11 1324
蓝鲸持续集成平台（代号 BK-CI）是一个免费并开源的 CI 服务，可助你自动化构建-测试-发布工作流，持续、快速、高质量地交付你的产品。使用 BK-CI 屏蔽掉所有研发流程中的繁琐环节，让你聚焦于编码。BK-CI 开源GitHub 地址：https://github.com/TencentBlueKing/bk-ci/
蓝鲸标准插件开发
Miss741的博客
09-30 1652
标准运维插件开发 一.准备工作 1.蓝鲸社区版环境及账号（培训方提供，不需要自己搭建） 2.蓝鲸应用开发环境（安装指南见蓝鲸开发者中心） 3.本地安装 rabbitmq、celery 和 redis 4.自己用起来顺手的 IDE，推荐 PyCharm 5.git 仓库管理工具，命令行即可 二.任务准备：创建一个蓝鲸应用 任务目标：在蓝鲸 PaaS 开发者中心，创建一个蓝鲸应用，然后在蓝鲸官网Smart 市场下载标准运维应用来初始化项目代码。 1.创建蓝鲸应用 a)创建一个代码仓库 b)打开蓝鲸开发者中心，创
蓝鲸DevOps深度解析系列（2）：蓝盾流水线初体验
weixin_34310369的博客
03-12 848
关注嘉为科技，获取运维新知 前面一篇文章《蓝鲸DevOps深度解析系列（1）：蓝盾平台总览》，我们总览了蓝鲸DevOps平台的背景、应用场景、特点和能力； ​ 接下来我们继续解析蓝盾平台的核心组件——流水线引擎。本文介绍的是蓝盾流水线的用户体验，为了让大家有更直观的感受，所以图片较多，请谅解。 传统的瀑布式软件开发模型在需求明确、业务稳定的项目中，有着明显的优势；而面对需求频繁变化的项目、持续迭代...
云函数场景下的DevOps实践--蓝盾
NicolasLearner的博客
10-07 685
巧匠因为他的工具而出名 — 《人月神话》 本文将展示使用云函数+ 蓝盾，开发部署一个"给用户发送提醒短信"的微服务。以这个非常简单的应用，探索一下ServerLess结合DevOps所能产生的合力，畅想一下未来轻应用的开发部署模式。 0.相关材料 腾讯云云函数(ServerLess Cloud Function )： https://cloud.tencent.com/document/product/583 蓝盾（蓝鲸）：https://bk.tencent.com/（此处为外.
Devops-蓝鲸篇-03-蓝盾流水线简单介绍
一叶知秋
12-11 1209
BK-CI 可以帮你快速实现一条持续交付流水线来编译、测试、部署你的应用，下面将通过教程和文档指南告诉你，怎么在 BK-CI 里配置和管理持续集成、持续交付（CI/CD）流水线。
devops-master-class：Devops初学者教程-学习Docker，Kubernetes，Terraform，Ansible，Jenkins和Azure Devops
02-03
Master Devops-Docker，Kubernetes，Terraform和Azure Devops 通过Docker，Kubernetes，Terraform，Ansible，Jenkins和Azure Devops学习Devops 管道项目Github存储库 Azure Devops- 詹金斯-https: 课程介绍 200多...
百度地图毕业设计源码-devops-user-service:devops-用户-服务
06-06
本项目是百姓网DevOps团队基于现有工作提炼出来的相对表完整的流水线，项目功能是一个简单的用户信息的增删改查，采用SpringBoot框架开发，数据库采用H2。 对应的API为： API列表 路径 请求方式 参数说明 项目首页 /...
蓝鲸BK_CMDB配置平台.pdf
06-12
蓝鲸配置平台是一款面向应用的 CMDB，在 ITIL 体系里，CMDB 是构建其它流程的基石，而在蓝鲸 智云体系里，配置平台就扮演着基石的角色，为应用提供了各种运维场景的配置数据服务。它是企 业 IT 管理体系的核心，通过提供配置管理服务，以数据和模型相结合映射应用间的关系，保证数据 的准确和一致性；并以整合的思路推进，最终面向应用消费，发挥配置服务的价值。
devops全开源端到端部署流水线
03-14
devops流水线视频，高校运维社区制作，讲解devops端到端持续交付流水线1.0
devops--PPT演讲系列（11）.rar
03-13
devops主题系列演讲一共有14个部分，这是第11部分，每个部分里有10个大佬演讲的PPT，每个PPT都是独立的。 龙井-龙门阵之DevOps门外汉须知 罗伟-蘑菇街基于容器的全生命周期 DevOps 运营平台建设 牛晓玲&景韵-转型...
[蓝鲸社区版6.0.5+监控3.3.2320]使用bkplugin_nginx-1.4-official.tgz插件，检查nginx状态
weixin_48096142的博客
09-26 723
蓝鲸监控nginx_status
「DevOps」入门指南
技术路上的探险家
06-05 1934
DevOps是一种思想、文化和实践方法，旨在加强开发和运维团队之间的协作和沟通，以提高软件交付和部署的效率和质量。在学习DevOps之前，需要了解它的定义、原则和目标，以及它与其他技术方法的区别。
【DevOps】Atlassian插件开发指南
光阴迷客的知识库
07-17 2028
Atlassian Bamboo 6.9.1 是一款持续集成和持续交付（CI/CD）工具，支持使用插件扩展其功能。如果需要开发自己的 Bamboo 插件并添加到 Bamboo 中，则可以参考以下指南。
蓝鲸平台扩展流水线构建成功插件
lin1214000999的博客
01-11 2886
1.邮件形式 1）引入gradle 2）在application 配置文件中添加配置信息 配置发邮件的服务器，此处使用qq邮箱发邮件 username：qq邮箱地址 password：为邮箱的授权码，不是qq密码 subprojects { group = "com.tencent.bk.devops.ci.notify" dependencies { api("org.jetbrains.kotlin:kotlin-stdlib-jdk8") api("
HOW - 用腾讯蓝盾部署一个 Web 应用
weixin_58540586的博客
08-12 1032
官方文档Githubbk-ci 是一个免费并开源的 CI 服务，可助你自动化构建-测试-发布工作流，持续、快速、高质量地交付你的产品。持续交付强调更快、更可靠、低成本的自动化软件交付，蓝盾流水线（Pipeline）提供可视化、一键式部署服务，和持续集成无缝集成，支持并行部署。项目：用于组织和管理 CI/CD 流程。流水线：定义了从代码提交到生产环境的整个 CI/CD 流程，由多个阶段组成。Stage（阶段）：流水线中的具体步骤，执行特定的任务，如构建、测试和部署。
云原生赛道一定要了解的Devops详细教程
weixin_45056021的博客
11-06 1480
Jenkins更适合需要高度定制的 CI/CD 流程、支持多种代码仓库和更复杂集成的团队。它的插件系统提供了丰富的灵活性，但同时也带来了配置和维护的复杂性。更适合使用 GitLab 仓库的团队，尤其是希望一站式管理代码、问题和 CI/CD 流程的团队。GitLab 更易于使用，配置简单，适合大部分标准化 DevOps 流程，但在自定义性上稍逊一筹。选择 Jenkins 还是 GitLab CI/CD 应该根据团队的规模、技术能力、项目需求以及对于灵活性的要求来决定。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值