Как начать работать с Audit Trails

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

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

   yc audit-trails trail create --help
   

2. Выполните команду, чтобы создать трейл для сбора аудитных логов уровня конфигурации в организации:

   yc audit-trails trail create \
     --name <имя_трейла> \
     --description "<описание_трейла>" \
     --service-account-id <идентификатор_сервисного_аккаунта> \
     --destination-bucket <имя_бакета> \
     --destination-bucket-object-prefix <префикс_в_бакете> \
     --filter-from-organisation-id <идентификатор_организации> \
     --filter-some-cloud-ids <список_облаков_в_организации>
   

   Где:

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

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

   • --description — описание трейла, которое позволит отличать его от других трейлов. Например --description "My very first trail". Необязательный параметр.

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

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

   • --destination-bucket — имя бакета, в который будут загружаться аудитные логи.
     Чтобы получить список бакетов в каталоге по умолчанию, выполните команду CLI yc storage bucket list.

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

     Примечание

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

   • --filter-from-organisation-id — идентификатор организации, которой принадлежит создаваемый трейл и для ресурсов которой будут собираться аудитные логи.

     При использовании параметра --filter-from-organisation-id необходимо также задать идентификаторы облаков в параметре --filter-some-cloud-ids.

     Использование параметра --filter-from-organisation-id исключает использование параметра --filter-all-organisation-id.

   • --filter-some-cloud-ids — список идентификаторов облаков, для ресурсов которых трейл будет собирать аудитные логи. Используйте этот параметр только в том случае, если задан параметр --filter-from-organisation-id.

     Указанные в параметре облака должны принадлежать организации, заданной в параметре --filter-from-organisation-id.

     Если аудитные логи нужно собирать во всех облаках, принадлежащих организации, используйте параметр --filter-all-organisation-id.

   • --filter-all-organisation-id — идентификатор организации, которой принадлежит создаваемый трейл и для всех ресурсов во всех облаках которой будут собираться аудитные логи.

     Использование параметра --filter-all-organisation-id исключает использование параметра --filter-from-organisation-id.

   Результат:

   done (1s)
   id: cnpe0gldjeq0********
   folder_id: b1g9d2k0itu4********
   created_at: "2024-03-31T16:54:56.187Z"
   updated_at: "2024-03-31T16:54:56.187Z"
   name: sample-trail
   description: My very first trail
   destination:
     object_storage:
       bucket_id: at-destination-bucket
       object_prefix: sample-trail-audit-logs
   service_account_id: ajeee339l4m5********
   status: ACTIVE
   filter:
     path_filter:
       root:
         some_filter:
           resource:
             id: bpfaidqca8vd********
             type: organization-manager.organization
           filters:
             - any_filter:
                 resource:
                   id: b1glti4eser3********
                   type: resource-manager.cloud
             - any_filter:
                 resource:
                   id: b1gssd27h7ra********
                   type: resource-manager.cloud
     event_filter: {}
   cloud_id: b1glti4eser3********
   

   Подробнее о команде yc audit-trails trail create читайте в справочнике CLI.

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

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

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

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

1. Опишите в конфигурационном файле параметры трейла, который будет собирать аудитные события ресурсов организации:

   resource "yandex_audit_trails_trail" "basic_trail" {
     name = "<имя_трейла>"
     folder_id   = "<идентификатор_каталога>"
     description = "<описание_трейла>"
     
     labels = {
       key = "value"
     }
     
     service_account_id = "<идентификатор_сервисного_аккаунта>"
     
     storage_destination {
       bucket_name   = "<имя_бакета>"
       object_prefix = "<префикс_в_бакете>"
     }
     
     filter {
       path_filter {
         some_filter {
           resource_id   = "<идентификатор_организации>"
           resource_type = "<тип_родительского_ресурса>"
           any_filters {
               resource_id   = "<идентификатор_облака_1>"
               resource_type = "<тип_дочернего_ресурса>"
           }
           any_filters {
               resource_id   = "<идентификатор_облака_2>"
               resource_type = "<тип_дочернего_ресурса>"
           }
         }
       }
       event_filters {
         service = "<идентификатор_сервиса_1>"
         categories {
           plane = "DATA_PLANE"
           type  = "<тип_действия>"
         }
         path_filter {
           any_filter {
             resource_id = "<идентификатор_организации>"
             resource_type = "<тип_ресурса>"
           }
         }
       }
       event_filters {
         service = "<идентификатор_сервиса_2>"
         categories {
           plane = "DATA_PLANE"
           type  = "<тип_действия>"
         }
         path_filter {
           any_filter {
             resource_id = "<идентификатор_организации>"
             resource_type = "<тип_ресурса>"
           }
         }
       }
     }
   }
   

   Где:

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

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

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

   • description — описание трейла, которое позволит отличать его от других трейлов. Например My very first trail. Необязательный параметр.

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

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

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

   • storage_destination — структура, описывающая целевой бакет.

     • bucket_name — имя бакета, в который будут загружаться аудитные логи.
       Чтобы получить список бакетов в каталоге по умолчанию, выполните команду CLI yc storage bucket list.

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

       Примечание

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

   • filter — структура, описывающая обработку событий трейлом. Содержит объекты path_filter и event_filters.

     • path_filter — структура, описывающая обработку трейлом событий уровня конфигурации (Control Plane). Может содержать один объект some_filter или один объект any_filter. Если в конфигурации отсутствует объект path_filter, трейл не будет обрабатывать события Control Plane.

       • some_filter — структура, описывающая ресурсы, для которых будут собираться аудитные логи. В зависимости от области сбора аудитных логов позволяет настроить обработку событий в отдельных облаках организации или каталогах облака, к которым относится трейл.

         • resource_id — идентификатор родительского ресурса, которому принадлежит создаваемый трейл и для ресурсов которого будут собираться аудитные логи. В зависимости от области сбора аудитных логов укажите в этом параметре идентификатор организации или идентификатор облака, к которому относится трейл.

         • resource_type — тип родительского ресурса Yandex Cloud, в котором создается трейл. В зависимости от области сбора аудитных логов укажите в этом параметре значение organization-manager.organization или resource-manager.cloud.

         • any_filters — структура, описывающая один дочерний ресурс, в котором будут собираться аудитные логи. Чтобы указать несколько дочерних ресурсов, задайте параметр any_filters необходимое количество раз. В зависимости от области сбора аудитных логов, указывайте в этом параметре информацию об облаках или каталогах, в которых трейл будет обрабатывать события:

           • resource_id — идентификатор дочернего ресурса. В зависимости от области сбора аудитных логов укажите идентификатор облака или каталога, в котором трейл будет собирать аудитные логи.
           • resource_type — тип дочернего ресурса. В зависимости от области сбора аудитных логов укажите в этом параметре значение resource-manager.cloud или resource-manager.folder.

         Чтобы задать текущий каталог в качестве области сбора аудитных логов, вместо параметра some_filter используйте параметр any_filter.

         Использование параметра some_filter исключает использование параметра any_filter.

       • any_filter — структура, описывающая ресурсы, для которых будут собираться аудитные логи. В зависимости от области сбора аудитных логов позволяет настроить обработку событий во всех облаках организации, к которой относится трейл, во всех каталогах облака, к которому относится трейл, или в текущем каталоге, в котором создается трейл. Использование параметра any_filter исключает использование параметра some_filter.

         • resource_id — идентификатор ресурса, которому принадлежит создаваемый трейл и для ресурсов которого будут собираться аудитные логи. В зависимости от области сбора аудитных логов укажите в этом параметре идентификатор организации, облака или каталога.
         • resource_type — тип ресурса Yandex Cloud. В зависимости от области сбора аудитных логов задайте значение organization-manager.organization, resource-manager.cloud или resource-manager.folder.

     • event_filters — структура, описывающая обработку трейлом событий уровня сервисов (Data Plane). Если в конфигурации отсутствует объект event_filters, трейл не будет обрабатывать события Data Plane. В одном блоке event_filters настраивается обработка аудитных логов Data Plane для одного сервиса Yandex Cloud. Чтобы настроить обработку трейлом событий Data Plane для нескольких сервисов, укажите в конфигурации параметр event_filters необходимое количество раз.

       • service — идентификатор сервиса, в котором трейл будет обрабатывать события.
         Возможные значения:

         • dns;
         • kms;
         • lockbox;
         • mdb.mongodb;
         • mdb.mysql;
         • mdb.postgresql;
         • storage.

       • categories — структура, описывающая тип собираемых событий.

         • plane — уровень событий. Для событий уровня сервисов указывайте значение DATA_PLANE.
         • type — тип действия события в ресурсе. Возможные значения: READ и WRITE.

       • path_filter — структура, описывающая обработку трейлом событий уровня сервисов (Data Plane). Может содержать один объект some_filter или один объект any_filter.

         • some_filter — структура, описывающая ресурсы, для которых будут собираться аудитные логи. В зависимости от области сбора аудитных логов позволяет настроить обработку событий в отдельных облаках организации или каталогах облака, к которым относится трейл.

           • resource_id — идентификатор родительского ресурса, которому принадлежит создаваемый трейл и для ресурсов которого будут собираться аудитные логи. В зависимости от области сбора аудитных логов укажите в этом параметре идентификатор организации или идентификатор облака, к которому относится трейл.

           • resource_type — тип родительского ресурса Yandex Cloud, в котором создается трейл. В зависимости от области сбора аудитных логов укажите в этом параметре значение organization-manager.organization или resource-manager.cloud.

           • any_filters — структура, описывающая один дочерний ресурс, в котором будут собираться аудитные логи. Чтобы указать несколько дочерних ресурсов, задайте параметр any_filters необходимое количество раз. В зависимости от области сбора аудитных логов, указывайте в этом параметре информацию об облаках или каталогах, в которых трейл будет обрабатывать события:

             • resource_id — идентификатор дочернего ресурса. В зависимости от области сбора аудитных логов укажите идентификатор облака или каталога, в котором трейл будет собирать аудитные логи.
             • resource_type — тип дочернего ресурса. В зависимости от области сбора аудитных логов укажите в этом параметре значение resource-manager.cloud или resource-manager.folder.

           Чтобы задать текущий каталог в качестве области сбора аудитных логов, вместо параметра some_filter используйте параметр any_filter.

           Использование параметра some_filter исключает использование параметра any_filter.

         • any_filter — структура, описывающая ресурсы, для которых будут собираться аудитные логи. В зависимости от области сбора аудитных логов позволяет настроить обработку событий во всех облаках организации, к которой относится трейл, во всех каталогах облака, к которому относится трейл, или в текущем каталоге, в котором создается трейл. Использование параметра any_filter исключает использование параметра some_filter.

           • resource_id — идентификатор ресурса, которому принадлежит создаваемый трейл и для ресурсов которого будут собираться аудитные логи. В зависимости от области сбора аудитных логов укажите в этом параметре идентификатор организации, облака или каталога.
           • resource_type — тип ресурса Yandex Cloud. В зависимости от области сбора аудитных логов задайте значение organization-manager.organization, resource-manager.cloud или resource-manager.folder.

   Более подробную информацию о параметрах ресурса yandex_audit_trails_trail в Terraform см. в документации провайдера.

2. Создайте ресурсы:

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

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

      terraform validate
      

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

      Success! The configuration is valid.
      

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

      terraform plan
      

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

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

      terraform apply
      

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

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

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

Воспользуйтесь методом REST API create для ресурса Trail или вызовом gRPC API TrailService/Create.