Nexus Connector
Nexus connector 是一种与平台无关的 connector,可用于连接 Nexus 仓库。
您可以使用 Nexus Connector 在 CICD pipeline 或 Kubernetes 工作负载中安全地执行 Maven、NPM 和 PyPI 操作,而无需凭证。
此外,您可以集中管理跨 namespace 的 Nexus 访问配置,避免在每个 namespace 中重复配置 Nexus 凭证。
目录
概述集成要求创建 Nexus Connector字段参考Nexus Connector 的功能身份验证使用 Basic Authentication所需的凭证权限Subconnector 生成Proxy 和配置文件Proxy 地址Maven:settings.xml 配置NPM:.npmrc 配置Yarn:.yarnrc.yml 配置PyPI 下载:pip.conf 配置PyPI 发布:.pypirc 配置使用 Connectors CSI DriverNexus 的 configuration.params进一步阅读参考资料概述
本文档涵盖:
- 集成要求:目标 Nexus 仓库的先决条件
- 创建 Nexus connector
- 高级功能:Maven、NPM 和 PyPI 的代理功能与配置文件
集成要求
Nexus Repository 先决条件
- Nexus server 必须可从集群访问。
- 支持的仓库类型:Maven(hosted/proxy/group)、NPM(hosted/proxy/group)、PyPI(hosted/proxy/group)。
客户端先决条件
对于 Maven 客户端,您必须先信任 connector proxy server 的证书,然后才能执行 mvn 操作:
mvn client 还必须使用 wagon transport:
创建 Nexus Connector
以下介绍如何创建基本的 Nexus Connector:
字段参考
spec.connectorClassName:
nexus(常量),指定用于 Nexus 集成的 ConnectorClass 名称。
spec.address:
目标 Nexus server 地址,例如:https://nexus.example.com。这是 Nexus server 的根地址,而不是特定仓库的 URL。
spec.auth:
指定 Nexus server 的身份验证方法。
spec.auth.name:对于 Nexus connector,应为basicAuth。spec.auth.secretRef:指定包含身份验证信息的 Secret。该 Secret 应创建在与 connector 相同的 namespace 中。如果您的 Nexus server 不要求身份验证,可以省略此字段。
可选元数据字段:
-
cpaas.io/description:connector 的描述信息,例如:
Nexus Connector 的功能
身份验证
Nexus connector 支持以下身份验证类型:
basicAuth:基于用户名和密码的身份验证,对应的 Secret 类型:kubernetes.io/basic-auth
使用 Basic Authentication
如果 Secret 不正确,connector 中的 status.conditions 字段将显示错误消息。
有关完整的状态信息,请参阅 Connector 状态文档。
所需的凭证权限
所需权限取决于您计划如何使用 connector:
- 仅下载:凭证仅需具有目标仓库的读取权限。
- 上传/部署:凭证必须同时具有目标仓库的读取和写入权限。
为遵循安全最佳实践,请创建具有所需最小权限的凭证。
Subconnector 生成
单个 Nexus server 通常会在不同的仓库路径下提供多个包生态系统,例如 npm、Maven 和 PyPI。您无需为每个生态系统创建一个 Connector,也无需挂载下文所述的各格式配置文件,而是可以声明一个 Nexus 聚合器 Connector,由其为每个生态系统生成一个子 Connector:在 Nexus ConnectorClass 上设置 spec.generation.supportedClasses: [npm, maven, pypi],并在 Nexus Connector 的 spec.generators 中列出各个生态系统。控制器会为每个类生成 npm / maven / pypi 子 Connector;这些子 Connector 共享聚合器的主机和凭证,流水线通过这些子 Connector 使用软件包。
这是从单个 Nexus server 提供多个生态系统服务的推荐方式。有关完整模型(包括地址模板化、身份验证继承、GenerationReady 条件、恢复和生命周期),请参阅 Connector 生成。
Proxy 和配置文件
为了让客户端无需凭证即可访问 Nexus 仓库,Nexus connector 提供了一个 proxy server,可自动注入身份验证信息。
Nexus ConnectorClass 提供以下配置文件,这些文件可以通过 Connectors CSI Driver 挂载到 Pod 中:
直接挂载这些各格式配置文件(settings / npmrc / yarnrc / pipconf / pypirc)的方式已弃用。建议改用 Subconnector 生成;该方式会生成每个类对应的 npm / maven / pypi 子 Connector,流水线通过这些子 Connector 使用软件包,而不是使用这些原始配置挂载。
Proxy 地址
创建 Connector 后,系统会自动为目标 Nexus server 配置 proxy service。
proxy endpoint 会记录在 status.proxy.httpAddress 中:
Maven:settings.xml 配置
settings 配置会提供一个通过 Connectors CSI Driver 挂载的 settings.xml 文件和一个 ca.cert 文件。
生成的 settings.xml 示例:
可选参数:mirrorRepository — 用作 Maven mirror 的 Nexus 仓库。设置后,生成的 settings.xml 将包含一个 <mirrors> 部分,并指向 {address}/repository/{mirrorRepository}。
要挂载 settings 配置:
NPM:.npmrc 配置
npmrc 配置会为 NPM 软件包操作提供一个 .npmrc 文件。
可选参数:registry — Nexus NPM proxy 仓库名称(例如 npm-proxy)。默认值:""。为空时,.npmrc 将使用占位符注释进行渲染,而不会导致 CSI 挂载失败;提供此参数即可启用 npm install / npm publish。
可选参数:strictSSL — 是否要求 SSL(默认值:"true")。
Yarn:.yarnrc.yml 配置
yarnrc 配置会为 Yarn 软件包操作提供一个 .yarnrc.yml 文件。
可选参数:registry — Nexus NPM proxy 仓库名称。默认值:""。为空时,.yarnrc.yml 将使用占位符注释进行渲染,而不会导致 CSI 挂载失败;提供此参数即可启用 yarn install / yarn npm publish。
可选参数:strictSSL — 是否要求 SSL(默认值:"true")。
PyPI 下载:pip.conf 配置
pipconf 配置会为下载 PyPI 软件包提供一个 pip.conf 文件。
可选参数:repository — Nexus PyPI proxy 仓库名称(例如 pypi-proxy)。默认值:""。为空时,pip.conf 将使用占位符注释进行渲染,而不会导致 CSI 挂载失败;提供此参数即可启用 pip install。
PyPI 发布:.pypirc 配置
pypirc 配置会为发布 PyPI 软件包提供一个 .pypirc 文件。
可选参数:deployRepository — Nexus PyPI hosted 仓库名称(例如 pypi-hosted)。默认值:""。为空时,.pypirc 将使用占位符注释进行渲染,而不会导致 CSI 挂载失败;提供此参数即可启用 twine upload。
使用 Connectors CSI Driver
CSI volume 属性参数:
csi.readOnly:固定值为truecsi.driver:固定为connectors-csicsi.volumeAttributes:connector.name:Nexus Connector 的名称connector.namespace:Nexus Connector 的 namespace;如果未指定,则使用 Pod 的 namespaceconfiguration.names:要挂载的配置(例如settings、npmrc、yarnrc、pipconf、pypirc)configuration.params:包含每个命名配置运行时参数的 JSON 字符串(见下文)
通过使用逗号分隔名称,可以同时挂载多个配置:
Nexus 的 configuration.params
有关 configuration.params 的格式、验证规则和默认值注入行为,请参阅 Connectors CSI Driver 文档中的 configuration.params。
每个 Nexus 配置接受的参数如下:
当参数默认值为 "" 且调用方从 configuration.params 中省略相应条目时,生成的文件会包含一个占位符注释块(以 # WARNING: empty configuration 开头),其中会指出缺少的参数,并显示用于提供该参数所需的 JSON 片段 — CSI 挂载仍会成功,下游工具可以检测到空状态,而不会导致 Pod 启动失败。