访问实例

客户端通过 operator 创建的 Service 访问 Alauda Data Services Analytical Database E1,并使用您在实例 spec 中声明的用户进行身份验证。

Service

默认会创建两种 Service:

Service名称形态用途
实例级clickhouse-<instance>LoadBalancer,外部流量策略为 Local客户端入口点。仅选择已就绪的主机。
每个主机chi-<instance>-<cluster>-<shard>-<replica>无头(ClusterIP: None),发布未就绪地址稳定的每 Pod DNS。用于复制以及定位单个主机。

除非您提供 clusterServiceTemplate 或 shardServiceTemplate,否则不会创建集群级和分片级 Service。没有这些模板,就不存在此类对象,因此不要针对它们的名称编写客户端配置。

WARNING

实例级 Service 的类型默认为 LoadBalancer。在没有负载均衡器提供商的集群上,它将一直没有外部地址。如果您只希望在集群内访问,请使用 Service 模板覆盖该类型:

spec:
  defaults:
    templates:
      serviceTemplate: internal
  templates:
    serviceTemplates:
      - name: internal
        spec:
          type: ClusterIP
          ports:
            - name: http
              port: 8123
            - name: tcp
              port: 9000

Service 模板中的端口号会经过验证,必须介于 1 和 65535 之间。

端口

端口名称协议
8123httpHTTP 接口
9000tcpNative 协议
9009interserverReplica 到 Replica 的数据交换。不是客户端端口。

连接

集群内,Native 协议:

kubectl -n <namespace> run ch-client --rm -it --restart=Never \
  --image=<server-image> -- \
  clickhouse-client -h clickhouse-<instance>.<namespace>.svc.cluster.local \
  -u <user> --password <password>

集群内,HTTP:

curl "http://clickhouse-<instance>.<namespace>.svc.cluster.local:8123/" \
  -u "<user>:<password>" --data-binary "SELECT version()"

定位到某个特定主机,例如检查单个从节点:

kubectl -n <namespace> exec chi-<instance>-<cluster>-0-0-0 -c clickhouse -- \
  clickhouse-client -q "SELECT hostName(), uptime()"

用户

用户、配置文件和配额在 spec.configuration 下声明,并渲染到服务器的 users.d 目录中。spec.configuration.settings 下的设置则会渲染到 config.d。

apiVersion: clickhouse.altinity.com/v1
kind: ClickHouseInstallation
metadata:
  name: e1-users
spec:
  configuration:
    users:
      # plain password — acceptable only for non-production
      app/password: <password>
      app/networks/ip:
        - "10.0.0.0/8"
      app/profile: app_profile
      app/quota: app_quota
      app/allow_databases/database:
        - analytics
      # preferred: SHA-256 hex of the password
      admin/password_sha256_hex: <sha256-hex>
      admin/networks/ip:
        - "::/0"
      reporting/profile: readonly
    profiles:
      app_profile/max_memory_usage: "10000000000"
      readonly/readonly: "1"
    quotas:
      app_quota/interval/duration: "3600"
    clusters:
      - name: main
        layout:
          shardsCount: 1
          replicasCount: 1

键的语法类似路径:第一个 / 之前的所有内容都是用户、配置文件或配额名称,其余内容则是其下的 XML 路径。对列表值重复使用同一个键,可生成多个元素。

使用以下命令生成密码哈希:

printf '%s' '<password>' | sha256sum | cut -d' ' -f1

有意限制 default 用户

随附的 operator 默认设置会为 default 用户分配 default 配置文件、default 配额,以及仅允许 ::1 和 127.0.0.1 的网络允许列表。因此,它无法从其他 pod 使用。请声明您自己的用户,而不要放宽 default。

operator 还会为每个帐户添加一个主机正则表达式,使其匹配实例自身 pod 的名称。这是额外的允许条件,而不是第二个限制:ClickHouse 会接受匹配 networks 下任意条目的连接。它绝不会阻止 networks/ip 允许的连接,因此请通过收窄 networks/ip 来限制访问。

operator 自有帐户

operator 会连接到每台服务器,以读取指标、维护架构并清除 DNS 缓存。它使用自有帐户,通过 HTTP 端口连接,并采用较短的连接和查询超时时间;其凭据从 operator 配置中指定的 Secret 读取。请勿删除或挪作他用该帐户:没有它,架构传播和指标收集都会停止。

集群共享 Secret

集群内的服务器间通信可以使用共享 Secret 进行身份验证,并按集群声明:

spec:
  configuration:
    clusters:
      - name: main
        secret:
          valueFrom:
            secretKeyRef:
              name: main-cluster-secret
              key: secret
        layout:
          shardsCount: 2
          replicasCount: 2

请在创建实例之前,在同一命名空间中创建该 Secret,并在指定键下设置任意随机值。可选方案包括 value,它会将 Secret 写入实例清单中的明文;以及 auto: "yes",它会要求 operator 自行生成并存储该值。

WARNING

请勿在 ACP 上使用 auto: "yes"。operator 的角色仅授予对 Secret 执行 get 和 list 的权限,因此无法创建生成的 Secret;pod 随后会在 CreateContainerConfigError 中因 secret "<instance>-<cluster>-auto-secret" not found 永久等待。请使用 secretKeyRef。

文件

可以使用 spec.configuration.files 注入任意配置文件,其中每个键都是文件名,值是文件内容。二进制内容可以使用 YAML !!binary 标记。可以为文件名前缀指定目标目录:common、users 或 host。未知前缀和子目录会被忽略,因此文件未出现时,通常是前缀拼写错误。


ClickHouse 是 ClickHouse, Inc. 的注册商标。https://clickhouse.com

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