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

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.

Посмотрите описание команды CLI для изменения трейла:

yc audit-trails trail update --help

Трейл можно изменить, указав его параметры одним из двух способов:

yc audit-trails trail update \
  --name <имя_трейла> \
  --new-name <новое_имя_трейла>

Terraform позволяет быстро создать облачную инфраструктуру в Yandex Cloud и управлять ею с помощью файлов конфигураций. В файлах конфигураций хранится описание инфраструктуры на языке HCL (HashiCorp Configuration Language). При изменении файлов конфигураций Terraform автоматически определяет, какая часть вашей конфигурации уже развернута, что следует добавить или удалить.

Terraform распространяется под лицензией Business Source License, а провайдер Yandex Cloud для Terraform — под лицензией MPL-2.0.

Подробная информация о ресурсах провайдера в документации на сайте Terraform или в зеркале.

Если у вас еще нет Terraform, установите его и настройте провайдер Yandex Cloud.

Чтобы управлять инфраструктурой с помощью Terraform от имени сервисного аккаунта или пользовательских аккаунтов: аккаунта на Яндексе, федеративного аккаунта и локального пользователя, аутентифицируйтесь соответствующим способом.

1. Чтобы изменить трейл, созданный с помощью Terraform, откройте файл конфигурации Terraform и измените фрагмент с описанием трейла:

   resource "yandex_audit_trails_trail" "basic_trail" {
     name        = "<имя_трейла>"
     folder_id   = "<идентификатор_каталога>"
     description = "<описание_трейла>"
     labels = {
       key = "value"
     }
     service_account_id = "<идентификатор_сервисного_аккаунта>"
   
     storage_destination {
       bucket_name   = "<имя_бакета>"
       object_prefix = "<префикс>"
     }
   
     filtering_policy {
       management_events_filter {
         resource_scope {
           resource_id   = "<идентификатор_организации_облака_или_каталога>"
           resource_type = "<тип>"
         }
       }
   
       data_events_filter {
         service         = "<имя_сервиса>"
         included_events = ["<полное_имя_события>"]
   
         resource_scope {
           resource_id   = "<идентификатор_организации_облака_или_каталога>"
           resource_type = "<тип>"
         }
       }
     }
   }
   

   Где:

   • name — имя создаваемого трейла. Требования к формату имени:

     • длина — от 3 до 63 символов;
     • может содержать строчные буквы латинского алфавита, цифры и дефисы;
     • первый символ — буква, последний — не дефис.

   • folder_id — идентификатор каталога, в котором создается трейл.

   • description — описание трейла. Необязательный параметр.

   • labels — список меток в формате ключ=значение. Необязательный параметр.

   • service_account_id — идентификатор сервисного аккаунта, от имени которого трейл собирает и загружает аудитные логи.

     В зависимости от области сбора аудитных логов сервисному аккаунту должна быть назначена роль audit-trails.viewer на организацию, облако или каталог, в которых трейл будет собирать аудитные логи.

   Укажите только один объект назначения: storage_destination, logging_destination или data_stream_destination.

   • logging_destination — загружать логи в лог-группу Yandex Cloud Logging.

     Замените блок storage_destination в шаблоне:

     logging_destination {
       log_group_id = "<идентификатор_лог_группы>"
     }
     
     • log_group_id — идентификатор лог-группы, в которую трейл будет сохранять аудитные логи.

   • storage_destination — загружать логи в бакет Yandex Object Storage:

     • bucket_name — имя бакета, куда трейл будет сохранять аудитные логи.

     • object_prefix — префикс, который будет присвоен объектам с аудитными логами в бакете. Необязательный параметр, участвует в полном имени файла аудитного лога.

       Примечание

       Используйте префикс, если вы храните аудитные логи и сторонние данные в одном и том же бакете. Не используйте одинаковый префикс для логов и других объектов в бакете, так как в этом случае логи и сторонние объекты могут перезаписать друг друга.

   • data_stream_destination — загружать логи в поток данных Yandex Data Streams:

     Замените блок storage_destination в шаблоне:

     data_stream_destination {
       database_id = "<идентификатор_базы_данных>"
       stream_name = "<имя_потока_данных>"
       codec       = "RAW"
     }
     
     • stream_name — имя потока данных, в который трейл будет сохранять аудитные логи.
     • database_id — идентификатор базы данных Yandex Managed Service for YDB, которая используется потоком данных Data Streams.
     • codec — метод сжатия событий при записи в поток данных Data Streams. Возможные значения: RAW (без сжатия, по умолчанию), GZIP, ZSTD. Включайте сжатие, если ожидается поток событий более 1 МБ/с.

   • filtering_policy — настройки политики фильтрации, которая определяет, какие события будут собираться и попадут в аудитные логи. Политика состоит из набора фильтров, которые относятся к разным уровням событий. Содержит блоки management_events_filter и data_events_filter.

     • management_events_filter — фильтр событий уровня конфигурации.

       • resource_scope — область сбора логов. Можно указать несколько блоков resource_scope для областей, которые принадлежат одной организации. Например, собирать логи из одного облака целиком, а из другого — только из определенных каталогов. Права сервисного аккаунта должны позволять сбор логов из указанных областей.

         • resource_id — идентификатор области сбора: организации, облака или каталога.

         • resource_type — тип области согласно указанному идентификатору:

           • organization-manager.organization — организация;
           • resource-manager.cloud — облако;
           • resource-manager.folder — каталог.

     • data_events_filter — фильтр событий уровня сервисов. Можно настроить несколько фильтров такого типа — по одному для каждого сервиса. Фильтр для одного сервиса имеет следующую структуру:

       • service — имя сервиса, в котором трейл будет обрабатывать события. Его можно получить в справочнике событий уровня сервисов.

       • resource_scope — места, откуда собирать события уровня сервисов. Этот блок настраивается аналогично фильтру событий уровня конфигурации.

       • included_events — полные имена событий для сбора. Вместо него можно указать excluded_events — полные имена событий для исключения. Эти параметры взаимоисключающие. Если оба не заданы, отбор не ограничивается именами событий.

         Используйте полное имя из поля event_type аудитного лога. Например, событию CreateIamToken из справочника соответствует yandex.cloud.audit.iam.CreateIamToken.

       • include_rule и exclude_rule — необязательные правила с условиями по значениям полей. Действуют вместе с выбором событий по именам.

   Подробнее о параметрах ресурса yandex_audit_trails_trail в документации провайдера.

2. (Опционально) Дополните фильтр условиями по значениям полей для нужного сервиса. Для этого в блоке filtering_policy.data_events_filter задайте правила include_rule, exclude_rule. Используйте провайдер Yandex Cloud версии 0.225.0 или выше. Примеры настройки фильтрации приведены в инструкции Создание трейла.

3. Примените изменения:

   1. В терминале перейдите в директорию с конфигурационным файлом.

   2. Проверьте корректность конфигурации с помощью команды:

      terraform validate
      

      Если конфигурация является корректной, появится сообщение:

      Success! The configuration is valid.
      

   3. Выполните команду:

      terraform plan
      

      В терминале будет выведен список ресурсов с параметрами. На этом этапе изменения не будут внесены. Если в конфигурации есть ошибки, Terraform на них укажет.

   4. Примените изменения конфигурации:

      terraform apply
      

   5. Подтвердите изменения: введите в терминале слово yes и нажмите Enter.

   Проверьте настройки трейла в консоли управления или с помощью команды CLI:

   yc audit-trails trail get <имя_трейла>
   

1. Аутентифицируйтесь в API и получите настройки трейла методом REST API get или вызовом gRPC API TrailService/Get.

2. Измените нужные параметры трейла.

3. (Опционально) Дополните фильтр условиями по значениям полей для нужного сервиса. Для этого в запросе REST API в элементе списка filteringPolicy.dataEventsFilters задайте правила includeRules, excludeRules. В gRPC API используйте filtering_policy.data_events_filters, include_rules и exclude_rules. Пример настройки фильтрации приведен в инструкции Создание трейла.

4. Обновите трейл методом REST API update для ресурса Trail или вызовом gRPC API TrailService/Update. Передайте идентификатор трейла, обновленные параметры и маску изменений.

   Если меняете политику фильтрации, включите filteringPolicy в updateMask для REST API или filtering_policy в update_mask.paths для gRPC API.

Чтобы удалить трейл, выполните команду:

yc audit-trails trail delete <имя_или_идентификатор_трейла>

Чтобы узнать имена и идентификаторы доступных трейлов, воспользуйтесь инструкцией.

Чтобы удалить трейл, созданный с помощью Terraform:

1. Откройте файл конфигурации Terraform и удалите секцию с описанием трейла.

   Пример описания трейла в конфигурации Terraform:

   resource "yandex_audit_trails_trail" "basic_trail" {
     name        = "<имя_трейла>"
     folder_id   = "<идентификатор_каталога>"
     description = "<описание_трейла>"
     labels = {
       key = "value"
     }
     service_account_id = "<идентификатор_сервисного_аккаунта>"
   
     storage_destination {
       bucket_name   = "<имя_бакета>"
       object_prefix = "<префикс>"
     }
   
     filtering_policy {
       management_events_filter {
         resource_scope {
           resource_id   = "<идентификатор_организации_облака_или_каталога>"
           resource_type = "<тип>"
         }
       }
   
       data_events_filter {
         service         = "<имя_сервиса>"
         included_events = ["<полное_имя_события>"]
   
         resource_scope {
           resource_id   = "<идентификатор_организации_облака_или_каталога>"
           resource_type = "<тип>"
         }
       }
     }
   }
   

2. В командной строке перейдите в папку, где расположен файл конфигурации Terraform.

3. Проверьте конфигурацию командой:

   terraform validate
   

   Если конфигурация является корректной, появится сообщение:

   Success! The configuration is valid.
   

4. Выполните команду:

   terraform plan
   

   В терминале будет выведен список ресурсов с параметрами. На этом этапе изменения не будут внесены. Если в конфигурации есть ошибки, Terraform на них укажет.

5. Примените изменения конфигурации:

   terraform apply
   

6. Подтвердите изменения: введите в терминал слово yes и нажмите Enter.

7. Чтобы убедиться в том, что трейл был удален, воспользуйтесь инструкцией.

Чтобы удалить трейл, воспользуйтесь методом REST API delete для ресурса Trail или вызовом gRPC API TrailService/Delete.