Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yaoyaoio/project-devops-template

多种语言的流水线模版 # kubesphere devops jenkinsfile cicd
https://github.com/yaoyaoio/project-devops-template

cicd devops kubernetes kubeshpere

Last synced: about 1 month ago
JSON representation

多种语言的流水线模版 # kubesphere devops jenkinsfile cicd

Host: GitHub
URL: https://github.com/yaoyaoio/project-devops-template
Owner: yaoyaoio
License: apache-2.0
Created: 2022-11-09T09:28:49.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2022-11-25T13:42:16.000Z (about 2 years ago)
Last Synced: 2023-03-21T20:57:50.066Z (almost 2 years ago)
Topics: cicd, devops, kubernetes, kubeshpere
Language: Vue
Homepage:
Size: 6.08 MB
Stars: 5
Watchers: 1
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.MD
- License: LICENSE

Awesome Lists containing this project

README

        # project-devops-template

多种语言的 CICD 模版 流水线项目

## 介绍

本项目主要提供不同语言的容器化构建 基于 Kubesphere 流水线示例模版，以及一些常用构建工具的使用方法。

如果只想查看某个语言的容器化构建示例，可以直接查看对应的目录。

## 变量

* $APP_NAME 项目名称

* $VERSION 版本号

* $IMAGE_REGISTRY 容器镜像仓库地址

* $IMAGE_NAMESPACE 容器仓库命名空间/组织空间 不同云厂商有不同的命名方式

* $IMAGE_USER 容器仓库用户名

* $IMAGE_PASSWD 容器仓库密码

* $IMAGE_NAME 镜像名称 生成规则` "${IMAGE_REGISTRY}/${IMAGE_NAMESPACE}/${APP_NAME}:${VERSION}"`

* $BRANCH 分支名称

* $GIT_URL 代码仓库地址

* $COMMIT_ID 代码提交ID 使用 `git rev-parse --short HEAD` 获取

## 版本号

默认我使用 `$COMMIT_ID` 作为版本号，如果你需要使用其他版本号，可以在流水线中修改 `$VERSION`，然后在构建步骤中使用`$VERSION`

.

**例如**：

* $COMMIT_ID 代码提交ID 使用 `git rev-parse --short HEAD` 获取

* $GIT_TAG 代码标签

* $GIT_BRANCH 代码分支

修改方式 修改每个项目的 `Jenkinsfile` 文件，修改 `$VERSION` 变量的值:

```groovy

steps {

    script {

        env.COMMIT_ID = "${sh(script: 'git rev-parse --short HEAD', returnStdout: true).trim()}"

        env.VERSION = "${env.COMMIT_ID}"

        env.IMAGE_NAME = "${env.IMAGE_REGISTRY}/${env.IMAGE_NAMESPACE}/${env.APP_NAME}:${env.VERSION}"

    }

}

```

## 凭证 (Kubernetes Secret)

### KUBECONFIG 凭证

KUBECONFIG 凭证用于连接操作 Kubernetes 集群，需要在流水线中配置。

可以在 Kubepshere 工作台 -> 企业空间 -> {你的空间} -> Devops 项目--> {项目名称} -> 凭证 -> 创建凭证 ->

选择类型为 `KUBECONFIG` 名称为 `kubeconfig-credentials`

![图片所示](./assets/ks-create-secret-kubeconfig.png)

### 镜像仓库凭证

镜像仓库凭证用于推送镜像到镜像仓库，需要在流水线中配置。

可以在 Kubepshere 工作台 -> 企业空间 -> {你的空间} -> Devops 项目--> {项目名称} -> 凭证 -> 创建凭证 ->

选择类型为 `用户名和密码（账户凭证）` 名称为 `image-registry-credentials`

![图片所示](./assets/ks-create-secret-image.png)

### 代码仓库凭证

代码仓库凭证用于拉取代码，需要在流水线中配置。

可以在 Kubepshere 工作台 -> 企业空间 -> {你的空间} -> Devops 项目--> {项目名称} -> 凭证 -> 创建凭证 ->

选择类型为 `用户名和密码（账户凭证）` 名称为 `git-credentials`

![图片所示](./assets/ks-create-secret-git.png)

以上配置好之后 可以在流水线中使用对应凭证。

## 创建流水线 (Jenkinsfile)

每个项目下都有一个 `Jenkinsfile` 文件，这个文件是流水线的配置文件，可以在流水线中配置流水线的各个步骤。

在 Kubesphere 中 可以直接使用 Jenkinsfile 来创建流水线。也可以在 kubeSphere 中可视化创建流水线 最后也会生成 Jenkinsfile

文件。

以 go-sample 项目为例，

### 第一步 创建流水线

![1](./assets/ks-create-project-1.png)

### 第二步 填写构建参数

![2](./assets/ks-create-project-2.png)

### 第三步 选择流水线配置文件

这个地方我们选择 编写 `Jenkinsfile` 文件 将{project}下的 `Jenkinsfile` 文件复制到这里

![3](./assets/ks-create-project-3.png)

## Jenkinsfile

#### 第一步 拉取代码（SCM）

```groovy

stage('拉取代码') {

    agent none

    steps {

        git(url: '仓库地址', credentialsId: 'git-credentials', changelog: true, poll: false, branch: '$BRANCH')

        script {

            env.COMMIT_ID = "${sh(script: 'git rev-parse --short HEAD', returnStdout: true).trim()}"

            env.VERSION = "${env.COMMIT_ID}"

            env.IMAGE_NAME = "${env.IMAGE_REGISTRY}/${env.IMAGE_NAMESPACE}/${env.APP_NAME}:${env.VERSION}"

        }

    }

}

```

* {仓库地址} 我默认是写死在jenkinsfile里面的，也可以在构建参数中定义`$GIT_URL`及默认值，然后在这里使用`$GIT_URL`来获取

* $BRANCH 在构建参数中定义及默认值

* git-credentials 为代码仓库凭证 名称为 `git-credentials` 需要提前创建 看上面凭证章节

* $COMMIT_ID 代码提交ID 使用 `git rev-parse --short HEAD` 获取 默认在`Jenkinsfile`中定义

* $VERSION 版本号 默认在`Jenkinsfile`中定义 为`$COMMIT_ID` 也可以在构建参数中定义`$VERSION`

  及默认值，然后在这里使用`$VERSION`来获取 或者自己根据需求定义

* $IMAGE_NAME 镜像名称 默认在`Jenkinsfile`中定义

* $IMAGE_REGISTRY 镜像仓库地址 在构建参数中定义及默认值

* $IMAGE_NAMESPACE 镜像仓库命名空间 在构建参数中定义及默认值

* $APP_NAME 应用名称 在构建参数中定义及默认值

#### 第二步 构建镜像

默认使用容器进行多阶段构建

```groovy

stage('编译项目并构建镜像') {

    agent none

    steps {

        container('base') {

            withCredentials([usernamePassword(credentialsId: 'image-registry-credentials', passwordVariable: 'IMAGE_PASSWD', usernameVariable: 'IMAGE_USER',)]) {

                sh 'echo $IMAGE_PASSWD | docker login $IMAGE_REGISTRY -u $IMAGE_USER --password-stdin'

            }

            sh """docker build -t $APP_NAME:$VERSION -f Dockerfile-builder ."""

        }

    }

}

```

* image-registry-credentials 为镜像仓库凭证 名称为 `image-registry-credentials` 需要提前创建 看上面凭证章节

* $IMAGE_PASSWD 镜像仓库密码 来自于凭证 `image-registry-credentials`

* $IMAGE_USER 镜像仓库用户名 来自于凭证 `image-registry-credentials`

#### 第三步 推送镜像

```groovy

stage('推送镜像') {

    agent none

    steps {

        container('base') {

            sh """docker tag $APP_NAME:$VERSION $IMAGE_NAME"""

            sh """docker push $IMAGE_NAME"""

        }

    }

}

```

### 第四步 部署到 kubernetes 集群

```groovy

stage('部署到集群') {

    agent none

    steps {

        container('base') {

            withCredentials([kubeconfigContent(credentialsId: 'kubeconfig-credentials', variable: 'KUBECONFIG',)]) {

                sh 'envsubst < deploy/prod/deployment.yaml | kubectl apply -f -'

                sh 'envsubst < deploy/prod/service.yaml | kubectl apply -f -'

            }

        }

    }

}

```

* kubeconfig-credentials 为 kubernetes 集群凭证 名称为 `kubeconfig-credentials` 需要提前创建 看上面凭证章节

* envsubst 命令可以读取 env 环境变量并且把变量替换到文件中