【笔记】Helm-3 主题-6 Chart仓库指南

Chart仓库指南

本节介绍如何创建和使用chart仓库。在高层级中,chart仓库是打包的chart存储和分享的位置。

社区的Helm chart仓位于 Artifact Hub ,欢迎加入。不过Helm也可以创建并运行您自己的chart仓库。该指南将介绍如何操作。

Artifact Hub

先决条件

先阅读 快速开始

阅读 Charts 文档

Helm | 快速入门指南

Helm | Chart

创建一个chart仓库

chart仓库是一个配置了index.yaml文件和一些已经打包chart的HTTP服务器。当您准备好分享chart时,最好的方法是将chart上传到chart仓库。

注意:从Helm 2.2.0开始,客户端支持对仓库进行SSL身份认证。其他身份验证协议可以通过插件提供。

由于chart仓库可以是任何服务于YAML和tar文件并响应GET请求的HTTP服务器,托管您自己的chart仓库时就有很多选择。比如可以使用Google Cloud Storage(GCS),Amazon S3,GitHub页面,甚至创建自己的web服务器。

chart仓库结构

chart仓库由chart包和包含了仓库中所有chart索引的特殊文件index.yaml。通常描述chart的index.yaml也托管在同一个服务器上作为 来源文件 。

Helm | Helm来源和完整性

比如:https://exmaple.com/charts仓库布局可能看起来像这样:

charts/
  |
  |- index.yaml
  |
  |- alpine-0.1.2.tgz
  |
  |- alpine-0.1.2.tgz.prov

在这个案例中,index文件包含了Alpine这一个chart的信息,并提供了下载地址:https://example.com/charts/alpine-0.1.2.tgz。

index.yaml文件不是必须和chart包放在同一个服务器上,但是这样是最方便的。

index文件

index.yaml文件是一个yaml格式的文件。包含了一些包的元信息,包括chart中chart.yaml文件的内容。一个合法的chart仓库必须有一个index文件,包含了chart仓库中每一个chart的信息。heml repo index命令会基于给定的包含chart包的本地目录生成一个index文件。

index文件类似于这样:

apiVersion: v1
entries:
  alpine:
    - created: 2016-10-06T16:23:20.499814565-06:00
      description: Deploy a basic Alpine Linux pod
      digest: 99c76e403d752c84ead610644d4b1c2f2b453a74b921f422b9dcb8a7c8b559cd
      home: https://helm.sh/helm
      name: alpine
      sources:
      - https://github.com/helm/helm
      urls:
      - https://technosophos.github.io/tscharts/alpine-0.2.0.tgz
      version: 0.2.0
    - created: 2016-10-06T16:23:20.499543808-06:00
      description: Deploy a basic Alpine Linux pod
      digest: 515c58e5f79d8b2913a10cb400ebb6fa9c77fe813287afbacf1a0b897cd78727
      home: https://helm.sh/helm
      name: alpine
      sources:
      - https://github.com/helm/helm
      urls:
      - https://technosophos.github.io/tscharts/alpine-0.1.0.tgz
      version: 0.1.0
  nginx:
    - created: 2016-10-06T16:23:20.499543808-06:00
      description: Create a basic nginx HTTP server
      digest: aaff4545f79d8b2913a10cb400ebb6fa9c77fe813287afbacf1a0b897cdffffff
      home: https://helm.sh/helm
      name: nginx
      sources:
      - https://github.com/helm/charts
      urls:
      - https://technosophos.github.io/tscharts/nginx-1.1.0.tgz
      version: 1.1.0
generated: 2016-10-06T16:23:20.499029981-06:00

托管chart仓库

这部分展示了几种提供chart仓库的方法

1、Google cloud存储

第一步是create your GCS bucket。我们会调用fantastic-charts。

然后使用editing the bucket permissions保证您的bucket是公开的。

插入这一行保证您的bucket是公开的。

恭喜,您现在准备好了一个提供chart的空GCS bucket!

您可以使用Google Cloud Storage命令行工具上传您的chart仓库,或者使用GCS的web页面。一个公共的GCS bucket可以通过简单的HTTPS地址访问:https://bucket-name.storage.googleapi.com/。

2、Cloudsmith

也可以使用Cloudsmith设置chart仓库。在 这里 阅读更多关于Cloudsmith配置chart仓库的内容。

Helm Chart Repository

3、JFrog Artifactory

同样,也可以使用JFrog Artifactory配置chart仓库。在 这里 阅读更多关于JFrog Artifactory配置chart仓库的内容。

4、GitHub页面示例

您可以用GitHub页面以类似的方式创建chart仓库。

GitHub允许您使用两种方式提供静态web页面:

通过docs/目录配置项目

通过特定的分支配置项目

我们将使用第二种方式,不过第一种方式也很简单。

第一步是创建您的gh-pages分支。您可以在本地创建:

$ git checkout -b gh-pages

或者在您的GitHub仓库通过web页面使用Branch按钮。

然后,您要保证您的gh-pages-branch设置为GitHub页面,点击您仓库的Settings并相信找到GitHub pages部分并设置如下:

默认Source一般设置为gh-pages branch。如果不是默认,把它选上。

如果想使用自定义域名使用custom domain。

然后确保勾选了Enforce HTTPS,这样提供chart时会使用HTTPS。

在这个配置中,您可以使用您的默认分支存储您的chart代码,并使用gh-pages branch作为chart仓库,比如:https://USEERNAM.github.io/REPONAME。TS Charts示例仓库可以访问https://technosophos.github.io/tscharts/。

https://github.com/technosophos/tscharts

如果您想使用GitHub页面托管chart仓库,请查看Chart发布操作。Chart发布操作是GitHub的操作流,可以将GitHub项目转换成自托管的Helm chart仓库,可以使用heml/chart-release CLI工具。

Helm | Chart发布操作用以自动化GitHub的页面Chart

https://github.com/helm/chart-releaser

5、普通web服务器

配置一个一般的服务器来提供Helm chart,您只需执行以下操作:

将index和chart放置在可提供服务的服务器目录中

确保index.yaml文件无需验证即可访问

确保yaml文件是正确的内容类型(text/yaml或text/x-yaml)

比如,如果您想在$WEBROOT/charts提供您的chart,要保证在web的root目录有一个charts/目录,并将index文件和chart放在这个目录中。

6、ChartMuseum仓库服务器

ChartMuseum是一个用Go写的开源Helm Chart仓库服务器,支持云存储后端,包括Google Cloud Storage,Amazon S3,Microsoft Azure Blob Storage,Alibaba Cloud OSS Storage,Openstack Object Storage,Oracle Cloud Infrastructure Object Storage,Baidu Cloud BOS Storage,Tencent Cloud Object Storage,DigitalOcean Spaces,Minio,以及etcd。

https://cloud.google.com/storage/

Cloud Object Storage - Amazon S3 - AWS

Azure Blob Storage | Microsoft Azure

Object Storage Service (OSS)-alibabacloud

Object Storage API — swift documentation

Oracle

对象存储BOS_云存储_分布式存储_数据湖存储-百度智能云

Cloud Object Storage | Tencent Cloud

DigitalOcean Spaces | S3-Compatible Object Storage

MinIO | High Performance, Kubernetes Native Object Storage

etcd

您也可以使用 ChartMuseum 服务从本地文件系统托管一个chart仓库。

ChartMuseum - Helm Chart Repository

7、GitLab包注册表

使用GitLab您可以在您的项目包注册表中发表Helm chart。在 这里 查看更多使用GitLab设置helm包仓库的信息。

https://docs.gitlab.com/ee/user/packages/helm_repository/

管理chart仓库

现在您拥有了一个chart仓库,上串一个chart好index文件到仓库中。仓库中的chart必须打包(helm package chart-name/)且使用正确的版本号(参照 SemVer 2指导)。

Semantic Versioning 2.0.0 | Semantic Versioning

下一步构建一个简单的实力工作流,不过欢迎您使用自己喜欢的工作流来存储和更新您的chart仓库。

一旦您准备好了打包的chart,创建一个新目录,然后将包移动到这个目录中。

$ helm package docs/examples/alpine/

$ mkdir fantastic-charts

$ mv alpine-0.1.0.tgz fantastic-charts/

$ helm repo index fantastic-charts --url https://fantastic-charts.storage.googleapis.com

$ helm package docs/examples/alpine/
$ mkdir fantastic-charts
$ mv alpine-0.1.0.tgz fantastic-charts/
$ helm repo index fantastic-charts --url https://fantastic-charts.storage.googleapis.com

最后一条命令会用刚才创建的本地路径和远程仓库url构建一个index.yaml文件放在给定的目录路径中。

现在您可以使用同步工具或手动上传chart和index文件到chart仓库中。如果使用的是Google Cloud Storage,使用gsutil客户端检查 示范工作流。针对与GitHub,您可以简单地将chart放在合适的目标分支中。。

Helm | 同步你的Chart仓库

添加一个新的chart到已有仓库中

每次您想在仓库中添加一个新的chart时,您必须重新生成index。helm repo index命令会完全无痕重建index.yaml文件。只包括在本地找到的chart。

不过您可以使用--merge参数增量添加到新的chart到现有index.yaml文件中(使用类似GCS的远程仓库时很有用)。执行helm repo index --help了解更多。

确保修订过的index.yaml文件和chart都长传了,如果生成了源文件,也要上传。

与别人分享你的chart

准备好分享您的chart时,只需要告诉别人您的仓库地址就可以了。

他们会通过helm repo add [NAME] [URL]命令将仓库添加到他们的客户端,并使用想引用仓库的任何名称。

$ helm repo add fantastic-charts https://fantastic.storage.googleapis.com

$ helm repo list

$ helm repo add fantastic-charts https://fantastic-charts.storage.googleapis.com
$ helm repo list
fantastic-charts    https://fantastic-charts.storage.googleapis.com

如果chart支持HTTP的基础验证,您也需要提供用户名和密码:

$ helm repo add fantastic-charts https://fantastic-charts.storage.googleapis.com --username my-username --password my-password

$ helm repo list

$ helm repo add fantastic-charts https://fantastic-charts.storage.googleapis.com --username my-username --password my-password
$ helm repo list
fantastic-charts    https://fantastic-charts.storage.googleapis.com

注意:如果不存在有效的index.yaml就无法添加仓库。

注意:如果您的helm仓库使用了类似于自签名的证书,为了跳过CA认证,可以使用helm repo add --insecure-skip-tls-verify ...。

然后,您的用户就可以通过您的chart进行搜索。更新了仓库之后,他们可以使用helm repo update命令获取最新的chart信息。

在内部helm repo add和helm repo update命令会检索index.yaml文件并将其存储在$XDG_CACHE_HOME/helm/repository/cache/目录中。这里是helm search 方法查找chart信息的位置。

————————————

仅用于本人学习

来源:Helm | Docs

  • 19
    点赞
  • 22
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值