Alauda DevOps Connectors Docs
  • 简体中文

    • ConnectorClass

    目录

    概述地址信息参数认证信息认证类型认证参数可选认证存活探针使用 HTTP 请求进行探测使用 ConnectorClass API 进行探测认证探测使用 HTTP 请求进行探测使用 ConnectorClass API 进行探测自定义认证校验参数认证校验表达式基于 Rego 的认证逻辑配置Rego 中可用的变量Rego 策略示例高级 Rego 技巧ConnectorClass API配置 API 地址API 地址解析OpenAPI 描述配置能力配置类型自定义配置用于可读性展示的元数据信息ConnectorClass Proxy使用 Rego 从请求中提取 token解析类型状态信息兼容性更多示例更多

    概述

    ConnectorClass 是一个集群级资源，用于定义特定类型工具的访问方式和行为规范。

    以下示例定义了一个支持基本认证的 hello-git 类型连接器：

    apiVersion: connectors.alauda.io/v1alpha1
kind: ConnectorClass
metadata:
  name: hello-git
spec:
  address:
    type: string  # String 格式的地址
  auth:
    types:
      - name: basicAuth
        secretType: kubernetes.io/basic-auth  # 使用 Basic Auth 进行认证

    在 ConnectorClass 中，通过描述以下信息来定义连接工具与平台时的访问方式和行为规范：

    • 工具访问地址的格式
    • 支持的认证方式
    • 如何检查工具的可访问性
    • 如何验证认证的有效性
    • 工具如何提供 API 能力
    • 工具提供哪些配置能力
    • 用于可读性展示的元数据

    本文档还提供了一些示例，帮助读者更好地理解如何自定义 ConnectorClass。示例

    地址信息

    地址信息定义了访问工具所使用的格式。目前支持 string 类型的地址配置。此地址信息会限制当前类型工具必须满足的字段类型约束。

    spec:
  address:
    type: string  # 当前仅支持 string 类型

    此时表示连接工具到平台的地址信息必须是 string 类型。

    参数

    参数用于在创建连接器时定义额外参数。

    你可以通过 connectorclass 的 spec.params 字段定义创建连接器时所需的参数。

    • spec.params[].name - 参数名称。
    • spec.params[].type - 参数类型。目前仅支持 string 类型。
    • spec.params[].default - 默认参数值（可选）。如果提供了默认值，用户在创建连接器时可以省略该参数。
    • spec.params[].description - 参数描述（可选）。

    例如，以下定义允许用户在创建 git 类型连接器时提供 sslVerify 参数，默认值为 true。

    kind: ConnectorClass
metadata:
  name: git
spec:
  params:
    - name: sslVerify
      type: string
      default: "true"

    关于创建 Connectors 时的参数配置，请参考 Connector 文档。

    结合 connectors-csi-driver 的能力，这可以实现更灵活的配置。这在你需要提供参数化配置时特别有用。例如，在创建 git 类型连接器时，用户可以提供 sslVerify 参数来控制 SSL 证书校验。更多详情请参考 ConnectorClass 配置 文档。

    认证信息

    认证类型

    认证类型定义了用于工具认证的凭证类型。一个工具可以支持多种认证类型，允许用户在使用工具时进行选择。

    用户可以通过以下方式为当前认证类型指定唯一名称：

    • spec.auth.types[].name，必须唯一且不能重复。
    • spec.auth.types[].secretType，用于指定认证所需的 Secret 类型，对应于 Kubernetes Secret Type。

    示例：

    spec:
  auth:
    types:
      - name: basicAuth  # 认证类型名称
        secretType: kubernetes.io/basic-auth  # 对应的 Secret 类型
      - name: sshAuth
        secretType: kubernetes.io/ssh-auth

    在内置的 K8S Secret Type 中，除 Opaque 之外的类型都具有字段约束。提供 Secret 时，用户必须确保 Secret 的字段满足该类型的约束。

    使用 Opaque 类型时，必须声明认证参数。

    与 k8s 类似，你也可以使用自定义的 Secret Type。此时，必须声明认证参数。

    认证参数

    认证过程中凭证所需的参数由 spec.auth.types[].params 定义。

    对于数据字段定义清晰的标准 Kubernetes secret 类型，可以省略参数。例如：

    • kubernetes.io/basic-auth：用户名和密码认证
    • kubernetes.io/ssh-auth：SSH key 认证

    对于自定义认证类型，你可以定义所需的认证参数，此时 secretType 标记为 Opaque 或自定义名称。

    例如，GitLab 的 Personal Access Token (PAT) 认证：

    spec:
  auth:
    types:
      - name: privateToken
        secretType: Opaque
        params:
          - name: username
            type: string
          - name: private-token
            type: string
      - name: oauth2
        secretType: example.com/oauth2
        params:
          - name: clientID
            type: string
          - name: clientSecret
            type: string

    此定义要求工具连接器中使用的凭证包含 params 中指定的字段。

    可选认证

    某些工具支持无需认证即可访问，这通过 optional 字段标记，表示该认证是否可选：

    例如，以下示例表示 basicAuth 的凭证是可选的，而 sshAuth 的凭证是必需的。

    spec:
  auth:
    types:
      - name: basicAuth
        optional: true  # 标记认证为可选
        secretType: kubernetes.io/basic-auth
      - name: sshAuth
        secretType: kubernetes.io/basic-auth

    此时，在将这种类型的工具连接到平台时，可以省略 basicAuth 类型认证。

    存活探针

    可访问性检查用于验证工具是否可以正常访问。此类检查的配置通过 livenessProbe 字段完成。

    存活检查可以通过 HTTP 请求或 ConnectorClass API 执行。

    使用 HTTP 请求进行探测

    你可以配置 spec.livenessProbe.http，通过 HTTP 请求执行存活检查。

    示例

    以下片段表示使用 HTTP 请求进行检测。

    spec:
  livenessProbe:
    http:
      path: /

    当工具返回 200 状态码时，视为可访问。

    更多详情请参考 Authentication Probe 中的使用 HTTP 请求进行探测。配置是相同的，只是字段路径不同。

    使用 ConnectorClass API 进行探测

    你可以配置 spec.livenessProbe.api，通过 ConnectorClass API 执行存活检查。

    示例

    以下片段表示使用 ConnectorClass API 进行检测。

    spec:
  livenessProbe:
    api:
      path: /

    更多详情请参考 Authentication Probe 中的使用 ConnectorClass API 进行探测。配置是相同的，只是字段路径不同。

    认证探测

    认证校验用于验证此类型工具的认证凭证是否有效。如果不需要认证校验，可以省略 authProbes 字段。

    • spec.authProbes[].authName 指定正在校验的认证类型，且必须与 spec.auth.types[].name 中定义的某个名称匹配。

    认证校验可以通过 HTTP 请求或 ConnectorClass API 执行。

    使用 HTTP 请求进行探测

    你可以配置 spec.authProbes[].probe.http，通过 HTTP 请求执行认证校验。

    • spec.authProbes[].probe.http.host 指定认证校验的目标主机。默认使用连接器地址中的主机。
    • spec.authProbes[].probe.http.path 指定用于认证校验的请求路径。这是一个绝对路径，在执行探测时会附加到从连接器 spec.address 解析出的主机 URI 后。如果 spec.address 包含路径前缀，则在认证校验时会忽略该前缀。若要包含路径前缀，请使用 Authentication Check Expressions 动态获取。
    • spec.authProbes[].probe.http.method 指定认证校验使用的 HTTP 方法，支持 GET 和 POST。默认值为 GET。
    • spec.authProbes[].probe.http.disableRedirect 指定在认证校验期间是否禁用 HTTP 重定向。默认值为 false（允许自动重定向）。
    • spec.authProbes[].probe.http.httpHeaders 指定认证校验请求中包含的 HTTP headers。
    • spec.authProbes[].probe.http.scheme 指定用于认证校验的 URI scheme。默认使用连接器地址中的 scheme。

    示例

    以下 YAML 配置演示了在认证校验期间，系统会向连接器地址发送一个带有 Authorization: abc header 的 GET https://example.com/ HTTP/1.1 请求。

    kind: ConnectorClass
metadata:
  name: example-class
spec:
  authProbes:
    - authName: basicAuth  # 对应的认证类型
      probe:
        http:
          httpHeaders:
            Authorization: abc
          path: /
          method: GET # 默认值为 GET，支持 POST 和 GET 方法
          disableRedirect: false # 默认值为 false，允许自动重定向
---
kind: Connector
metadata:
  name: example
spec:
  connectorClassName: example-class
  address: https://example.com

    使用 ConnectorClass API 进行探测

    你可以配置 spec.authProbes[].probe.api，通过 ConnectorClass API 执行认证校验。你必须先在 ConnectorClass 规范中配置 spec.api。返回 200 表示认证成功，返回 401 或 403 表示认证失败。了解更多关于 ConnectorClass API 的信息。

    • spec.authProbes[].probe.api.path 指定用于认证校验的 API endpoint 路径。这是一个相对路径，在执行认证校验时会附加到从 ConnectorClass 的 spec.api 配置中解析出的 API 地址后。如果 spec.api 包含路径前缀，则在执行认证校验时会包含该路径前缀。

    示例

    以下 YAML 配置演示了在认证校验期间，系统会向 ConnectorClass API 发送一个 GET https://example-api.default.svc.cluster.local/api/auth/check HTTP/1.1 请求。

    kind: ConnectorClass
metadata:
  name: example-class
spec:
  api:
    ref:
      kind: Service
      name: example-api
      namespace: default
    uri: /api
  authProbes:
    - authName: basicAuth
      probe:
        api:
          path: /auth/check # 这是从 connectorclass 的 `spec.api` 解析出的 API 地址的相对路径
---
kind: Connector
metadata:
  name: example
spec:
  connectorClassName: example-class
  address: https://example.com

    自定义认证校验参数

    某些认证校验场景可能需要额外参数，例如在校验对 Git repository 的访问时指定 repository 名称。这些参数可以通过 spec.authProbes[].params 定义。

    kind: ConnectorClass
metadata:
  name: example-class
spec:
  authProbes:
    - authName: basicAuth  # 对应的认证类型
      params:
        - name: repository
          type: string

    认证校验表达式

    配置 authProbes 时，可以使用表达式动态获取凭证信息或 Connector 元数据。

    例如：

    spec:
  authProbes:
    - authName: basicAuth  # 对应的认证类型
      probe:
        http:
          httpHeaders:
            Authorization: {{ .Secret.StringData.token }}
          path: /
      params:
        - name: repository
          type: string
    • 表达式可以用于 probe.http.httpHeaders、probe.http.path 和 probe.api.path 字段。
    • 表达式格式遵循 Go template 语法。
    • 支持的顶层字段包括：
      • .Connector：包含 Connector 资源本身的信息
      • .Secret：包含用于 Connector 认证的 Secret 数据
    • 表达式中可用的方法在 sprig 库中有文档说明：
      • 例如：b64enc 用于对字符串进行 Base64 编码，trimPrefix 用于移除字符串前缀

    示例

    Basic Authentication 校验：

    spec:
  authProbes:
    - authName: basicAuth
      params:
        - name: repository
          type: string
      probe:
        http:
          path: /{{- range .Connector.Spec.Auth.Params }}{{- if eq .Name "repository" }}{{ .Value.StringVal }}{{ end }}{{- end }}/info/refs?service=git-upload-pack
          httpHeaders:
          - name: Authorization
            value: >-
              {{- if .Secret }}Basic {{ printf "%s:%s" .Secret.StringData.username .Secret.StringData.password | b64enc }} {{- end }}

    连接器会根据 ConnectorClass 中定义的配置执行认证校验。

    上述 YAML 演示了基本认证校验：

    • path：使用 Connector 的 auth.params 中的 repository 值，将路径构造成 /<repository>/info/refs?service=git-upload-pack
    • Authorization：当 Connector 配置了 Secret 时，会将 username 和 password 字段进行 Base64 编码，并包含在 Basic authentication header 中。

    基于 Rego 的认证逻辑配置

    当工具连接器需要更复杂的认证逻辑时，可以使用基于 Rego 的认证逻辑配置。

    Rego 是一种声明式策略语言，允许你定义认证逻辑。在 ConnectorClass 中，Rego 策略通过 auth.types[].generator.rego 字段指定：

    apiVersion: connectors.alauda.io/v1alpha1
kind: ConnectorClass
metadata:
  name: example
spec:
  address:
    name: address
    type: string
  auth:
    types:
    - name: rego-auth
      secretType: Opaque
      generator:
        rego: |
          package proxy
          auth = {
            "position": "header",
            "auth": {
              "Authorization": concat(" ", ["Bearer", input.data.token])
            }
          }

    Rego 策略必须遵循以下规则：

    • 在 proxy package 下定义规则
    • 生成一个具有以下结构的 auth 对象：
      • position：注入认证的位置，例如 "header"、"query" 或 "body"
      • contentType：body 注入时的 content type（可选，与 "body" 位置一起使用）
      • auth：认证键值对的映射

    Rego 中可用的变量

    变量类型描述
    input.datamap[string]string用于 Connector 的 Secret 数据
    input.request.headersmap[string][]string发送给后端工具的请求 headers
    input.request.bodyobject发送给后端工具的请求 body
    input.request.querymap[string][]string发送给后端工具的 query 参数
    input.request.methodstring发送给后端工具的 HTTP 方法
    input.request.pathstring发送给后端工具的请求路径
    input.request.hoststring发送给后端工具的请求主机

    Rego 策略示例

    Basic Authentication
    spec:
  auth:
    types:
    - name: basic-rego-auth
      secretType: Opaque
      generator:
        rego: |
          package proxy
          auth = {
            "position": "header",
            "auth": {
              "Authorization": concat(" ", ["Basic", base64.encode(concat(":", [input.data.username, input.data.password]))])
            }
          }
    API Key Authentication
    spec:
  auth:
    types:
    - name: apikey-rego-auth
      secretType: Opaque
      generator:
        rego: |
          package proxy
          auth = {
            "position": "query",
            "auth": {
              "api_key": input.data.apikey
            }
          }
    JSON Body Authentication
    spec:
  auth:
    types:
    - name: body-rego-auth
      secretType: Opaque
      generator:
        rego: |
          package proxy
          auth = {
            "position": "body",
            "contentType": "application/json",
            "auth": {
              "username": input.data.username,
              "password": input.data.password,
              "client_id": input.data.client_id
            }
          }

    高级 Rego 技巧

    你可以使用 Rego 的条件逻辑来适配不同的认证方式：

    条件认证
    spec:
  auth:
    types:
    - name: conditional-auth
      secretType: Opaque
      generator:
        rego: |
          package proxy

          # Default uses API key
          auth = {
            "position": "header",
            "auth": {
              "X-API-Key": input.data.apikey
            }
          }

          # Use OAuth token if available
          auth = {
            "position": "header",
            "auth": {
              "Authorization": concat(" ", ["Bearer", input.data.oauth_token])
            }
          } {
            input.data.oauth_token != ""
          }
    基于时间的认证
    spec:
  auth:
    types:
    - name: time-based-auth
      secretType: Opaque
      generator:
        rego: |
          package proxy

          import time

          # Get current time
          current_time := time.now_ns() / 1000000000

          auth = {
            "position": "header",
            "auth": {
              "X-Timestamp": sprintf("%d", [current_time]),
              "X-Signature": hmac.sha256(input.data.api_secret, sprintf("%d", [current_time]))
            }
          }

    如需了解更多 Rego 语言细节，请参考：

    ConnectorClass API

    ConnectorClass API 允许开发者通过额外的 HTTP API 服务扩展 ConnectorClass 的 API 能力。这为 ConnectorClass 提供了一个 RESTful API，使客户端在使用 Connectors 时能够更方便地访问工具内的资源。

    如果无需为工具提供自定义 API 能力，可以将 spec.api 保持未定义。

    配置 API 地址

    ConnectorClass API 通过 spec.api 字段配置。你可以通过三种方式指定 API 服务：

    1. 通过 Kubernetes Service 引用：

    spec:
  api:
    ref:
      kind: Service
      name: git
      namespace: default

    2. 通过带有 URI 路径前缀的 Service 引用：

    如果 API 地址有固定的路径前缀，可以使用 spec.api.uri 指定：

    spec:
  api:
    ref:
      kind: Service
      name: git
      namespace: default
    uri: /api

    3. 通过绝对 URI：

    你也可以使用 spec.api.uri 指定 API 的绝对路径：

    spec:
  api:
    uri: https://git.example.com/api

    API 地址解析

    无论使用哪种配置方式，最终解析得到的 API 地址都会存储在 status.api.address.url 中。例如：

    spec:
  api:
    ref:
      kind: Service
      name: git
      namespace: default
    uri: /prefix
status:
  api:
    address:
      url: https://git.default.svc/prefix

    更多信息请参考：

    OpenAPI 描述

    OpenAPI 描述是一个可选配置，主要有两个用途：

    • 标记 API 是自定义 API，还是使用 Connector Proxy 访问工具原始 API
    • 提供 API 定义，以支持客户端动态表单中的 API 引用

    你可以使用 spec.api.openapi 定义 OpenAPI 描述。其结构遵循 OpenAPI 3.0 规范。例如：

    spec:
  api:
    openapi:
      openapi: "3.0.1"
      info:
        title: Git API
        version: "1.0.0"

    你可以在 API paths 中定义 x-provider-type 扩展字段，用于标记 API 是自定义 API，还是使用 Proxy 访问工具的原始 API。有效值为 api 或 proxy。

    x-provider-type 扩展字段的定义如下：api.openapi.paths[<path>].<verb>[x-provider-type]

    示例：

    spec:
  api:
    openapi:
      openapi: "3.0.1"
      info:
        title: Gitlab API
        version: "1.0.0"
      paths:
        /git/api:
          get:
            summary: Get Git API
            x-provider-type: api  # 使用自定义 API
        /api/v4/projects:
          get:
            summary: Get Gitlab Projects API
            x-provider-type: proxy  # 使用 Proxy 访问工具原始 API
    Info

    当客户端请求 Connector API 时，Connectors 系统会根据当前 Connector 所对应的 ConnectorClass 中 x-provider-type 的值，判断是使用自定义 API，还是直接使用 Connectors Proxy 访问工具原始 API。当未提供此信息，或未匹配到任何 API path 时，系统默认使用 Connectors Proxy 访问工具原始 API。

    当你需要在动态表单中引用 API 时，需要在 spec.api.openapi 中进行额外配置。更多详情请参考 在动态表单中使用 Connectors API。

    配置能力

    配置能力定义了 ConnectorClass 向客户端提供的配置文件。这些文件可以通过 Connectors-CSI Driver 挂载到 Pod 中。

    配置类型

    • 自定义配置：在 spec.configurations 中定义
    • 内置配置：由 Connectors-CSI Driver 自动提供（参见：内置配置）

    自定义配置

    配置通过 spec.configurations 指定：

    kind: ConnectorClass
metadata:
  name: git
spec:
  configurations:
  - name: gitconfig
    data:
      .gitconfig: |
        [http]
            extraHeader = Authorization: Basic {{ .context.token | b64enc }}
        [url "{{ .connector.status.proxyAddress }}"]
            insteadOf = {{ .connector.spec.address }}

    更多详情请参见：配置文件渲染

    注意： spec.configurations 是可选的。未定义时，只能使用内置配置。

    用于可读性展示的元数据信息

    ConnectorClass 是一个标准的 k8s 资源，可以通过 labels 和 annotations 添加自定义信息。

    例如：

    KeyDescription
    ui.cpaas.io/iconConnectorClass 的图标，可选。格式：data:image/svg+xml;base64,PD94bWwgdmVyc2...
    cpaas.io/display-nameConnectorClass 的显示名称，可选。
    cpaas.io/descriptionConnectorClass 的描述，可选。
    connectors.cpaas.io/readmeConnectorClass 的使用说明，可选。通常用于无法提供 docs-link 的自定义场景。支持 Markdown 格式。
    connectors.cpaas.io/docs-linkConnectorClass 的文档链接，可选。可以是相对路径或绝对路径。

    例如：

    apiVersion: connectors.alauda.io/v1alpha1
kind: ConnectorClass
metadata:
  name: git
  labels:
    connectors.cpaas.io/git: "true"
  annotations:
    ui.cpaas.io/icon: "data:image/svg+xml;base64,PD94bWwgdmVyc2..."
    cpaas.io/display-name: Git
    cpaas.io/description: "Connect to any Git tool"
    connectors.cpaas.io/readme: "this is readme..."
    connectors.cpaas.io/docs-link: "/alauda-devops-connectors/concepts/connectorclass/git"

    ConnectorClass Proxy

    ConnectorClass Proxy 用于配置 ConnectorClass 的代理地址。

    ConnectorClass Proxy 通过 spec.proxy 配置。例如：

    spec:
  proxy:
    ref:
      kind: Service
      name: proxy
      namespace: default
    # uri: https://proxy.example.com

    Connector 会使用代理地址将请求转发到 ConnectorClass。更多信息

    使用 Rego 从请求中提取 token

    使用内置反向代理时，你可以通过 spec.proxy.authExtractor 配置 Rego 规则，从客户端请求中提取 token，使内置反向代理能够使用提取到的 token 验证客户端认证。

    例如：

    spec:
  proxy:
    authExtractor:
      rego: |
        package proxy
        auth = {
          "token": input.request.headers["Private-Token"][0]
        }

    Rego 规则必须满足以下要求：

    • 规则必须定义在 proxy package 中
    • 使用 auth 变量返回 token，token 的类型必须为 string，例如：auth = { "token": "abcd1234" }
    • 如果无法提取 token，则返回空字符串，例如：auth = { "token": "" }

    Rego 中可用的变量如下：

    keytypedescriptionExample
    request.headersmap[string][]string发送到内置反向代理的请求 headersinput.request.headers["X-Token"][0]
    request.bodyobject发送到内置反向代理的请求 bodyinput.request.body.token
    request.querymap[string][]string发送到内置反向代理的请求 query 参数input.request.query["token"][0]
    request.methodstring发送到内置反向代理的请求 HTTP 方法input.request.method
    request.pathstring发送到内置反向代理的请求路径input.request.path
    request.hoststring发送到内置反向代理的请求主机input.request.host

    注意：

    • headers 中的 header key 使用 Canonical MIME Header Key 格式（首字母大写）
    • 实现 Rego 规则时，请确保逻辑健壮。例如，当 input.request.headers 为 null 或为空时，返回空字符串。

    示例

    spec:
  proxy:
    authExtractor:
      rego: |
        package proxy

        default auth = {
          "token": ""
        }

        auth = {
          "token": input.request.headers["Private-Token"][0]
        } if {
          input.request.headers != null
          input.request.headers["Private-Token"] != null
          count(input.request.headers["Private-Token"]) > 0
        }

    此示例通过以下方式演示了健壮的 token 提取：

    • 定义一个默认规则，返回空的 token 字符串
    • 在访问 headers 之前先检查其是否存在且不为 null
    • 验证特定的 header key 是否存在且至少有一个值

    如需了解更高级的 Rego 规则，请参阅 Rego Policy Language 文档。 关于如何使用内置反向代理的更多信息，请参阅 Connectors Proxy。

    解析类型

    ConnectorClass 的代理地址会根据指定的 resolver 类型进行解析。

    resolver 类型通过注解 connectors.cpaas.io/proxy-resolver 配置。例如：

    apiVersion: connectors.alauda.io/v1alpha1
kind: ConnectorClass
metadata:
  name: oci
  annotations:
    connectors.cpaas.io/proxy-resolver: "path"

    该字段是 ConnectorClass-Proxy 与 Connector 之间的一种约定。可选。

    支持的值：host、path。默认值为 host。

    • host 格式：http://{.ConnectorClass.Status.ProxyAddress.URL}
    • path 格式：http://{.ConnectorClass.Status.ProxyAddress.URL}/namespaces/{namespace}/connectors/{connector-name}

    状态信息

    定义 ConnectorClass 资源后，该资源的状态信息会存储在 status 中。

    status.conditions 类型包括：

    • APIReady：API 能力的状态信息
    • ProxyReady：Proxy 能力的状态信息
    • Ready：标记当前 ConnectorClass 的整体状态

    Ready Condition

    Ready Condition 用于标记当前 ConnectorClass 的状态。它会汇总其他条件的状态。

    • 当其他 Conditions 都为 True 时，当前 Condition 为 True。
    • 当任意其他 Condition 为 False 时，当前 Condition 为 False。
    • 当任意其他 Condition 为 Unknown 时，当前 Condition 为 Unknown。

    APIReady Condition

    表示为 ConnectorClass 配置的 API 服务状态信息。API 服务通过 ConnectorClass 的 spec.api 配置。

    StatusReasonDescription
    TrueNonAPI未配置 spec.api，当前 ConnectorClass 不具备 API 能力
    True已定义 spec.api，API 服务正常
    False已定义 spec.api，API 能力异常或检测本身异常
    UnknownAPI 能力检测中

    注意：

    • API 检测只会尝试请求链接，不会对 HTTP 返回值做判断。API 服务的健康检查应依赖 API 服务自身的健康检查机制。
    • 由于 API 服务可能随时变化，API 的状态信息无法反映实时信息。建议客户端将此状态信息作为提示，而不是依赖它来阻止客户端行为。

    ProxyReady Condition

    表示为 ConnectorClass 配置的 Proxy 服务状态信息。Proxy 服务通过 ConnectorClass 的 spec.proxy 配置。

    StatusReasonDescription
    TrueNonProxy未配置 spec.proxy，当前 ConnectorClass 不具备 Proxy 能力
    True已定义 spec.proxy，Proxy 服务正常
    False已定义 spec.proxy，Proxy 能力异常或检测本身异常
    UnknownProxy 能力检测中

    兼容性

    对 ConnectorClass 的更新可能会影响现有 Connectors。如果 ConnectorClass 存在不兼容的变更，可能会导致之前创建的 Connectors 失效。以下是一些可能导致不兼容的变更：

    1. 认证信息变更：如果 ConnectorClass 修改了支持的认证类型或方式，可能导致使用旧认证方式的 Connectors 无法正常工作。

    2. 配置信息变更：如果 ConnectorClass 的配置信息发生变化，例如移除了已有配置，可能导致依赖旧配置的 Kubernetes workloads 无法正常工作。

    建议在更新 ConnectorClass 时确认影响范围，必要时创建新的 ConnectorClass。

    更多示例

    • 支持 basic-auth 认证类型的 ConnectorClass

      apiVersion: connectors.alauda.io/v1alpha1
kind: ConnectorClass
metadata:
  name: git
spec:
  address:
    type: string
  auth:
    types:
      - name: basicAuth
        secretType: kubernetes.io/basic-auth
        optional: true

    • 自定义认证类型的 ConnectorClass

      apiVersion: connectors.alauda.io/v1alpha1
kind: ConnectorClass
metadata:
  name: sample
spec:
  address:
    type: string
  auth:
    types:
      - name: patAuth
        optional: true
        secretType: Opaque
        params:
        - name: username
        - name: privateToken

    • 配置了 liveness probe 的 ConnectorClass

      apiVersion: connectors.alauda.io/v1alpha1
kind: ConnectorClass
metadata:
  name: git
spec:
  address:
    type: string
  auth:
    types:
      - name: basicAuth
        optional: true
        secretType: kubernetes.io/basic-auth
  livenessProbe:
    http:
      path: /

    • 配置了 auth probe 的 ConnectorClass

      apiVersion: connectors.alauda.io/v1alpha1
kind: ConnectorClass
metadata:
  name: git
  labels:
    connectors.cpaas.io/git: "true"
spec:
  address:
    type: string
  auth:
    types:
      - name: basicAuth
        secretType: kubernetes.io/basic-auth
        optional: true
  livenessProbe:
    http:
      path: /
  authProbes:
    - authName: basicAuth
      params:
        - name: repository
          type: string
      probe:
        http:
          path: /{{- range .Connector.Spec.Auth.Params }}{{- if eq .Name "repository" }}{{ .Value.StringVal }}{{ end }}{{- end }}/info/refs?service=git-upload-pack
          httpHeaders:
          - name: Authorization
            value: >-
              {{- if .Secret }}Basic {{ printf "%s:%s" .Secret.StringData.username .Secret.StringData.password | b64enc }} {{- end }}

    • 完整的 Git 连接器配置示例：

      apiVersion: connectors.alauda.io/v1alpha1
kind: ConnectorClass
metadata:
  name: git
spec:
  address:
    name: address
    type: string
  auth:
    types:
      - name: basicAuth
        secretType: kubernetes.io/basic-auth
        optional: true
  livenessProbe:
    http:
      path: /
  authProbes:
    - authName: basicAuth
      params:
        - name: repository
          type: string
      probe:
        http:
          path: /{{- range .Connector.Spec.Auth.Params }}{{- if eq .Name "repository" }}{{ .Value.StringVal }}{{ end }}{{- end }}/info/refs?service=git-upload-pack
          httpHeaders:
          - name: Authorization
            value: >-
              {{- if .Secret }}Basic {{ printf "%s:%s" .Secret.StringData.username .Secret.StringData.password | b64enc }} {{- end }}

    更多