#Установка

В этой главе описывается, как установить следующие плагины логирования: Alauda Container Platform Log Essentials, Alauda Container Platform Log Collector, Alauda Container Platform Log Storage for ClickHouse и Alauda Container Platform Log Storage for Elasticsearch.

#Планирование установки

Плагины Alauda Container Platform Log Storage можно устанавливать в любом кластере, и для сбора логов можно выбрать компонент хранилища логов любого кластера, чтобы взаимодействовать с данными хранилища.

Поэтому перед установкой плагина log storage необходимо спланировать кластер и узел, на котором будет установлен компонент log storage.

• Не размещайте плагины log storage в кластере global. Вместо этого разворачивайте их в workload-кластерах, чтобы сбои управляющего кластера не нарушали решение проблем на основе логов.

• Сначала стремитесь централизовать логи в одном кластере log storage. Если объем логов превышает порог максимальной емкости, распределяйте логи по нескольким кластерам хранилища.

• Развертывайте как минимум один экземпляр log storage в каждой сетевой зоне, чтобы агрегировать логи локально и минимизировать межцентровой трафик по публичной сети (что приводит к высоким затратам и задержкам).

• Выделяйте для log storage отдельные узлы, не размещая его вместе с другими приложениями или компонентами платформы. Для log storage требуется высокая пропускная способность ввода-вывода, и он может быть подвержен влиянию помех.

• Подключайте выделенные SSD-диски для log storage, чтобы существенно повысить производительность.

#Установка Alauda Container Platform Log Essentials

#Console

1. Перейдите в Marketplace > Cluster Plugins и выберите кластер global.

2. Нажмите кнопку действий справа от Alauda Container Platform Log Essentials и выберите Install.

3. Нажмите Install.

#YAML

1. Проверьте доступные версии

Убедитесь, что плагин был опубликован, проверив ресурсы ModulePlugin и ModuleConfig в кластере global:

# kubectl get moduleplugin | grep log-api
log-api                       30h
# kubectl get moduleconfig | grep log-api
log-api-v4.2.0                30h

Это означает, что ModulePlugin log-api существует в кластере и опубликована версия v4.2.0.

2. Создайте ModuleInfo

Создайте ресурс ModuleInfo для установки плагина без каких-либо параметров конфигурации:

apiVersion: cluster.alauda.io/v1alpha1
kind: ModuleInfo
metadata:
  annotations:
    cpaas.io/display-name: log-api
    cpaas.io/module-name: '{"en": "Alauda Container Platform Log Essentials", "zh":
      "Alauda Container Platform Log Essentials"}'
  labels:
    cpaas.io/cluster-name: global
    cpaas.io/module-name: log-api
    cpaas.io/module-type: plugin
    cpaas.io/product: Platform-Center
  name: global-b4a67e6adb67bad47544354e9bf2bdff
spec:
  version: v4.2.0
  valuesOverride:
    ait/chart-alauda-log-api:
      global:
        nodeSelector:
          node-role.kubernetes.io/infra: "true"
        tolerations:
        - effect: NoSchedule
          key: node-role.kubernetes.io/infra
          value: reserved
          operator: Equal

Справка по полям YAML:

3. Проверьте установку

Поскольку имя ModuleInfo изменяется при создании, найдите ресурс по метке, чтобы проверить статус и версию плагина:

kubectl get moduleinfo -l cpaas.io/module-name=log-api
NAME                                             CLUSTER         MODULE      DISPLAY_NAME   STATUS    TARGET_VERSION   CURRENT_VERSION   NEW_VERSION
global-e671599464a5b1717732c5ba36079795          global          log-api   log-api      Running   v4.2.0          v4.2.0           v4.2.0

Пояснения к полям:

• NAME: Имя ресурса ModuleInfo
• CLUSTER: Кластер, в который установлен плагин
• MODULE: Имя плагина
• DISPLAY_NAME: Отображаемое имя плагина
• STATUS: Статус установки; Running означает, что установка выполнена успешно и плагин запущен
• TARGET_VERSION: Целевая версия установки
• CURRENT_VERSION: Версия до установки
• NEW_VERSION: Последняя доступная версия для установки

#Установка Alauda Container Platform Log Storage for Elasticsearch

#Console

1. Перейдите в Marketplace > Cluster Plugins и выберите целевой кластер.

2. Нажмите кнопку действий справа от Alauda Container Platform Log Storage for Elasticsearch и выберите Install.

3. Ознакомьтесь со следующими инструкциями для настройки соответствующих параметров.

   Параметр	Описание
   External Elasticsearch	Оставьте этот переключатель выключенным, чтобы установить управляемый платформой плагин хранения Elasticsearch.
   size	Выберите Single Node, Small Cluster или Big Cluster в зависимости от целевого масштаба.
   Storage Method	Выберите LocalVolume или StorageClass для backend-хранилища.
   Log Node	Отображается при использовании LocalVolume. Выберите узлы данных Elasticsearch.
   Storage path on host	Отображается при использовании LocalVolume. Введите абсолютный путь на хосте для данных Elasticsearch.
   Capacity	Зарезервируйте емкость хранилища в Gi для текущего раздела данных. На странице эта метка используется и для данных Elasticsearch, и для данных Kafka.
   Log data nodes resources	Настройте requests и limits CPU и памяти для узлов данных Elasticsearch.
   Kafka Nodes	Выберите узлы Kafka, используемые плагином.
   LogPlatform / LogWorkload / LogSystem / LogKubernetes / Kubernetes Event / Audit	Настройте срок хранения в днях по типам логов в разделе Log reserve config, in days.

4. Нажмите Install.

#YAML

1. Проверьте доступные версии

Убедитесь, что плагин был опубликован, проверив ресурсы ModulePlugin и ModuleConfig в кластере global:

# kubectl get moduleplugin | grep logcenter
logcenter                       30h
# kubectl get moduleconfig | grep logcenter
logcenter-v4.1.0                30h

Это означает, что ModulePlugin logcenter существует в кластере и опубликована версия v4.1.0.

2. Создайте ModuleInfo

Создайте ресурс ModuleInfo для установки плагина без каких-либо параметров конфигурации:

apiVersion: cluster.alauda.io/v1alpha1
kind: ModuleInfo
metadata:
  annotations:
    cpaas.io/display-name: logcenter
    cpaas.io/module-name: '{"en": "Alauda Container Platform Log Storage for Elasticsearch", "zh": "Alauda Container Platform Log Storage for Elasticsearch"}'
  labels:
    cpaas.io/cluster-name: go
    cpaas.io/module-name: logcenter
    cpaas.io/module-type: plugin
    cpaas.io/product: Platform-Center
  name: <cluster>-log-center
spec:
  config:
    self:
      storage:
        disabled: false
    components:
      elasticsearch:
        address: ""
        basicAuthSecretName: ""
        hostpath: /cpaas/data/elasticsearch
        httpPort: 9200
        install: true
        k8sNodes:
        - 192.168.139.75
        masterK8sNodes: []
        masterReplicas: 0
        masterResources:
          limits:
            cpu: "2"
            memory: 4Gi
          requests:
            cpu: 200m
            memory: 256Mi
        masterStorageSize: 5
        nodeReplicas: 1
        nodeStorageSize: 200
        resources:
          limits:
            cpu: "4"
            memory: 4Gi
          requests:
            cpu: "1"
            memory: 1Gi
        tcpPort: 9300
        type: single
      kafka:
        address: ""
        auth: true
        basicAuthSecretName: ""
        exporterPort: 9308
        install: true
        k8sNodes:
        - 192.168.139.75
        port: 9092
        storageSize: 10
        tls: true
        zkElectPort: 3888
        zkExporterPort: 9141
        zkLeaderPort: 2888
        zkPort: 2181
      kibana:
        install: false
      storageClassConfig:
        name: elasticsearch-local-log-sc
        type: LocalVolume
      zookeeper:
        storageSize: 1
    ttl:
      audit: 180
      event: 180
      logKubernetes: 7
      logPlatform: 7
      logSystem: 7
      logWorkload: 7
  version: v4.1.0
  valuesOverride:
    ait/chart-alauda-log-center:
      global:
        nodeSelector:
          node-role.kubernetes.io/infra: "true"
        tolerations:
        - effect: NoSchedule
          key: node-role.kubernetes.io/infra
          value: reserved
          operator: Equal

Справка по полям YAML:

3. Проверьте установку

Поскольку имя ModuleInfo изменяется при создании, найдите ресурс по метке, чтобы проверить статус и версию плагина:

kubectl get moduleinfo -l cpaas.io/module-name=logcenter
NAME                                             CLUSTER         MODULE      DISPLAY_NAME   STATUS    TARGET_VERSION   CURRENT_VERSION   NEW_VERSION
global-e671599464a5b1717732c5ba36079795          global          logcenter   logcenter      Running   v4.0.12          v4.0.12           v4.0.12

Пояснения к полям:

• NAME: Имя ресурса ModuleInfo
• CLUSTER: Кластер, в который установлен плагин
• MODULE: Имя плагина
• DISPLAY_NAME: Отображаемое имя плагина
• STATUS: Статус установки; Running означает, что установка выполнена успешно и плагин запущен
• TARGET_VERSION: Целевая версия установки
• CURRENT_VERSION: Версия до установки
• NEW_VERSION: Последняя доступная версия для установки

#Размещение на infra-узлах

Если вы хотите, чтобы workloads плагина хранения Elasticsearch запускались на выделенных infra-узлах, используйте конфигурацию YAML плагина вместо изменения сгенерированных workloads после установки.

Настройте следующие поля в spec.valuesOverride.ait/chart-alauda-log-center.global:

valuesOverride:
  ait/chart-alauda-log-center:
    global:
      nodeSelector:
        node-role.kubernetes.io/infra: "true"
      tolerations:
        - effect: NoSchedule
          key: node-role.kubernetes.io/infra
          value: reserved
          operator: Equal

Перед применением этих правил планирования убедитесь, что планирование infra-узлов и размещение локального хранилища совместимы. Рекомендации по планированию узлов см. в Планирование infra-узлов для хранения логов.

#Установка Alauda Container Platform Log Storage for ClickHouse

#Console

Если вы планируете использовать S3 для хранения данных логов ClickHouse или холодного хранилища, подготовьте необходимый S3 Secret до установки. Полную процедуру, включая формат Secret, Secret для HTTPS CA certificate и режимы использования, см. в Как использовать S3 storage с ClickHouse.

1. Перейдите в Marketplace > Cluster Plugins и выберите целевой кластер.

2. Нажмите кнопку действий справа от Alauda Container Platform Log Storage for ClickHouse и выберите Install.

3. Ознакомьтесь со следующими инструкциями для настройки соответствующих параметров.

   Параметр	Описание
   Size	Выберите Single Node, Small Cluster или Big Cluster в зависимости от целевого масштаба.
   Storage Policy	Управляет тем, как ClickHouse хранит метаданные и данные логов. Доступные значения: Default и Separation of storage and compute. Этот параметр нельзя изменить после установки.
   Storage Method	Отображается, когда Storage Policy установлено в Default. Доступные значения: LocalVolume и StorageClass.
   Metadata Storage Type	Отображается, когда Storage Policy установлено в Separation of storage and compute. Доступные значения: LocalVolume и StorageClass.
   Log Node	Отображается при использовании локального хранилища. В режиме Default выберите узлы, которые локально хранят данные логов ClickHouse. В режиме Separation of storage and compute выберите узлы, которые локально хранят метаданные ClickHouse.
   Storage Path on Host	Отображается, когда Storage Policy установлено в Default, а Storage Method — LocalVolume. Значение по умолчанию: /cpaas/data/clickhouse.
   Metadata Storage Path	Отображается, когда Metadata Storage Type — LocalVolume. Значение по умолчанию: /cpaas/data/clickhouse.
   Log Replicas	Отображается, когда выбранный режим хранения использует StorageClass. Настройте количество реплик ClickHouse, создаваемых для активного раздела хранения.
   StorageClass	Отображается, когда Storage Policy установлено в Default, а Storage Method — StorageClass. Выберите StorageClass, используемый для данных логов ClickHouse.
   Metadata StorageClass	Отображается, когда Metadata Storage Type — StorageClass. Выберите StorageClass, используемый для метаданных ClickHouse.
   Capacity	Отображается, когда Storage Policy установлено в Default. Зарезервируйте емкость в Gi для данных логов ClickHouse.
   Metadata Capacity	Зарезервируйте емкость в Gi для метаданных ClickHouse. На странице рекомендуется 20 Gi.
   Advanced Configuration	Сворачиваемый раздел для параметров планирования на уровне плагина.
   Node Selectors	Отображается в Advanced Configuration. Настройте правила node selector на уровне плагина для workloads плагина хранения ClickHouse.
   Node Tolerations	Отображается в Advanced Configuration. Настройте правила toleration на уровне плагина для workloads плагина хранения ClickHouse.
   S3 for Log Data	Отображается, когда Storage Policy установлено в Separation of storage and compute. Выберите подготовленный S3 Secret для хранения данных логов. Этот параметр нельзя изменить после установки.
   Log Platform / Log Workload / Log System / Log Kubernetes / Kubernetes Event / Audit	Настройте срок хранения горячих данных в днях по типам логов в разделе Log Retention Settings.
   Cold and Hot Separate	Включает многоуровневое хранилище для ClickHouse. После включения можно настроить S3-расположение для холодных данных и задать срок хранения холодных данных в днях по типам логов. Этот переключатель нельзя изменить после установки.
   S3 for Log Cold Data	Отображается, когда включено Cold and Hot Separate. Выберите подготовленный S3 Secret для хранения холодных данных. Этот параметр нельзя изменить после установки.
   Log Platform / Log Workload / Log System / Log Kubernetes / Kubernetes Event / Audit	Когда включено Cold and Hot Separate, раздел настроек cold-storage использует те же имена полей для хранения сроков хранения холодных данных. Значение 0 означает, что тип логов не переносится в cold storage.

4. Нажмите Install.

#YAML

1. Проверьте доступные версии

Убедитесь, что плагин был опубликован, проверив ресурсы ModulePlugin и ModuleConfig в кластере global:

# kubectl get moduleplugin | grep logclickhouse
logclickhouse                       30h
# kubectl get moduleconfig | grep logclickhouse
logclickhouse-v4.1.0                30h

Это означает, что ModulePlugin logclickhouse существует в кластере и опубликована версия v4.1.0.

2. Создайте ModuleInfo

Создайте ресурс ModuleInfo для установки плагина. В следующем примере используется Separation of storage and compute вместе с cold storage на базе S3:

apiVersion: cluster.alauda.io/v1alpha1
kind: ModuleInfo
metadata:
  name: global-logclickhouse
  labels:
    cpaas.io/cluster-name: global
    cpaas.io/module-name: logclickhouse
    cpaas.io/module-type: plugin
spec:
  version: v4.1.0
  config:
    components:
      nodeSelector:
        - key: kubernetes.io/os
          value: linux
      tolerations:
        - effect: NoSchedule
          key: node-role.kubernetes.io/infra
          operator: Exists
      clickhouse:
        storagePolicy:
          type: SSC
          sscSpec:
            metaStorage:
              type: LocalVolume
              size: 20
              localVolumeSpec:
                nodes:
                  - xxx.xxx.xxx.xx
                path: /cpaas/data/clickhouse
            dataStorage:
              type: S3
              s3Spec:
                credentials: clickhouse-s3-config
        tieredPolicy:
          enabled: true
          coldStorage:
            type: S3
            s3Spec:
              credentials: clickhouse-cold-s3-config
          coldTTL:
            audit: 30
            event: 30
            logKubernetes: 30
            logPlatform: 30
            logSystem: 30
            logWorkload: 30
        resources:
          limits:
            cpu: "2"
            memory: 4Gi
          requests:
            cpu: 200m
            memory: 256Mi
        ttl:
          audit: 180
          event: 180
          logKubernetes: 7
          logPlatform: 7
          logSystem: 7
          logWorkload: 7
        type: normal
      razor:
        resources:
          limits:
            cpu: "2"
            memory: 1Gi
          requests:
            cpu: 10m
            memory: 256Mi
      vector:
        resources:
          limits:
            cpu: "4"
            memory: 1Gi
          requests:
            cpu: 10m
            memory: 256Mi

Справка по полям YAML (ClickHouse):

Примечания к обновлению:

• При обновлении плагина хранения ClickHouse нельзя переключать тип Storage Policy или включать/выключать Cold and Hot Separate.
• После установки следует изменять только эффективные настройки хранения, такие как сроки хранения hot- или cold-данных.
• Чтобы использовать эту возможность, обновляйте Alauda Container Platform Log Essentials и Alauda Container Platform Log Storage for ClickHouse до совместимых версий одновременно.
• В сценариях disaster recovery используйте разные S3 buckets для основного и резервного развертываний ClickHouse.

3. Проверьте установку

Поскольку имя ModuleInfo изменяется при создании, найдите ресурс по метке, чтобы проверить статус и версию плагина:

kubectl get moduleinfo -l cpaas.io/module-name=logclickhouse
NAME                                             CLUSTER         MODULE      DISPLAY_NAME   STATUS    TARGET_VERSION   CURRENT_VERSION   NEW_VERSION
global-e671599464a5b1717732c5ba36079795          global          logclickhouse   logclickhouse      Running   v4.0.12          v4.0.12           v4.0.12

Пояснения к полям:

• NAME: Имя ресурса ModuleInfo
• CLUSTER: Кластер, в который установлен плагин
• MODULE: Имя плагина
• DISPLAY_NAME: Отображаемое имя плагина
• STATUS: Статус установки; Running означает, что установка выполнена успешно и плагин запущен
• TARGET_VERSION: Целевая версия установки
• CURRENT_VERSION: Версия до установки
• NEW_VERSION: Последняя доступная версия для установки

#Размещение на infra-узлах

Если вы хотите, чтобы workloads плагина хранения ClickHouse запускались на выделенных infra-узлах, настройте правила планирования на уровне плагина во время установки или обновления.

• В консоли используйте Advanced Configuration, чтобы задать Node Selectors и Node Tolerations.
• В YAML задайте spec.config.components.nodeSelector и spec.config.components.tolerations.

Пример:

config:
  components:
    nodeSelector:
      - key: kubernetes.io/os
        value: linux
    tolerations:
      - effect: NoSchedule
        key: node-role.kubernetes.io/infra
        operator: Exists

Перед применением этих правил планирования убедитесь, что планирование infra-узлов и размещение локального хранилища совместимы. Рекомендации по планированию узлов см. в Планирование infra-узлов для хранения логов.

#Установка плагина Alauda Container Platform Log Collector

#Console

1. Перейдите в Marketplace > Cluster Plugins и выберите целевой кластер.

2. Нажмите кнопку действий справа от Alauda Container Platform Log Collector и выберите Install.

3. Ознакомьтесь со следующими инструкциями для настройки соответствующих параметров.

   Параметр	Описание
   Storage Cluster	Выберите кластер, в котором установлен Alauda Container Platform Log Storage.
   Log types	Нажмите Select/Deselect, чтобы задать область сбора логов в кластере.
   Storage Path	Настройте локальный путь для рабочих данных Log Collector. Используйте абсолютный путь. Значение по умолчанию: /cpaas. Этот параметр нельзя изменить после установки.
   Log Collector Resources	Настройте requests и limits CPU и памяти для компонента Log Collector.

4. Нажмите Install.

#YAML

1. Проверьте доступные версии

Убедитесь, что плагин был опубликован, проверив ресурсы ModulePlugin и ModuleConfig в кластере global:

# kubectl get moduleplugin | grep logagent
logagent                       30h
# kubectl get moduleconfig | grep logagent
logagent-v4.3.1                30h

Это означает, что ModulePlugin logagent существует в кластере и опубликована версия v4.3.1.

2. Создайте ModuleInfo

Создайте ресурс ModuleInfo для установки плагина без каких-либо параметров конфигурации:

apiVersion: cluster.alauda.io/v1alpha1
kind: ModuleInfo
metadata:
  annotations:
    cpaas.io/display-name: logagent
    cpaas.io/module-name: '{"en": "Alauda Container Platform Log Collector", "zh": "Alauda Container Platform Log Collector"}'
  labels:
    cpaas.io/cluster-name: go
    cpaas.io/module-name: logagent
    cpaas.io/module-type: plugin
    cpaas.io/product: Platform-Center
    logcenter.plugins.cpaas.io/cluster: go
  name: <cluster>-log-agent
spec:
  config:
    crossClusterDependency:
      logcenter: go
      logclickhouse: null
    dataSource:
      audit: true
      event: true
      kubernetes: false
      platform: false
      system: true
      workload: true
    components:
      nodeSelector:
      - key: node-role.kubernetes.io/infra
        value: "true"
      tolerations:
      - effect: NoSchedule
        key: node-role.kubernetes.io/infra
        operator: Equal
        value: reserved
      nevermore:
        storageSpec:
          dataDir: /cpaas
        log:
          resources:
            limits:
              cpu: "2"
              ephemeral-storage: 1Gi
              memory: 4Gi
            requests:
              cpu: 100m
              memory: 512Mi
    storage:
      type: ElasticSearch
  version: v4.3.1

Справка по полям YAML (Log Collector):

3. Проверьте установку

Поскольку имя ModuleInfo изменяется при создании, найдите ресурс по метке, чтобы проверить статус и версию плагина:

kubectl get moduleinfo -l cpaas.io/module-name=logagent
NAME                                             CLUSTER         MODULE      DISPLAY_NAME   STATUS    TARGET_VERSION   CURRENT_VERSION   NEW_VERSION
global-e671599464a5b1717732c5ba36079795          global          logagent   logagent      Running   v4.3.1           v4.3.1            v4.3.1