helm

一、helm简介

Helm是k8s下的包管理器，类似于Centos中使用的yum或者Python中的pip。能快速查找、下载和安装软件包。Helm由客户端组件helm和服务端组件Tiller组成, 能够将一组K8S资源打包统一管理, 是查找、共享和使用为Kubernetes构建的软件的最佳方式。

二、helm用途

在Kubernetes中部署应用，涉及到很多的Kubernetes manifests，eg：Deployment、Service、Secret、pv、pvc等，如果直接以本地yaml的方式来管理维护这些资源，当应用较多、环境很多的时候，是一件很头疼的事。总结起来，当我们在k8s中部署应用的使用，通常面临以下几个问题：
    1、如何统一管理、配置和更新这些分散的 k8s 的应用资源文件
    2、如何分发和复用一套应用模板
    3、如何将应用的一系列资源当做一个软件包管理
    4、当应用较多的时候、假如每个应用每个环境都预留一套单独的资源文件、改如何管理和维护

三、helm实践比较好的资源

# 1、helm指南
https://helm.sh/docs/intro/quickstart/
# 2、helm资源创建和卸载的顺序
https://github.com/helm/helm/blob/release-3.0/pkg/releaseutil/kind_sorter.go
# 3、helm内置对象
https://helm.sh/zh/docs/chart_template_guide/builtin_objects/
# 4、helm命名模版<注意include、template导入模版的区别>
https://helm.sh/zh/docs/chart_template_guide/named_templates/
include和template的区别：
Because template is an action, and not a function, there is no way to pass the output of a template call to other functions; the data is simply inserted inline.，To work around this case, Helm provides an alternative to template that will import the contents of a template into the present pipeline where it can be passed along to other functions in the pipeline.。
It is considered preferable to use include over template in Helm templates simply so that the output formatting can be handled better for YAML documents.
# 5、helm流程控制
https://helm.sh/docs/chart_template_guide/control_structures/#helm
# 6、helm、k8s版本兼容性
https://helm.sh/docs/topics/version_skew/
# 7、实践
https://github.com/bitnami/charts
https://github.com/bitnami/charts/tree/master/bitnami #  比较好的chart，尤其common可以参考

四、helm术语

# helm采用客户端/服务端框架，有如下组件组成
    1、chart：就是一个包，包含一个应用所有的k8s mainifest模板，类似于yum的rpm包
    2、helm cli：helm的客户端组件，它通过grpc api向tiller发送请求
    3、tiller：helm的服务端组件，在kubernetes集群上运行，负责解析客户端发送过来的chart，并根据chart中的定义，在k8s中创建相应的资源，tiller把release相关的信息存入k8s的configmap中，tiller也是kube-api打交道
    4、repository：用于发布和存储chart的仓库
    5、release：可以理解成chart的部署的一个实例。通过chart在k8s中部署的应用会产生一个唯一的release，即使是同一个chart，部署多次就会产生多个release。
# helm架构：
    1、heim：客户端，管理本地的chart仓库，管理chart，与tiller服务交互，发送chart，实例安装、查询、卸载
    2、tiller：服务端，接收helm发来的charts于config，合并生成release

五、helm的安装

# https://helm.sh/docs/intro/install/
https://github.com/helm/helm/releases

六、helm常用命令

# 1、帮助信息
helm --help
# 2、打包
helm package molbase-common/   
# 3、更新依赖
helm dependency update   <进入到有依赖需求的charts目录下>
# 4、上传包到仓库
helm nexus-push molbase-nexus molbase-common-1.20.2.tgz -u admin -p Molbase_nexus
注意：此处的nexus-push插件需要另外安装：helm plugin install --version master https://gitee.com/mirrors_sonatype-nexus-community/helm-nexus-push.git
# 5、搜索chart
helm search repo molbase-nexus/molbase-demo
# 6、获取release
helm list -n dev         
# 7、更新仓库
helm repo update             
# 8、卸载release
helm uninstall molbase-demo -n de
# 9 、添加仓库
helm repo add molbase-nexus http://192.168.13.180:30031/repository/molbase-helm --username admin --password Molbase_nexus

七、helm本地仓库的搭建和使用

Nexus Repository Manager 3.21+ 中已包含Helm格式。

helm私库

helm私库

# 后续我们可以添加私库、完成chart包的上传和下载、也可以直接使用
# 1、添加私库
helm repo add molbase-nexus http://192.168.13.180:30031/repository/molbase-helm --username admin --password Molbase_nexus
# 2、打包
helm package molbase-demo
# 3、上传到私库
helm nexus-push molbase-nexus molbase-demo-1.1.1.tgz -u admin -p Molbase_nexus
# 4、下载
helm pull molbase-nexus/molbase-demo
# 5、直接使用
helm upgrade --install molbase-demo molbase-nexus/molbase-demo -n dev --set image.tag="dev-12" --set containerPort=8080 --version=1.1.1 -f /root/k8s-helm/molbase-demo.yaml --wait --timeout 2m0s --dry-run --debug

八、生产实践

8.1、项目结构

[root@molk8s-master k8s-helm]# tree molbase-common/     <公用的common>
molbase-common/
├── Chart.yaml
├── README.md
├── templates
│   ├── _affinities.tpl
│   ├── _capabilities.tpl
│   ├── _errors.tpl
│   ├── _images.tpl
│   ├── _ingress.tpl
│   ├── _labels.tpl
│   ├── _names.tpl
│   ├── _secrets.tpl
│   ├── _storage.tpl
│   ├── _tplvalues.tpl
│   ├── _utils.tpl
│   ├── validations
│   │   ├── _cassandra.tpl
│   │   ├── _mariadb.tpl
│   │   ├── _mongodb.tpl
│   │   ├── _postgresql.tpl
│   │   ├── _redis.tpl
│   │   └── _validations.tpl
│   └── _warnings.tpl
└── values.yaml

2 directories, 21 files
[root@molk8s-master k8s-helm]# tree molbase-demo
molbase-demo
├── Chart.lock
├── charts                                                       // 该目录存放本项目依赖的chart
│   └── molbase-common-1.1.0.tgz
├── Chart.yaml                                               // 包含Chart的基本信息，版本、名称等
├── README.md
├── templates                                                // 目录下存放应用一系列 k8s 资源的 yaml 模板 
│   ├── deployment.yaml
│   ├── extra-list.yaml
│   ├── _helpers.tpl                                       // 一些可重用的模板片断，此文件中的定义在任何资源定义模板中可用
│   ├── hpa.yaml
│   ├── ingress.yaml
│   ├── NOTES.txt                                       // chart 部署后的帮助信息
│   ├── pdb.yaml
│   ├── pvc.yaml
│   ├── secrets.yaml
│   ├── serviceaccount.yaml
│   ├── svc.yaml
│   └── tls-secrets.yaml
└── values.yaml

2 directories, 17 files

8.2、文件内容

文件内容较多、可以从以下地址获取:
https://gitee.com/x-professor/helm.git

8.3、生产环境使用

[root@molk8s-master templates]# cat /root/k8s-helm/molbase-demo.yaml 
extraEnvVars:
  - name: "APP_ENV"
    value: "dev"

ingress:
  extraHosts: 
    - name: molbase-demo.molbase.org
      path: /

[root@molk8s-master k8s-helm]# helm upgrade --install molbase-demo molbase-nexus/molbase-demo -n dev --set image.tag="dev-12" --set containerPort=8080 --version=1.1.1 -f /root/k8s-helm/molbase-demo.yaml --wait --timeout 2m0s
Release "molbase-demo" does not exist. Installing it now.
NAME: molbase-demo
LAST DEPLOYED: Sun Mar 27 17:32:47 2022
NAMESPACE: dev
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
CHART NAME: molbase-demo
CHART VERSION: 1.1.1
APP VERSION: 1.1.1

** Please be patient while the chart is being deployed **

1. Get the molbase-demo URL indicated on the Ingress Rule and associate it to your cluster external IP:

   export CLUSTER_IP=$(minikube ip) # On Minikube. Use: `kubectl cluster-info` on others K8s clusters
   export HOSTNAME=$(kubectl get ingress --namespace dev molbase-demo -o jsonpath='{.spec.rules[0].host}')
   echo "molbase-demo URL: http://$HOSTNAME/"
   echo "$CLUSTER_IP  $HOSTNAME" | sudo tee -a /etc/hosts

2. Obtain the admin login credentials (only on first install)
kubectl logs --tail 100 -l app.kubernetes.io/instance=molbase-demo,app.kubernetes.io/name=molbase-demo --container molbase-demo

helm install后，站点结果访问