coralogixrepo/coralogix-operator

Coralogix Operator 镜像文档

1. 镜像概述和主要用途

Coralogix Operator 是 Coralogix 官方提供的 Kubernetes Operator，提供 Kubernetes 原生的部署和管理能力，用于简化和自动化 Kubernetes 集群中 Coralogix 及相关组件的配置。其核心目标是通过 Kubernetes 原生机制（如自定义资源）统一管理 Coralogix APIs 配置，降低手动操作复杂度，提升配置一致性和可维护性。

2. 核心功能和特性

• Kubernetes 自定义资源（CR）支持：通过定义和使用 Kubernetes 自定义资源（Custom Resources），实现对 Coralogix 组件的声明式管理。
• 多组件管理：支持部署和管理 Coralogix 相关核心组件，包括但不限于：
  • Alerts（告警规则）
  • RecordingRuleGroupSets（记录规则组集）
  • RuleGroups（规则组）

3. 使用场景和适用范围

3.1 典型使用场景

• 在 Kubernetes 集群中集成 Coralogix，需集中管理告警规则、记录规则组等配置。
• 自动化 Coralogix 组件的部署、更新和生命周期管理，减少手动操作。
• 通过 GitOps 流程（如 ArgoCD、Flux）管理 Coralogix 配置，实现配置即代码（Configuration as Code）。

3.2 适用范围

• 运行 Kubernetes 集群（版本需兼容 Operator 要求）的企业或团队。
• 需要在 Kubernetes 环境中配置、部署和管理 Coralogix 相关组件的场景。

4. 使用方法和配置说明

4.1 部署准备

• 环境要求：
  • Kubernetes 集群（版本 ≥ 1.21，具体兼容版本参考官方说明）。
  • kubectl 工具（已配置集群访问权限）。
  • 集群内可访问 Coralogix 服务端点及镜像仓库。

4.2 部署 Coralogix Operator

4.2.1 安装 CRD

首先部署 Operator 所需的自定义资源定义（CRD）：

yaml
# coralogix-operator-crds.yaml
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: alerts.coralogix.com
spec:
  group: coralogix.com
  names:
    kind: Alert
    listKind: AlertList
    plural: alerts
    singular: alert
  scope: Namespaced
  versions:
    - name: v1alpha1
      served: true
      storage: true
      schema:
        openAPIV3Schema:
          type: object
          properties:
            spec:
              type: object
              properties:
                name:
                  type: string
                condition:
                  type: string
                severity:
                  type: string
                # 更多字段参考官方CRD定义
---
# 其他CRD（如recordingrulegroupsets、rulegroups等）类似，需根据官方提供的CRD文件部署

执行部署命令：

bash
kubectl apply -f coralogix-operator-crds.yaml

4.2.2 部署 Operator 实例

通过 Deployment 部署 Operator：

yaml
# coralogix-operator-deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: coralogix-operator
  namespace: coralogix
spec:
  replicas: 1
  selector:
    matchLabels:
      app: coralogix-operator
  template:
    metadata:
      labels:
        app: coralogix-operator
    spec:
      containers:
        - name: operator
          image: docker.xuanyuan.run/coralogix/operator:latest  # 替换为具体版本镜像
          command: ["/coralogix-operator"]
          args: ["--metrics-addr=:8080", "--enable-leader-election"]
          resources:
            limits:
              cpu: 100m
              memory: 128Mi
            requests:
              cpu: 100m
              memory: 64Mi

执行部署命令：

bash
kubectl create namespace coralogix
kubectl apply -f coralogix-operator-deployment.yaml -n coralogix

4.3 创建自定义资源示例

4.3.1 创建 Alert 资源

yaml
# example-alert.yaml
apiVersion: coralogix.com/v1alpha1
kind: Alert
metadata:
  name: high-error-rate
  namespace: coralogix
spec:
  name: "High Error Rate Alert"  # 告警名称
  condition: "sum(rate(http_requests_total{status=~\"5..\"}[5m])) / sum(rate(http_requests_total[5m])) > 0.05"  # 告警条件（PromQL表达式）
  severity: "critical"  # 告警级别
  description: "Error rate exceeds 5% for 5 minutes"  # 告警描述
  annotations:
    runbook_url: "https://example.com/runbooks/high-error-rate"  # 运行手册URL

部署命令：

bash
kubectl apply -f example-alert.yaml

4.3.2 创建 RuleGroup 资源

yaml
# example-rulegroup.yaml
apiVersion: coralogix.com/v1alpha1
kind: RuleGroup
metadata:
  name: api-server-rules
  namespace: coralogix
spec:
  name: "api-server"  # 规则组名称
  rules:
    - record: "http_requests_per_second"  # 记录规则名称
      expr: "rate(http_requests_total[5m])"  # 计算表达式
      labels:
        service: "api-server"  # 附加标签

部署命令：

bash
kubectl apply -f example-rulegroup.yaml

4.4 配置参数说明

自定义资源的具体配置参数需参考官方定义的 CRD 结构，核心字段说明如下：

Alert 资源核心字段

• spec.name：告警显示名称，用于标识告警。
• spec.condition：告警触发条件，通常为 PromQL 表达式。
• spec.severity：告警级别（如 critical、warning、info）。
• spec.description：告警详细描述，说明触发原因和影响。
• spec.annotations：附加信息（如运行手册 URL、联系人等）。

RuleGroup 资源核心字段

• spec.name：规则组名称，用于归类相关规则。
• spec.rules：规则列表，包含记录规则（record）或告警规则（alert）。
  • record：定义需持久化的指标名称。
  • expr：指标计算表达式（PromQL）。
  • labels：附加到指标的标签，用于过滤和聚合。

5. 注意事项

• 部署前需确认 Kubernetes 集群版本与 Operator 兼容。
• 自定义资源的配置需符合 CRD 定义的字段约束，避免格式错误。
• Operator 自身的日志和监控可通过配置 spec.containers[0].args 中的 --metrics-addr 暴露指标，结合 Prometheus 采集。