开源工具专题-01 Superset的CICD流程构建

2024-03-20 05:44
文章标签 工具 流程 构建 开源 01 专题 cicd superset

本文主要是介绍开源工具专题-01 Superset的CICD流程构建，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

开源工具专题

注：

  • 本教程由羞涩梦整理同步发布，本人技术分享站点：blog.hukanfa.com

  • 转发本文请备注原文链接，本文内容整理日期：2024-01-28

  • csdn 博客名称：五维空间-影子，欢迎关注

  • 说明

    • 此搭建场景主要用于公司内部需要对superset进行二次开发来满足内部的使用需求
    • 需频繁提交代码并进行功能验证，效果图如下

    image-20240319172623875

1 代码拉取

  • 操作如下

    • superset 托管地址如下
    # github 外网拉取可能会超时
https://github.com/apache/superset
# gitee 码云国内
https://gitee.com/mirrors/Superset
# 克隆操作，http方式需输入gitee账号密码、ssh方式请在gitee上配置好机器公钥信息
git clone -b 3.1.1 https://gitee.com/mirrors/Superset.git
    • 提供本人对该项目做一些调整后的托管地址
    # gitee 调整的内容在本文后续章节会提到  源 3.1.1 分支
https://gitee.com/hukanfa/superset

2 修改 Dockerfile

  • 操作如下

    • 修改内容：去掉前端代码的编译环节，只编译后端代码、去掉生成dev环境的步骤
    FROM hukanfa/python:3.9-superset-v1.0 AS leanWORKDIR /app
ENV LANG=C.UTF-8 \LC_ALL=C.UTF-8 \SUPERSET_ENV=production \FLASK_APP="superset.app:create_app()" \PYTHONPATH="/app/pythonpath" \SUPERSET_HOME="/app/superset_home" \SUPERSET_LOG="superset.log" \SUPERSET_PORT=8088RUN mkdir -p ${PYTHONPATH} superset-frontend apache_superset.egg-info requirements \&& useradd --user-group -d ${SUPERSET_HOME} -m --no-log-init --shell /bin/bash superset \&& touch ${SUPERSET_HOME}/${SUPERSET_LOG} \&& chown -R superset:superset ./*COPY --chown=superset:superset setup.py MANIFEST.in README.md ./
COPY --chown=superset:superset ./requirements/*.txt ./requirements/
COPY --chown=superset:superset ./superset superset
COPY  ./docker/run-server.sh /usr/bin/
COPY --chown=superset:superset superset-frontend/package.json superset-frontend/
ADD superset_static_3_1_1.tar.gz /app/superset/RUN mkdir ~/.pip/ \&& echo '[global]' > ~/.pip/pip.conf \&& echo 'index-url = https://mirrors.aliyun.com/pypi/simple/' >> ~/.pip/pip.conf \&& echo 'trusted-host = mirrors.aliyun.com' >> ~/.pip/pip.conf \&& pip install --no-cache -r requirements/local.txt# COPY --chown=superset:superset --from=superset-node /app/superset/static/assets superset/static/assetsRUN pip install --no-cache -e . \&& flask fab babel-compile --target superset/translations \&& chown -R superset:superset superset/translations \&& chmod +x /usr/bin/run-server.shUSER supersetHEALTHCHECK CMD curl -f "http://localhost:${SUPERSET_PORT}/health"EXPOSE ${SUPERSET_PORT}######################################################################
# CI image...
######################################################################
FROM lean AS ciCOPY --chown=superset:superset  ./docker/*.sh /app/docker/
RUN chmod -R 755 /app/docker/*.shCMD ["/app/docker/docker-ci.sh"]
    • Dockerfile 文件中 superset_static_3_1_1.tar.gz 前端编译文件的获取方式如下
    # 拉取官方对应版本的镜像
docker pull apache/superset:3.1.1
# 运行镜像
docker run -d --name superset_temp apache/superset:3.1.1
# 进入镜像中将静态文件打包
$ docker exec -it 2b6d1d5f3006 /bin/bash
superset@2b6d1d5f3006:/app$ cd superset
superset@2b6d1d5f3006:/app/superset$ tar -zcvf superset_static_3_1_1.tar.gz ./static/
# 拷贝压缩包到宿主机保存
[hukanfa@hukanfa ~]$ docker cp 2b6d1d5f3006:/app/superset/superset_static_3_1_1.tar.gz ./
    • Dockerfile 文件中，python:3.9-superset-v1.0 基础镜像的 Dockerfile 文件如下
    ARG PY_VER=3.9-slim-bookworm
FROM python:${PY_VER}COPY ./debian.sources /RUN  cp -ar /etc/apt/sources.list.d/debian.sources /etc/apt/sources.list.d/debian.sources.bak \&& mv -f /debian.sources /etc/apt/sources.list.d/ \&& apt-get install apt-transport-https ca-certificates \&& apt-get update \&& apt-get install -y --no-install-recommends \build-essential \curl \default-libmysqlclient-dev \libsasl2-dev \libsasl2-modules-gssapi-mit \libpq-dev \libecpg-dev \libldap2-dev \sudo \inetutils-ping \  # 增加 ping 命令telnet \  # 增加 telnet 命令net-tools \  # 增加网络这块的查看命令&& rm -rf /var/lib/apt/lists/*
    • 对应的debian.sources 内容如下
    # 改成国内源
Types: deb
URIs: https://mirrors.huaweicloud.com/debian
Suites: bookworm bookworm-updates
Components: main
Signed-By: /usr/share/keyrings/debian-archive-keyring.gpgTypes: deb
URIs: https://mirrors.huaweicloud.com/debian-security
Suites: bookworm-security
Components: main
Signed-By: /usr/share/keyrings/debian-archive-keyring.gpg

3 修改 config.py

  • 操作如下

    • 路径：superset/config.py
    • 修改内容如下，mysql 请事先准备好
    ### 注释superset自带的数据库配置
#SQLALCHEMY_DATABASE_URI = (
#    f"""sqlite:///{os.path.join(DATA_DIR, "superset.db")}?check_same_thread=false"""
#)### 打开mysql配置
SQLALCHEMY_DATABASE_URI = 'mysql://superset:jNaCDgHcJ6zQzy@192.168.26.21:3307/superset'### 修改默认语言为中文，并只保留中英文语言切换
BABEL_DEFAULT_LOCALE = "zh"
LANGUAGES = {"zh": {"flag": "cn", "name": "Chinese"},"en": {"flag": "us", "name": "English"},
}### 注释掉默认配置，直接指定key。如果不注释也可以docker-compose文件中指定成环境变量
# SECRET_KEY = os.environ.get("SUPERSET_SECRET_KEY") or CHANGE_ME_SECRET_KEY
SECRET_KEY = 'oCghysSLvk2BSa9bPEOz6avKzjLHYkedO6ztCZ/sv5j3pwuIg63wVLeY'
    • 提前创建好mysql的supertset数据库，项目运行起来后初始化操作会自行创建表
    create database if not exists superset character set utf8mb4 collate utf8mb4_bin;

4 修改 docker-ci.sh

  • 操作如下

    • 路径：docker/docker-ci.sh
    • 此部署脚本会先启动初始化脚本，主要是生成表及相关表的数据初始化。之后再执行服务运行脚本
    • 当第一次部署superset且初始化完成之后，需要将此脚本中的初始化步骤注释掉
    • 防止后续部署过程中每次都会执行初始化的操作，这样会将配置好的一些数据给删掉的
    ### 特别提示：一定要等第一次初始化完成后再注释掉，不要一开始就注释
# /app/docker/docker-init.sh

5 pipeline 脚本

  • 操作步骤

    • 配置在 jenkins 对应项目的 pipeline 脚本框中
    pipeline{agent anyoptions { timestamps() }stages{stage('初始化'){steps{script {wrap([$class: 'BuildUser']) {env.buildUserTmp="$BUILD_USER"currentBuild.description = "构建人:(${env.BUILD_USER})动作:(${env.action_choice})环境:(${env.env_choice})版本号:(${env.version})分支:(${env.branch})"}}}}stage('代码拉取'){steps{git branch: "${env.branch}", credentialsId: 'c5xxxx93-ad21-4cdd-9c03-dxxxxxx6e15', url: 'git@gitee.com:hukanfa/superset.git'}}stage('打包编译'){ steps{sh "/bin/bash /root/jenkins_shell/newBackend/${pname}/build.sh  ${env.env_choice} ${BUILD_NUMBER} ${pname} ${env.action_choice} ${env.version} ${env.branch} ${WORKSPACE}"}}stage('部署上线'){steps{sh "/bin/bash /root/jenkins_shell/newBackend/${pname}/deploy.sh ${env.env_choice} ${BUILD_NUMBER}  ${pname} ${env.version} ${env.action_choice}"}}}
}
    • 流程图如下所示

    image-20240319170416855

6 build.sh

  • 操作如下

    • 脚本内容
    #!/bin/bash
### 接收的传参
envType=$1
buildNumber=$2
pName=$3
actionType=$4
pVersion=$5
codeBranch=$6
workspace=$7### 变量定义区
# 注意，远程机需事先把前端文件传到对应的项目路径下
fontTar="/root/other_data/superset_static_3_1_1.tar.gz"
# 定义镜像名称
imageName="registry-vpc.cn-guangzhou.aliyuncs.com/hukanfa/${pName}:${buildNumber}"
# version对应的包名称，非0值表示需要回滚
if [ $pVersion -gt 0 -a $actionType == 'roolback' ];thenimageName="registry-vpc.cn-guangzhou.aliyuncs.com/hukanfa/${pName}:${pVersion}"
fi# 检查目录是否存在的函数，如果目录不存在则创建
checkDirExit(){if [ -d $1 ];thenecho "$1目录存在"else mkdir -p $1echo "$1 目录不存在，已创建"fi
}# 判断命令执行状态
function checkStatus(){if [ $? -ne 0 ];thenecho "执行异常退出，请核查"exit 1elseecho "执行成功"fi
}#判断是部署还是回滚操作
if [ $actionType == 'deploy' -a  $pVersion -eq 0 ];thencp -ar $fontTar ./checkStatusDOCKER_BUILDKIT=1 docker build -t $imageName .checkStatusdocker push $imageNamecheckStatus
elif [ $actionType == 'roolback' -a  $pVersion -gt 0 ];thenecho "本次将执行回滚操作，镜像版本为：$imageName"
elseecho "部署动作或部署版本值有误，请检查"exit 1
fi

7 deploy.sh

  • 操作如下

    • 脚本内容
    #!/bin/sh###【1】变量区
# 分支
envType=$1
# 构建ID
buildNumber=$2
# 项目名称
pName=$3
# 回滚版本号
pVersion=$4
# 部署动作类型
actionType=$5
# 定义镜像名称
imageName="registry-vpc.cn-guangzhou.aliyuncs.com/hukanfa/${pName}:${buildNumber}"
# version对应的包名称，非0值表示需要回滚
if [ $pVersion -gt 0 -a $actionType == 'roolback' ];thenimageName="registry-vpc.cn-guangzhou.aliyuncs.com/hukanfa/${pName}:${pVersion}"
fi# 部署的机器
targetHost=(192.168.26.22)
# 远程用户名称
remoteUser="hukanfa"
# 远程demo目录
remoteScriptsDir="newBackendItem/$pName"
# 项目远程运行目录
remoteItemDir="/data/${pName}"###【2】函数区
# 判断命令执行状态
function checkCmdStatus(){if [ $? -ne 0 ];thenecho "${1}执行异常退出，请核查"exit 1fi
}###【3】逻辑区
for i in ${targetHost[@]} ; do# 先执行检测脚本，判断对应的远程目录是否存在ssh -l $remoteUser $i "cd ~ && if [ -d "${remoteScriptsDir}" ];then echo "${remoteScriptsDir} 存在"; else mkdir -p ${remoteScriptsDir} && echo "${remoteScriptsDir} 不存在已创建"; fi"checkCmdStatus "远程目录检测"echo "开始调用远程脚本执行部署操作"# 执行远程脚本，传递本次构建的包名称ssh -l $remoteUser $i "/bin/bash ${remoteScriptsDir}/run.sh $pName $imageName $buildNumber $pVersion"
done

8 远程机脚本

  • 操作如下

    • 以下脚本或文件在远程机，路径：/home/hukanfa/newBackendItem/superset
    [hukanfa@hukanfa superset]$
docker-compose.yml  run.sh
    • run.sh
    #!/bin/bash# 接收传参
pName=$1
imageName=$2
buildNumber=$3
pVersion=$4# 项目远程运行目录
remoteItemDir="/data/${pName}"
scriptsDir="/home/hukanfa/newBackendItem/${pName}"
backupDir="/data/${pName}/bak"
cTime=`date +'%Y%m%d%H%M%S'`
dfile="docker-compose.yml"
# 前端压缩包文件名称
fronPack="superset_static_3_1_1.tar.gz"
# 定义服务运行端口,需和docker-compose.yml中映射的一致
srvPort=8088
# 定义服务状态,默认2  运行中 1  
srvStatus=2# 判断命令执行状态
function checkStatus(){if [ $? -ne 0 ];thenecho "执行异常退出，请核查"exit 1elseecho "执行成功"fi
}# 检查目录是否存在的函数，如果目录不存在则创建
checkDirExit(){if [ -d $1 ];thenecho "$1目录存在"else mkdir -p $1echo "$1 目录不存在，已创建"fi
}
checkDirExit "$backupDir"# 判断是否在运行，运行则先停掉，备份相关文件
pidNum=`docker ps -a | grep superset | wc -l`
if [ $pidNum -ge 1 ];thencd $remoteItemDirdocker-compose downcheckStatussleep 3mv -f  $dfile ${backupDir}/${dfile}.bak${cTime}checkStatuscp -ar ${scriptsDir}/${dfile} ./checkStatussed -i 's#ImagesName#'"${imageName}"'#g' ./${dfile}checkStatus# 启动docker-compose up -dcheckStatussleep 2
elif [ $pidNum -eq 0 ];thencd $remoteItemDirif [ -f $dfile ];thenmv -f $dfile ${backupDir}/${dfile}.bak${cTime}checkStatusficp -ar ${scriptsDir}/${dfile} ./checkStatussed -i 's#ImagesName#'"${imageName}"'#g' ./${dfile}checkStatus# 启动docker-compose up -dcheckStatussleep 2
fifor (( i=1 ; i<=30 ; i++ ));do# 检测启动状态srvTag=`docker ps | grep superset | awk -F"(" '{print $2}' | awk -F")" '{print $1}' | awk '{print $1}'`if [ "$srvTag" == "healthy" ];thensrvStatus=1breakelseecho "###################  状态检查中，请稍等 ####################"docker ps | grep supersetsleep 5fi
done# 检查循环结束返回检查结果
if [ $srvStatus -eq 1 ];thenecho "本次服务部署运行正常"exit 0
elseecho "状态检查超过150s，本次服务部署异常，请核查!"exit 1
fi
    • docker-compose.yml 模板文件
    version: '3'
services:superset:image: ImagesNamecontainer_name: supersethostname: supersetrestart: alwaysports:- 8088:8088environment:- TZ=Asia/Shanghai

这篇关于开源工具专题-01 Superset的CICD流程构建的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/828457。

相关文章

通过Docker容器部署Python环境的全流程

通过Docker容器部署Python环境的全流程

《通过Docker容器部署Python环境的全流程》在现代化开发流程中,Docker因其轻量化、环境隔离和跨平台一致性的特性,已成为部署Python应用的标准工具,本文将详细演示如何通过Docker容... 目录引言一、docker与python的协同优势二、核心步骤详解三、进阶配置技巧四、生产环境最佳实践
阅读更多...
MyBatis分页查询实战案例完整流程

MyBatis分页查询实战案例完整流程

《MyBatis分页查询实战案例完整流程》MyBatis是一个强大的Java持久层框架,支持自定义SQL和高级映射,本案例以员工工资信息管理为例,详细讲解如何在IDEA中使用MyBatis结合Page... 目录1. MyBATis框架简介2. 分页查询原理与应用场景2.1 分页查询的基本原理2.1.1 分
阅读更多...
Three.js构建一个 3D 商品展示空间完整实战项目

Three.js构建一个 3D 商品展示空间完整实战项目

《Three.js构建一个3D商品展示空间完整实战项目》Three.js是一个强大的JavaScript库,专用于在Web浏览器中创建3D图形,：本文主要介绍Three.js构建一个3D商品展... 目录引言项目核心技术1. 项目架构与资源组织2. 多模型切换、交互热点绑定3. 移动端适配与帧率优化4. 可
阅读更多...
redis-sentinel基础概念及部署流程

redis-sentinel基础概念及部署流程

《redis-sentinel基础概念及部署流程》RedisSentinel是Redis的高可用解决方案,通过监控主从节点、自动故障转移、通知机制及配置提供,实现集群故障恢复与服务持续可用,核心组件包... 目录一. 引言二. 核心功能三. 核心组件四. 故障转移流程五. 服务部署六. sentinel部署
阅读更多...
SpringBoot集成XXL-JOB实现任务管理全流程

SpringBoot集成XXL-JOB实现任务管理全流程

《SpringBoot集成XXL-JOB实现任务管理全流程》XXL-JOB是一款轻量级分布式任务调度平台,功能丰富、界面简洁、易于扩展,本文介绍如何通过SpringBoot项目,使用RestTempl... 目录一、前言二、项目结构简述三、Maven 依赖四、Controller 代码详解五、Service
阅读更多...
Python实战之SEO优化自动化工具开发指南

Python实战之SEO优化自动化工具开发指南

《Python实战之SEO优化自动化工具开发指南》在数字化营销时代,搜索引擎优化（SEO）已成为网站获取流量的重要手段,本文将带您使用Python开发一套完整的SEO自动化工具,需要的可以了解下... 目录前言项目概述技术栈选择核心模块实现1. 关键词研究模块2. 网站技术seo检测模块3. 内容优化分析模
阅读更多...
Python利用PySpark和Kafka实现流处理引擎构建指南

Python利用PySpark和Kafka实现流处理引擎构建指南

《Python利用PySpark和Kafka实现流处理引擎构建指南》本文将深入解剖基于Python的实时处理黄金组合：Kafka（分布式消息队列）与PySpark（分布式计算引擎）的化学反应,并构建一... 目录引言：数据洪流时代的生存法则第一章 Kafka：数据世界的中央神经系统消息引擎核心设计哲学高吞吐
阅读更多...
Springboot项目构建时各种依赖详细介绍与依赖关系说明详解

Springboot项目构建时各种依赖详细介绍与依赖关系说明详解

《Springboot项目构建时各种依赖详细介绍与依赖关系说明详解》SpringBoot通过spring-boot-dependencies统一依赖版本管理,spring-boot-starter-w... 目录一、spring-boot-dependencies1.简介2. 内容概览3.核心内容结构4.
阅读更多...
MySQL 临时表与复制表操作全流程案例

MySQL 临时表与复制表操作全流程案例

《MySQL临时表与复制表操作全流程案例》本文介绍MySQL临时表与复制表的区别与使用,涵盖生命周期、存储机制、操作限制、创建方法及常见问题,本文结合实例代码给大家介绍的非常详细,感兴趣的朋友跟随小... 目录一、mysql 临时表（一）核心特性拓展（二）操作全流程案例1. 复杂查询中的临时表应用2. 临时
阅读更多...
Go语言使用net/http构建一个RESTful API的示例代码

Go语言使用net/http构建一个RESTful API的示例代码

《Go语言使用net/http构建一个RESTfulAPI的示例代码》Go的标准库net/http提供了构建Web服务所需的强大功能,虽然众多第三方框架（如Gin、Echo）已经封装了很多功能,但... 目录引言一、什么是 RESTful API？二、实战目标：用户信息管理 API三、代码实现1. 用户数据
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2