安装指南

本指南将 Artifact Hub Shim 安装为 ACP 集群插件。标准安装完全离线,并将 API、内置目录和模板渲染扩展部署到 artifacthub-shim-system。

前提条件

  • 你具有 ACP 平台管理员权限,并有权访问集群插件管理。
  • 你已在可访问 ACP 平台的操作主机上安装 violet CLI。
  • 你已将 Artifact Hub Shim 集群插件包下载到操作主机。
  • 如果集群将通过 Tekton 或 Pipelines as Code 使用目录资源,则已安装受支持的 Alauda Container Platform Pipelines 版本。当前发布版本为 v4.14.0。4.10、4.6 和 4.0 系列将在 v4.10.2、v4.6.4 和 v4.0.17 之后获得支持。
  • ACP 集群满足 Release Notes 中记录的最低补丁版本要求。在 ACP 4.0 到 4.3 上,Artifact Hub Shim v1.0.0 将在 ACP 4.0.13、4.1.7、4.2.6 或 4.3.3 之后可用。ACP 4.4 及更高版本不受此限制。
  • 你可以使用具有集群管理员权限的 kubectl 来验证安装。

如果集群中已有 Tekton Hub 或其他 Artifact Hub 端点,请在将使用方切换到 Artifact Hub Shim 之前记录其配置。

使用 Violet 上传集群插件

建议使用 violet push 上传集群插件。该命令会将打包的 OCI chart 和相关镜像传输到 ACP global 注册表,并创建或更新软件包中包含的 ModulePlugin 资源。

从包含插件软件包的目录运行以下命令:

violet push <plugin-package>.tgz \
  --platform-address <platform-address> \
  --platform-username <platform-username> \
  --platform-password <platform-password> \
  --clusters <cluster-name> \
  --force

按如下方式替换占位符:

参数或占位符描述
<plugin-package>.tgz为目标架构提供的 Artifact Hub Shim 集群插件软件包。
<platform-address>ACP 平台 URL。
<platform-username>平台管理员用户名。
<platform-password>平台管理员帐户的密码。
<cluster-name>插件版本必须可用的集群。对于多个集群,请使用逗号分隔的列表。
--force覆盖注册表中现有的制品和固定标签镜像,使上传的软件包内容生效。

请勿将平台凭据写入脚本或源代码管理系统。命令完成后,打开平台管理 > Marketplace 管理 > 集群插件,并确认已上传版本的 Alauda Artifact Hub Shim 列于其中。

从 Web Console 安装集群插件

标准初始安装请使用以下值:

设置建议值用途
安装命名空间artifacthub-shim-system使用 Pipelines 集成所需的标准 Service 名称。
从节点数量1使用默认的单从节点拓扑。
ACP global 集群模式禁用仅当工作负载在 ACP global 集群上运行时启用。
启用内置目录启用使打包的 Task、Pipeline 和 StepAction 目录可用。
安装目录额外资源启用同步打包的模板和工具镜像 ConfigMap。
启用模板渲染扩展启用启用模板渲染和解析器可见性准入。
源工作目录类型emptyDir使用 Pod 本地存储,并与未来增加从节点数量保持兼容。
启用内容存储禁用从活动的内存中快照提供清单。
刷新间隔10m定期刷新已注册的 Git 源。
日志级别 / 格式info / json提供面向生产环境的结构化日志。

有关持久化存储、自定义身份验证、Ingress 和高级运行时设置,请参阅Chart 配置。

  1. 以平台管理员身份登录 ACP。
  2. 打开目标集群并导航到集群插件管理。
  3. 选择 Alauda Artifact Hub Shim。
  4. 选择适用于您环境且已获批准的最新可用版本。
  5. 应用上述建议配置。如果目标是 ACP global 集群,请启用 ACP Global 集群模式。
  6. 开始安装,并等待插件报告 Running。

对于普通安装,请勿直接创建或编辑 ModulePlugin、ModuleConfig、ModuleInfo、 ClusterPluginInstance 或派生的 AppRelease。ACP 会将这些资源作为集群插件生命周期的一部分进行管理。

验证安装

以下命令假定使用默认的安装命名空间、Helm release 名称和生成的资源名称。如果您自定义了其中任何值,请替换命令中的命名空间和资源名称。

检查 API Deployment 是否可用:

kubectl get deployment -n artifacthub-shim-system
kubectl rollout status deployment/artifacthub-shim \
  -n artifacthub-shim-system \
  --timeout=5m

如果您在安装期间禁用了启用模板渲染扩展,请跳过以下命令。否则,请验证扩展 Deployment:

kubectl rollout status deployment/artifacthub-shim-extension \
  -n artifacthub-shim-system \
  --timeout=5m

检查集群内 Service 和 API 健康状况,而不将其暴露到外部:

kubectl get service artifacthub-shim-api -n artifacthub-shim-system

kubectl get --raw \
  '/api/v1/namespaces/artifacthub-shim-system/services/http:artifacthub-shim-api:80/proxy/healthz'

kubectl get --raw \
  '/api/v1/namespaces/artifacthub-shim-system/services/http:artifacthub-shim-api:80/proxy/readyz'

健康检查请求应成功,并且就绪响应应包含 "status":"ready"。

需要验证源加载时,检查活动快照:

kubectl get --raw \
  '/api/v1/namespaces/artifacthub-shim-system/services/http:artifacthub-shim-api:80/proxy/api/v1/snapshot'

请勿为 Tekton 集成将 Service 发布到外部。Tekton 和 Pipelines as Code 应使用集群内 Service URL。

连接 Tekton

插件就绪后,配置 TektonConfig 并验证一个远程 Task。 标准安装使用以下端点:

http://artifacthub-shim-api.artifacthub-shim-system.svc.cluster.local

请参阅快速入门进行最小验证,或参阅 配置 Tekton 集成了解 Tekton 和 Pipelines as Code 设置。

自定义安装

卸载 Artifact Hub Shim

卸载插件会移除 Tekton resolver、Pipelines as Code 和 DevOps Hub UI 使用的本地端点。这可能会中断流水线并移除插件管理的资源。请使用 ACP 集群插件管理中显示的删除风险信息,并遵循组织批准的卸载操作步骤。

卸载前,请重新配置或禁用所有指向 Artifact Hub Shim Service 的使用方,通过经批准的安全流程备份用户管理的仓库定义和凭据,并确保没有活动的 PipelineRun 或 TaskRun 依赖该端点。切勿将导出的凭据存储在源代码管理系统中。

商标和归属声明

Tekton™ 是 The Linux Foundation 的商标。

Red Hat® 和 OpenShift® 是 Red Hat, Inc. 在美国和其他国家/地区的注册商标。

Alauda 是独立供应商。本产品与 The Linux Foundation 或 Red Hat, Inc. 无关联,也未获其认可或赞助。所有商标均为其各自所有者的财产,此处仅用于识别目的。