【DEVOPS】流程打通之制品库状态变更通知

傷城~ 2022-12-22 00:56 113阅读 0赞

> 通过Nexus3提供的WebHook功能实现制品库状态的第一时间通知。

### 1. 前言 ###

在[【DEVOPS】基于Jenkins+Nexus实现增量包自动发布][DEVOPS_Jenkins_Nexus] 中我们介绍了如何实现自动化增量包发布解决方案，不过对于其中的制品库Nexus实现通知功能只是做了原理性介绍，本文将对具体的实现细节进行补充说明，给出可落地的解决方案。

### 2. 实现 ###

总体思路正如前一篇所说的"利用Nexus3内置的WebHook，在特定的Event Type发生时回调我们准备好的HTTP callback，按照事先的约定通知对应的人员"。

梳理整个实现逻辑，关键性操作大概有以下几个：

1.  配置HTTP callback，在其中实现通知功能。
2.  配置Nexus3的WebHook，绑定我们关注的Event Type。

##### 2.1 配置HTTP callback #####

笔者所在公司有自己的内部通讯工具，而相关的广播功能也已经提供了相应的Restful API，因此这里笔者推翻了之前自建SpringBoot项目的思路，转而借助[GitHub - adnanh/webhook][GitHub - adnanh_webhook]这一款轻量级的webhook工具来实现。

1.  安装 adnanh/webhook  
    网上不少都是Docker安装的，但因为我们需要使用使用`curl`命令调用通知功能，因此以下给出二进制安装和配置方法。
    
        # 下载
        wget https://github.com/adnanh/webhook/releases/download/2.6.6/webhook-linux-amd64.tar.gz
        
        # 解压
        sudo tar -xvf webhook-linux-amd64.tar.gz
        
        # 移动到 /usr/local/bin 
         mv webhook-linux-amd64/webhook /usr/local/bin
         
        # 验证
        webhook -version
        
        # 移除下载的包
        rm -rf webhook-linux-amd64*
2.  配置
    
        # 创建相关的工作目录并赋权
        sudo mkdir /opt/webhook/hooks
        sudo mkdir /opt/webhook/scripts
        
        chmod +x /opt/webhook/scripts
        
        # hooks.json
        vi /opt/webhook/hooks/hooks.json
        	[
        	    { 
        	      "id": "simple-one",
        	      "execute-command": "/opt/webhook/scripts/app",
        	      "include-command-output-in-response":true,
        	      "include-command-output-in-response-on-error":true,
        	      "command-working-directory":"/opt/webhook/scripts/",
        	      "pass-arguments-to-command":
        	     [
        	      { 
        	        "source": "entire-payload",
        	        "name":"all-json"
        	      },
        	      { 
        	        "source": "entire-headers",
        	        "name":"all-header"
        	      },
        	      { 
        	        "source": "entire-query",
        	        "name":"all-query"
        	      }
        	    ],
        	      "trigger-rule":
        	      { 
        	        "match":
        	        { 
        	          "type": "regex",
        	          "regex": ".*jar$",
        	          "parameter":
        	          { 
        	            "source": "payload",
        	            "name": "asset.name"
        	          }
        	        }
        	      }
        	    }
        	]
        
        # app
        vi /opt/webhook/scripts/app
        	#!/bin/sh
        	#printenv
        	#echo $@ , $1, $2
        	ARTIFACT_ID=$(echo $1 | python -c "import sys, json; print json.load(sys.stdin)['asset']['name']")
        	curl --location --request POST http://{ context}:port/pushMessage.action  --header 'Content-Type: application/x-www-form-urlencoded'  --data-urlencode 'receiver=xxxxx'  --data-urlencode 'msgTitle=制品库更新'  --data-urlencode "msgContent=制品${ARTIFACT_ID}已更新, 请注意分派任务!"
3.  测试
    
        # 启动 （ 测试完毕正式启用时, 使用nohup ）
        webhook -hooks /opt/webhook/hooks/hooks.json -verbose
        
        # 推送制品到Nexus
        curl -v --user 'admin:admin123' --upload-file E:/xx-2.23.0.jar http://172.xx.3.3:8x2/repository/xxx/documentation/xx-2.23.0.jar

##### 2.2 配置HTTP callback #####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70_pic_center]  
![配置WebHook][WebHook]

注意这里要选择的是"Webhook Respository"，并且Event Type建议全部选上，宁杀错不放过，之后再考虑优化。

### 3. 效果 ###

![通知][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70_pic_center 1]  
如上图所示，制品库的状态变更将被通知到指定的负责人，加速价值流动，助推DEVOPS的落地。

后期的优化方向则是通过一系列的约定使通知目的范围尽量地小且精确，让通知功能的效力最大化。

### 4. Links ###

1.  [Nexus3 -WebHooks][]
2.  [GitHub - adnanh/webhook][GitHub - adnanh_webhook]
3.  [nexus 数据库备份任务webhook 通知-另外一种方法][nexus _webhook _-]

[DEVOPS_Jenkins_Nexus]: https://blog.csdn.net/lqzkcx3/article/details/109299732
[GitHub - adnanh_webhook]: https://github.com/adnanh/webhook
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/3ade6dca68344f609a053922dc2475fb.png
[WebHook]: /images/20221120/9f9d535eeeb5424dbe476c1c4ee97325.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221120/2f5ecb2ca36044068f867e51f6c2cd06.png
[Nexus3 -WebHooks]: https://help.sonatype.com/repomanager3/webhooks
[nexus _webhook _-]: https://www.cnblogs.com/rongfengliang/p/10786184.html