Connectors CSI 驱动

概述

Connectors CSI Driver 是一种基于 Container Storage Interface (CSI) 规范实现的存储驱动。它可以将 Connector 中的配置作为卷挂载到 Kubernetes 工作负载中。主要特性包括:

  • 将来自 Connector 的配置文件挂载到 Pod 中
  • 支持在配置文件中进行动态变量渲染,以自动注入运行时信息
  • 支持同时挂载多个配置文件

所有配置数据都来自与 Connector 关联的 ConnectorClass 配置。

快速开始

1. 创建一个 ConnectorClass

首先,创建一个包含 Git 配置的 ConnectorClass:

cat << EOF | kubectl apply -f -
apiVersion: connectors.alauda.io/v1alpha1
kind: ConnectorClass
metadata:
  name: my-git
spec:
  address:
    type: string
  configurations:
  - name: config
    data:
      .gitconfig: |
        this is git config
EOF

2. 创建一个 Connector

然后,创建一个连接到 GitHub 的 Connector:

cat << EOF | kubectl apply -f -
apiVersion: connectors.alauda.io/v1alpha1
kind: Connector
metadata:
  name: git-connector
spec:
  address: https://github.com
  connectorClassName: my-git
EOF

3. 使用 CSI Driver 创建一个 Pod

现在,我们可以创建一个 Pod,用于挂载来自 ConnectorClass 的配置:

cat << EOF | kubectl create -f -
apiVersion: v1
kind: Pod
metadata:
  name: csi-demo
  namespace: default
spec:
  restartPolicy: Never
  containers:
  - name: web
    image: docker-mirrors.alauda.cn/bitnami/git:2.47.1
    imagePullPolicy: IfNotPresent
    command:
    - "sleep"
    args: [ "3600" ]
    volumeMounts:
    - name: git-config
      mountPath: /tmp/config
  volumes:
  - name: git-config
    csi:
      readOnly: true
      driver: connectors-csi
      volumeAttributes:
        connector.name: "git-connector"
        connector.namespace: "default"
        configuration.names: "config"
EOF

4. 配置访问权限

要允许 Pod 访问 Connector 的配置,必须授予该 Pod 的 ServiceAccount 读取 Connector 资源的权限:

cat << EOF | kubectl apply -f -
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
  name: default-sa-connectors-connector-viewer
  namespace: default
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: connectors-connector-viewer-role
subjects:
- kind: ServiceAccount
  name: default
  namespace: default
EOF

Pod 运行后,你可以使用以下命令检查已挂载配置文件的内容:

kubectl exec -ti csi-demo -- cat /tmp/config/.gitconfig

配置说明

CSI 卷配置参数

参数名称必需说明
readOnly是必须设置为 true
driver是固定值:connectors-csi

volumeAttributes 参数

参数名称必需说明
connector.name是Connector 的名称
connector.namespace否Connector 的命名空间,默认为 Pod 的命名空间
configuration.names是以逗号分隔的要挂载的配置名称列表
token.expiration否令牌的过期时间,默认为 30m

配置名称说明

configuration.names 参数必须与 ConnectorClass 中定义的配置名称相对应。例如:

kind: ConnectorClass
apiVersion: connectors.alauda.io/v1alpha1
spec:
  configurations:
  - name: config1
    data:
      key1.txt: value1
      key2.txt: value2
  - name: config2
    data:
      file1.txt: file-value1
      file2.txt: file-value2

挂载单个配置:

kind: Pod
apiVersion: v1
spec:
  volumes:
  - name: config
    csi:
      driver: connectors-csi
      volumeAttributes:
        configuration.names: "config1"  # Will mount key1.txt and key2.txt

挂载多个配置:

kind: Pod
apiVersion: v1
spec:
  volumes:
  - name: config
    csi:
      driver: connectors-csi
      volumeAttributes:
        configuration.names: "config1,config2"  # Will mount all configuration files

注意:如果多个配置中存在同名文件,后面的配置会覆盖前面的配置。

配置文件渲染

CSI Driver 在挂载配置文件时会执行变量渲染,使用 Go template 语法。

可用变量

变量说明
.connector.status.proxyAddressConnector 的代理地址;参见 connectors-proxy
.connector.spec.addressConnector 的目标地址
.context.token用于访问代理服务的身份验证令牌
.context.proxy.caCert用于访问 connectors proxy(forward proxy)的 CA 证书;参见 connectors-proxy

内置函数

有关支持的函数,请参阅 sprig

例如:b64enc:对字符串进行 Base64 编码

关于代理服务

Connectors 为每个 Connector 提供一个代理服务,使客户端能够访问目标资源,而无需存储原始凭据。有关更多详细信息,请参阅 connectors-proxy。