Helm

• 安装
• Cheatsheet
  • 基本概念/上下文
  • 图表管理
  • 安装和卸载应用
  • 执行应用升级和回滚
  • 列出、添加、删除和更新仓库
  • Helm 发布监控
  • 下载发布信息
  • 插件管理

安装

Debian/Ubuntu：

curl https://baltocdn.com/helm/signing.asc | gpg --dearmor | sudo tee /usr/share/keyrings/helm.gpg > /dev/null
sudo apt-get install apt-transport-https --yes
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/helm.gpg] https://baltocdn.com/helm/stable/debian/ all main" | sudo tee /etc/apt/sources.list.d/helm-stable-debian.list
sudo apt-get update
sudo apt-get install helm

Windows：

winget install Helm.Helm

Cheatsheet

基本概念/上下文

Chart：

• 如果已拉取并解压，则为图表名称。
• 如果已添加仓库但未拉取，则为 <repo_name>/<chart_name>。
• 图表的 URL/绝对路径。

Name：

• 您要为当前 Helm 图表安装指定的名称。

Release：

• 您分配给安装实例的名称。

Revision：

• 来自 Helm history 命令的值。

Repo-name：

• 仓库的名称。

DIR：

• 目录名称/路径。

图表管理

helm create <name>                      # 创建图表目录以及图表中使用的常见文件和目录。
helm package <chart-path>               # 将图表打包成版本化的图表存档文件。
helm lint <chart>                       # 运行测试以检查图表并识别可能的问题。
helm show all <chart>                   # 检查图表并列出其内容。
helm show values <chart>                # 显示 values.yaml 文件的内容。
helm pull <chart>                       # 下载/拉取图表。
helm pull <chart> --untar=true          # 如果设置为 true，将在下载后解压图表。
helm pull <chart> --verify              # 使用前验证包。
helm pull <chart> --version <number>    # 默认使用最新版本，指定图表版本的版本约束。
helm dependency list <chart>            # 显示图表的依赖列表。

安装和卸载应用

helm install <name> <chart>                           # 使用名称安装图表。
helm install <name> <chart> --namespace <namespace>   # 在特定命名空间中安装图表。
helm install <name> <chart> --set key1=val1,key2=val2 # 在命令行上设置值（可以指定多个或用逗号分隔）。
helm install <name> <chart> --values <yaml-file/url>  # 使用指定的值安装图表。
helm install <name> <chart> --dry-run --debug         # 运行测试安装以验证图表。
helm install <name> <chart> --verify                  # 使用前验证包。
helm install <name> <chart> --dependency-update       # 如果依赖缺失，在安装图表前更新依赖。
helm uninstall <name>                                 # 卸载发布。

执行应用升级和回滚

helm upgrade <release> <chart>                            # 升级发布。
helm upgrade <release> <chart> --atomic                   # 如果设置，在升级失败时回滚更改。
helm upgrade <release> <chart> --dependency-update        # 如果依赖缺失，在安装图表前更新依赖。
helm upgrade <release> <chart> --version <version_number> # 指定图表版本的版本约束。
helm upgrade <release> <chart> --values                   # 在 YAML 文件或 URL 中指定值（可以指定多个）。
helm upgrade <release> <chart> --set key1=val1,key2=val2  # 在命令行上设置值（可以指定多个或用逗号分隔）。
helm upgrade <release> <chart> --force                    # 通过替换策略强制更新资源。
helm rollback <release> <revision>                        # 将发布回滚到特定修订版。
helm rollback <release> <revision> --cleanup-on-fail      # 当回滚失败时，允许删除在此回滚中创建的新资源。

列出、添加、删除和更新仓库

helm repo add <repo-name> <url>   # 从互联网添加仓库。
helm repo list                    # 列出添加的图表仓库。
helm repo update                  # 从图表仓库本地更新可用图表的信息。
helm repo remove <repo_name>      # 删除一个或多个图表仓库。
helm repo index <DIR>             # 读取当前目录并基于找到的图表生成索引文件。
helm repo index <DIR> --merge     # 将生成的索引与现有索引文件合并。
helm search repo <keyword>        # 在仓库中搜索图表的关键词。
helm search hub <keyword>         # 在 Artifact Hub 或您自己的 hub 实例中搜索图表。

Helm 发布监控

helm list                       # 列出指定命名空间的所有发布，如果未指定命名空间，则使用当前命名空间上下文。
helm list --all                 # 显示所有发布而不应用任何过滤，可以使用 -a。
helm list --all-namespaces      # 列出所有命名空间的发布，可以使用 -A。
helm list -l key1=value1,key2=value2 # 选择器（标签查询）以过滤，支持 '=', '==', 和 '!='。
helm list --date                # 按发布日期排序。
helm list --deployed            # 显示已部署的发布。如果未指定其他，则将自动启用此项。
helm list --pending             # 显示待处理的发布。
helm list --failed              # 显示失败的发布。
helm list --uninstalled         # 显示已卸载的发布（如果使用了 'helm uninstall --keep-history'）。
helm list --superseded          # 显示已取代的发布。
helm list -o yaml               # 以指定格式打印输出。允许值：table, json, yaml（默认 table）。
helm status <release>           # 显示命名发布的状态。
helm status <release> --revision <number>   # 如果设置，显示命名发布及其修订的状态。
helm history <release>          # 给定发布的修订历史。
helm env                        # 打印 Helm 使用的所有环境信息。

下载发布信息

helm get all <release>      # 关于给定发布的注释、钩子、提供的值和生成的清单文件的可读信息集合。
helm get hooks <release>    # 下载给定发布的钩子。钩子以 YAML 格式化，并由 YAML '---\n' 分隔符分隔。
helm get manifest <release> # 清单是从此发布的图表生成的 Kubernetes 资源的 YAML 编码表示。如果图表依赖于其他图表，这些资源也将包含在清单中。
helm get notes <release>    # 显示命名发布的图表提供的注释。
helm get values <release>   # 下载给定发布的值文件。使用 -o 格式化输出。

插件管理

helm plugin install <path/url>      # 安装插件。
helm plugin list                    # 查看所有已安装插件的列表。
helm plugin update <plugin>         # 更新插件。
helm plugin uninstall <plugin>      # 卸载插件。