Начало работы с Terraform для Knowledge Graph

Узнайте, как настроить Terraform для управления ресурсами Grafana Cloud Knowledge Graph. В этом руководстве описано, как настроить провайдер Grafana Terraform и подготовить окружение.

Прежде чем начать

Прежде чем начать, убедитесь, что у вас есть следующее:

  • Учётная запись Grafana Cloud, как описано в разделе Get started
  • Установленный на вашем компьютере Terraform
  • Права администратора в вашем экземпляре Grafana

Note

Включать Knowledge Graph перед использованием Terraform не нужно. Ресурс grafana_asserts_stack выполняет весь процесс подключения, включая включение Knowledge Graph в вашем стеке.

Note

Все файлы конфигурации Terraform следует сохранить в одном каталоге.

Настройка провайдера Grafana

Эта конфигурация Terraform настраивает провайдер Grafana для обеспечения необходимой аутентификации при управлении ресурсами Knowledge Graph.

Вы можете использовать конфигурацию, аналогичную описанной в разделе Creating and managing a Grafana Cloud stack using Terraform, чтобы настроить сервисную учётную запись и токен.

Шаги

  1. Создайте сервисную учётную запись и токен в Grafana.

    Чтобы создать новые, обратитесь к разделу Service account tokens.

  2. Создайте файл с именем main.tf и добавьте в него следующее:

    terraform
    terraform {
      required_providers {
        grafana = {
          source  = "grafana/grafana"
          version = ">= 2.9.0"
        }
      }
    }
    
    provider "grafana" {
      alias = "asserts"
    
      url      = "<Stack-URL>"
      auth     = "<Service-account-token>"
      stack_id = "<Stack-ID>"
    }
  3. Замените следующие значения полей:

    • <Stack-URL> на URL вашего стека Grafana (например, https://my-stack.grafana.net/)
    • <Service-account-token> на созданный вами токен сервисной учётной записи
    • <Stack-ID> на ID вашего стека Grafana Cloud

Note

Параметр stack_id обязателен для ресурсов Knowledge Graph, чтобы определить стек, которому принадлежат ресурсы.

Применение конфигураций Terraform

После создания файлов конфигурации Terraform примените их с помощью следующих команд:

  1. Инициализируйте рабочий каталог, содержащий файлы конфигурации Terraform:

    shell
    terraform init
  2. Просмотрите изменения, которые внесёт Terraform:

    shell
    terraform plan
  3. Примените файлы конфигурации:

    shell
    terraform apply

Проверка настройки

После применения конфигурации проверьте настройку, убедившись, что:

  • Terraform может аутентифицироваться в вашем стеке Grafana Cloud
  • Провайдер правильно настроен с корректным ID стека
  • В выводе Terraform нет ошибок

Рекомендации

При управлении ресурсами Knowledge Graph с помощью Terraform учитывайте следующие рекомендации.

Соглашения об именовании

  • Используйте описательные имена, которые ясно указывают назначение каждого ресурса
  • Придерживайтесь единообразного шаблона именования во всей вашей организации
  • Включайте в имена идентификаторы среды или команды, когда это уместно

Контроль версий

  • Храните конфигурации Terraform в системе контроля версий (Git)
  • Используйте отдельные каталоги или рабочие пространства для разных сред
  • Документируйте изменения в сообщениях коммитов

Управление состоянием

  • Используйте удалённые бэкенды состояния для совместной работы команды
  • Включите блокировку состояния, чтобы предотвратить одновременные изменения
  • Регулярно создавайте резервные копии файлов состояния Terraform

Безопасность

  • Никогда не коммитьте токены сервисных учётных записей или конфиденциальные данные в систему контроля версий
  • Используйте переменные среды или инструменты управления секретами для учётных данных
  • Регулярно меняйте токены сервисных учётных записей

Дальнейшие шаги

Теперь, когда вы настроили провайдер Terraform, вы можете начать управлять ресурсами Knowledge Graph: