Jenkins自动化部署javadoc到web站点 - PetterLiu

公告

Jenkins是一个开源软件项目，是基于Java开发的一种持续集成工具，用于监控持续重复的工作，旨在提供一个开放易用的软件平台，使软件项目可以进行持续集成。今天我们使用Jenkins配置发布与部署Javadoc。
关于Javadoc编写事项请参考官方。

maven工程配置

使用maven-javadoc-plugin, pom.xml配置参考

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.1</version>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
                <encoding>utf8</encoding>
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.2.0</version>
            <configuration>
                <source>8</source>
                <charset>UTF-8</charset><!-- utf-8读取文件 -->
                <encoding>UTF-8</encoding><!-- utf-8进行编码代码 -->
                <docencoding>UTF-8</docencoding><!-- utf-8进行编码文档 -->
            </configuration>
        </plugin>
    </plugins>
</build>

Jenkins配置

JDK配置

MAVEN插件

Git插件

Minio插件或minio cli

Maven配置

Jenkins中maven, 我们在Goals and options中填的是 clean test javadoc:javadoc

也可以使用pipeline , 如果您还清楚，请阅读jenkins官方blog.

Nginx配置文件

default.conf

配置文件很简单，基础配置，可按需要修改，现在配置nginx端口是8080

server {
     listen       8080;
     server_name localhost;

    location / {
         root   /usr/share/nginx/html;
         index index.html index.htm;
     }

     error_page   500 502 503 504 /50x.html;
     location = /50x.html {
         root   html;
     }
}

Dockerfile

把上面的配置文件复制到容器中对应的位置

FROM hub.c.163.com/library/nginx

MAINTAINER peter

RUN rm /etc/nginx/conf.d/default.conf

ADD default.conf /etc/nginx/conf.d/

COPY . /usr/share/nginx/html/

Shell脚本

此处我们在服务器上提前放置了文件，进行复制到使用，Docker容器部署

#生成git commit version
cd /data/appdata/jenkins_home/workspace/c2-commons/target/site/apidocs/
echo $GIT_COMMIT > currentversion.html
#准备Dockerfile与 nginx的配置文件
cp /data/appdata/jenkins_home/workspace/ying-ji-pc-web-testing/docker/default.conf /data/appdata/jenkins_home/workspace/c2-commons/target/site/apidocs/default.conf
cp /data/appdata/jenkins_home/workspace/ying-ji-pc-web-testing/docker/Dockerfile /data/appdata/jenkins_home/workspace/c2-commons/target/site/apidocs/Dockerfile
#容器名称
containername=c2-commons-api-doc
if [ "$(docker ps -q -f name=$containername)" ]; then
docker stop $containername
if [ "$(docker ps -aq -f status=exited -f name=$containername)" ]; then
# cleanup
docker rm $containername
fi
fi
if [ "$(docker ps -aq -f status=exited -f name=$containername)" ]; then
# cleanup
docker rm $containername
fi
[ -z $(docker images -q $containername) ] || docker rmi $containername
docker build -t $containername .
#可定义端口
docker run -d -p 30001:8080 -m='1g' --name $containername $containername

如下图，生产环境不能使用root账户部署，需要单独新建账户与配置权限

最终Docker部署效果

然后访问URL，可以看到HTML已经部署于nginx服务器运行于docker容器上

http://172.24.1.62:30001/

部署到Minio/S3的公共桶

minio版本

"architecture": "x86_64",
"build-date": "2021-10-26T13:03:06.167238",
"com.redhat.build-host": "cpt-1006.osbs.prod.upshift.rdu2.redhat.com",
"com.redhat.component": "ubi8-minimal-container",
"com.redhat.license_terms": "https://www.redhat.com/en/about/red-hat-end-user-license-agreements#UBI",
"description": "MinIO object storage is fundamentally different. Designed for performance and the S3 API, it is 100% open-source. MinIO is ideal for large, private cloud environments with stringent security requirements and delivers mission-critical availability across a diverse range of workloads.",
"distribution-scope": "public",
"io.k8s.description": "The Universal Base Image Minimal is a stripped down image that uses microdnf as a package manager. This base image is freely redistributable, but Red Hat only supports Red Hat technologies through subscriptions for Red Hat products. This image is maintained by Red Hat and updated regularly.",
"io.k8s.display-name": "Red Hat Universal Base Image 8 Minimal",
"io.openshift.expose-services": "",
"io.openshift.tags": "minimal rhel8",
"maintainer": "MinIO Inc <dev@min.io>",
"name": "MinIO",
"release": "RELEASE.2022-01-04T07-41-07Z",
"summary": "MinIO is a High Performance Object Storage, API compatible with Amazon S3 cloud storage service.",
"url": "https://access.redhat.com/containers/#/registry.access.redhat.com/ubi8-minimal/images/8.4-212",
"vcs-ref": "7256039d3c371a38cf13906dcf5688c19700c73b",
"vcs-type": "git",
"vendor": "MinIO Inc <dev@min.io>",
"version": "RELEASE.2022-01-04T07-41-07Z"

Docker 命令部署Minio

docker run --net=host -p 9001:9000 -p 9999:9999 --name minio -d --restart=always -e "MINIO_ACCESS_KEY=minioadmin" -e "MINIO_SECRET_KEY=2vw22vasdfswe22sl" -v /data/appdata/minio/data:/data -v /data/appdata/minio/config:/root/.minio minio/minio server /data --console-address ":9999" -address ":9001"

桶设置

名称：publichtml

Access Policy: Public

把javadoc生成html部署到S3存储中，可以公开访问

Minio示例自动上传完成后结果截图

Jenkins 配置发布文件到Minio

这是使用插件，可以使用Minio Cli 更新灵活的上传文件

Javadoc的部署到S3后效果

http://172.24.1.62:9001/publichtml/apidocs/index.html

单独的HTML站点可以部署到S3的公共桶效果

http://172.24.1.62:9001/publichtml/index.html今天先到这儿，希望对云原生，技术领导力，企业管理，系统架构设计与评估，团队管理, 项目管理, 产品管理，团队建设有参考作用 , 您可能感兴趣的文章:
领导人怎样带领好团队
 构建创业公司突击小团队
 国际化环境下系统架构演化
 微服务架构设计
 视频直播平台的系统架构演化
 微服务与Docker介绍
 Docker与CI持续集成/CD
互联网电商购物车架构演变案例
 互联网业务场景下消息队列架构
 互联网高效研发团队管理演进之一
 消息系统架构设计演进
 互联网电商搜索架构演化之一
 企业信息化与软件工程的迷思
 企业项目化管理介绍
 软件项目成功之要素
 人际沟通风格介绍一
 精益IT组织与分享式领导
 学习型组织与企业
 企业创新文化与等级观念
 组织目标与个人目标
 初创公司人才招聘与管理
 人才公司环境与企业文化
 企业文化、团队文化与知识共享
 高效能的团队建设
 项目管理沟通计划
 构建高效的研发与自动化运维
某大型电商云平台实践
互联网数据库架构设计思路
IT基础架构规划方案一(网络系统规划)
餐饮行业解决方案之客户分析流程
餐饮行业解决方案之采购战略制定与实施流程
餐饮行业解决方案之业务设计流程
供应链需求调研CheckList
企业应用之性能实时度量系统演变
Openshift与Kubernetes的区别

如有想了解更多软件设计与架构, 系统IT,企业信息化, 团队管理资讯，请关注我的微信订阅号：

作者：Petter Liu
出处：http://www.cnblogs.com/wintersun/
本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。该文章也同时发布在我的独立博客中-Petter Liu Blog。

posted on 2023-02-05 09:06 PetterLiu 阅读(291) 评论(0) 编辑收藏举报

刷新页面返回顶部