使用Helm在OpenShift上部署应用

ゝ一世哀愁。 2022-12-27 04:44 357阅读 0赞

### 文章目录 ###

*  使用Helm在OpenShift上部署应用
 *   *  前言
     *  安装Helm
     *  创建Helm chart
     *  Helm chart目录结构
     *  准备Helm template文件
     *  在\`\_helpers.tpl\` 中编写函数
     *   *  \`metadata.labels\`
         *  \`selector\`
     *  在\`values.yaml\`中定义变量
     *  用变量替换template文件中的值
     *  调试template
     *  使用Helm部署应用
     *  测试应用
     *  使用Helm升级或卸载应用（可选）
     *  参考文档

# 使用Helm在OpenShift上部署应用 #

## 前言 ##

[在OpenShift上导出应用YAML配置并重新部署应用][OpenShift_YAML] 一文中描述了如何从OpenShift中导出YAML文件，并重新部署。本文接着介绍，如何根据OpenShift的导出YAML文件来准备Helm chart，并用Helm在OpenShift上部署应用。

使用Helm部署应用的优点包括：

*  集中管理配置文件中经常变化的部分
 *  可以在安装或升级时指定运行参数
 *  复杂的依赖管理（本文不涉及）

本文的Helm chart代码示例：

*  [https://github.com/cookcodeblog/spring-db-demo-deployment][https_github.com_cookcodeblog_spring-db-demo-deployment]

## 安装Helm ##

Helm 3只需要安装`helm`客户端命令工具。

在Mac OS上：

brew install helm

参见：

*  [https://helm.sh/docs/intro/install/][https_helm.sh_docs_intro_install]

## 创建Helm chart ##

创建一个名为`spring-db-demo-deployment`的新目录。

在该目录下创建`spring-db-demo`的Helm chart：

helm create spring-db-demo

## Helm chart目录结构 ##

`spring-db-demo`的Helm chart目录结构为：

spring-db-demo
    ├── Chart.yaml
    ├── charts
    ├── templates
    │   ├── NOTES.txt
    │   ├── _helpers.tpl
    │   ├── deployment.yaml
    │   ├── hpa.yaml
    │   ├── ingress.yaml
    │   ├── service.yaml
    │   ├── serviceaccount.yaml
    │   └── tests
    │       └── test-connection.yaml
    └── values.yaml

说明：

*  `spring-db-demo` Chart的名称和目录名同名
 *  `Chart.yaml` Chart信息配置文件
 *  `values.yaml` 实例化时用来替换模板文件中的占位符的值
 *  `templates/` Kuberentes YAML模板文件目录
    
     *  `*.yaml` Kubernetes YAML模板文件
     *  `_helpers.tpl` 子模板，定义函数
     *  `NOTES.txt` release notes, 运行`helm install`时的帮助说明
 *  `charts/` Chart所依赖的上游Chart目录

参见：

*  [https://helm.sh/docs/topics/charts/][https_helm.sh_docs_topics_charts]

## 准备Helm template文件 ##

删除`templates/`目录下的所有内容，除了`_helpers.tpl`。

参考[在OpenShift上导出应用YAML配置并重新部署应用][OpenShift_YAML] ，将从OpenShift上导出的YAML文件复制到`templates/`目录。

## 在`_helpers.tpl` 中编写函数 ##

在`_helpers.tpl`中编写公共函数，用来替换YAML文件中的`metadata.labels`和`selector`。

### `metadata.labels` ###

`metadata.labels`内容：

app: spring-db-demo
    app.kubernetes.io/component: spring-db-demo
    app.kubernetes.io/instance: spring-db-demo
    app.kubernetes.io/name: java
    app.kubernetes.io/part-of: spring-db-demo-app
    app.openshift.io/runtime: java
    app.openshift.io/runtime-version: openjdk-8-el7

`metadata.labels`对应的函数`spring-db-demo.app.labels`：

{ { /* spring-db-demo app labels */}}
    { { - define "spring-db-demo.app.labels" -}}
    app: { {  include "spring-db-demo.name" . }}
    app.kubernetes.io/component: { {  include "spring-db-demo.name" . }}
    app.kubernetes.io/instance: { {  include "spring-db-demo.name" . }}
    app.kubernetes.io/name: java
    app.kubernetes.io/part-of: { {  include "spring-db-demo.name" . }}-app
    app.openshift.io/runtime: java
    app.openshift.io/runtime-version: openjdk-8-el7
    { { - end }}

### `selector` ###

`selector`内容：

app: spring-db-demo
    deploymentconfig: spring-db-demo

`selector`对应的函数`spring-db-demo.app.selectorLabels`：

{ { /* spring-db-demo app labels */}}
    { { - define "spring-db-demo.app.selectorLabels" -}}
    app: { {  include "spring-db-demo.name" . }}
    deploymentconfig: { {  include "spring-db-demo.name" . }}
    { { - end }}

参见：

*  [Helm templates 中的语法][Helm templates]

## 在`values.yaml`中定义变量 ##

示例：

git:
      ref: main
      uri: https://github.com/cookcodeblog/spring-db-demo.git
    
    image:
      name: spring-db-demo
      version: latest
    
    container:
      name: spring-db-demo
    
    env:
      SPRING_PROFILES_ACTIVE: test
    
    replicas: 2

在values.yaml中统一管理经常变化的属性或可能需要在安装或升级时指定的参数。

values.yaml中的属性名称中建议和YAML文件中的名称保持一致。不建议包含特殊字符（比如`.`或`/`），也不建议层次太深。

## 用变量替换template文件中的值 ##

参考[spring-db-demo-deployment][https_github.com_cookcodeblog_spring-db-demo-deployment] 替换`templates/`目录下的YAML文件的值为变量。

*  用`{ { include "spring-db-demo.fullname" . }}` 替换`metadata.name`的值。
 *  用`_helpers.tpl`中自定义函数替换YAML文件中的`metadata.labels`和`selector`的值。
 *  用values.yaml中的变量替换YAML文件中的相应的属性的值。

## 调试template ##

在`spring-db-demo-deployment`目录下：

# 语法检查
    helm lint spring-db-demo
    
    # 检查渲染后的YAML文件内容
    helm template --debug spring-db-demo ./spring-db-demo > spring-db-demo.yaml
    
    # 用 --dry-run 来Dry run
    helm install --dry-run --debug spring-db-demo ./spring-db-demo

参见：

*  [https://helm.sh/docs/chart\_template\_guide/debugging/][https_helm.sh_docs_chart_template_guide_debugging]

## 使用Helm部署应用 ##

# 创建一个新OpenShift项目
    oc new-project william-helm-spring
    
    # 安装
    helm install spring-db-demo ./spring-db-demo
    helm install --debug spring-db-demo ./spring-db-demo # 加上 --debug 打印详细日志信息
    helm install --debug spring-db-demo ./spring-db-demo --set replicas=3 # --set field=value 指定安装时参数

## 测试应用 ##

打开OpenShift web console，查看重新部署后的应用程序和数据库是否工作正常。

参考[从零开始在OpenShift上开发和部署Spring Boot应用][OpenShift_Spring Boot]，在数据库上创建表结构和初始化数据，然后进行测试。

## 使用Helm升级或卸载应用（可选） ##

# 升级
    helm upgrade spring-db-demo ./spring-db-demo
    helm upgrade --debug spring-db-demo ./spring-db-demo
    helm upgrade --debug spring-db-demo ./spring-db-demo --set replicas=3 
    
    # 卸载
    helm uninstall spring-db-demo

## 参考文档 ##

*  [Helm charts examples][https_helm.sh_docs_topics_charts]
 *  [Helm 函数列表][Helm]
 *  [Helm 内建对象][Helm 1]
 *  [Helm templates 中的语法][Helm templates]
 *  [Helm from basics to advanced][]
 *  [Using Red Hat OpenShift image streams with Kubernetes deployments][]
 *  [Getting started with Helm 3 on OpenShift Container Platform][]
 *  [Getting Started with Helm 3 on OpenShift][]

[OpenShift_YAML]: https://cookcode.blog.csdn.net/article/details/110817206
[https_github.com_cookcodeblog_spring-db-demo-deployment]: https://github.com/cookcodeblog/spring-db-demo-deployment
[https_helm.sh_docs_intro_install]: https://helm.sh/docs/intro/install/
[https_helm.sh_docs_topics_charts]: https://helm.sh/docs/topics/charts/
[Helm templates]: https://www.cnblogs.com/klvchen/p/13606311.html
[https_helm.sh_docs_chart_template_guide_debugging]: https://helm.sh/docs/chart_template_guide/debugging/
[OpenShift_Spring Boot]: https://cookcode.blog.csdn.net/article/details/110259521
[Helm]: https://helm.sh/docs/chart_template_guide/function_list/
[Helm 1]: https://helm.sh/docs/chart_template_guide/builtin_objects/
[Helm from basics to advanced]: https://banzaicloud.com/blog/creating-helm-charts/
[Using Red Hat OpenShift image streams with Kubernetes deployments]: https://developers.redhat.com/blog/2019/09/20/using-red-hat-openshift-image-streams-with-kubernetes-deployments/
[Getting started with Helm 3 on OpenShift Container Platform]: https://docs.openshift.com/container-platform/4.6/cli_reference/helm_cli/getting-started-with-helm-on-openshift-container-platform.html
[Getting Started with Helm 3 on OpenShift]: https://learn.openshift.com/developing-on-openshift/helm/