Managing a trail

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

See the description of the CLI trail editing command for details about the arguments you can use:

yc audit-trails trail update --help

You can update a trail by specifying its parameters in one of these two ways:

yc audit-trails trail update \
  --name <trail_name> \
  --new-name <new_trail_name> \
  --description <trail_description> \
  --labels <label_list> \
  --service-account-id <service_account_ID> \
  --destination-bucket <bucket_name> \
  --destination-bucket-object-prefix <prefix_for_objects> \
  --destination-log-group-id <log_group_ID> \
  --destination-yds-stream <YDS_name> \
  --destination-yds-database-id <YDS_database_ID> \
  --filter-all-folder-id <folder_ID> \
  --filter-all-cloud-id <cloud_ID> \
  --filter-all-organisation-id <organization_ID> \
  --filter-some-folder-ids <cloud_folder_list> \
  --filter-from-cloud-id <cloud_ID_with_selected_folders> \
  --filter-some-cloud-ids <list_of_clouds_in_organization> \
  --filter-from-organisation-id <organization_ID_with_selected_clouds>

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the relevant documentation on the Terraform website or its mirror.

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

1. To update a trail created with Terraform, open the Terraform configuration file and update the trail description fragment:

   resource "yandex_audit_trails_trail" "basic_trail" {
     name        = "<trail_name>"
     folder_id   = "<folder_ID>"
     description = "<trail_description>"
     labels = {
       key = "value"
     }
     service_account_id = "<service_account_ID>"
   
   
     # Only one destination must be specified:
     # storage_destination , logging_destination, data_stream_destination
     # Settings for all destinations are provided for illustration purposes.
   
     logging_destination {
       log_group_id = "<log_group_ID>"
     }
     storage_destination {
       bucket_name   = "<bucket_ID>"
       object_prefix = "<prefix>"
     }
     data_stream_destination {
       database_id = "<YDS_database_ID>"
       stream_name = "<YDS_name>"
     }
   
     # Filtering policy settings
   
     filtering_policy {
       management_events_filter {
         resource_scope {
           resource_id   = "<organization_ID>"
           resource_type = "resource-manager.organization"
         }
       }  
       data_events_filter {
         service = "<service>"
         included_events = ["<service_event_type>","<service_2_event_type>"]
         resource_scope {
           resource_id   = "<cloud_ID>"
           resource_type = "resource-manager.cloud"
         }
         resource_scope {
           resource_id   = "<folder_ID>"
           resource_type = "resource-manager.folder"
         }
       }
       data_events_filter {
         service = "<service_2>"
         resource_scope {
           resource_id   = "<ID_of_cloud_2>"
           resource_type = "resource-manager.cloud"
         }
         resource_scope {
           resource_id   = "<cloud_3_ID>"
           resource_type = "resource-manager.cloud"
         }
       }
       data_events_filter {
         service = "<service_3>"
         resource_scope {
           resource_id   = "<folder_2_ID>"
           resource_type = "resource-manager.folder"
         }
         resource_scope {
           resource_id   = "<folder_3_ID>"
           resource_type = "resource-manager.folder"
         }
       }
     }
   }
   

   Where:

   • name: Name of the new trail. The naming requirements are as follows:

     • It must be from 2 to 63 characters long.
     • It can only contain lowercase Latin letters, numbers, and hyphens.
     • It must start with a letter and cannot end with a hyphen.

   • folder_id: ID of the folder to create the trail in.

   • description: Description of the trail to distinguish it from other trails, e.g., My very first trail. This is an optional parameter.

   • labels: List of labels in key=value format. This is an optional parameter.

   • service_account_id: ID of the service account the trail will use to upload audit log files to the bucket.

     Based on the audit log collection scope, the service account must have the audit-trails.viewer role for the organization, cloud, or folder whose audit logs the trail will collect.

   Warning

   Only one destination must be specified: storage_destination, logging_destination, or data_stream_destination.

   • logging_destination: Uploading logs to a Yandex Cloud Logging group.

     • log_group_id: ID of the log group for the trail to save audit logs to.

   • storage_destination: Uploading logs to a Yandex Object Storage bucket:

     • log_group_id: Name of the bucket for the trail to save audit logs to.

     • object_prefix: Prefix that will be assigned to the objects with audit logs in the bucket. It is an optional parameter used in the full name of the audit log file.

       Note

       Use a prefix to store audit logs and third-party data in the same bucket. Do not use the same prefix for logs and other bucket objects because that may cause logs and third-party objects to overwrite each other.

   • data_stream_destination: Uploading logs to a data stream in Yandex Data Streams:

     • stream_name: Name of the data stream for the trail to save audit logs to.
     • database_id: ID of the Yandex Managed Service for YDB database used by Data Streams.

   • filtering_policy: Settings of the filtering policy that determines which events to collect and include in the audit logs. The policy consists of filters pertaining to different levels of events. It contains the management_events_filter and data_events_filters objects.

     • management_events_filter: Management event filter.

     • resource_scopes: Log collection scope. You can combine several scopes belonging to the same organization in one resource_scopes parameter. For example, you can collect logs from one entire cloud and only from particular folders in another cloud. Service account permissions must allow collecting logs from the specified scopes.

       • resource_id: ID of the resource for whose resources audit logs will be collected. Based on the audit log collection scope, specify the organization ID or the cloud ID in this parameter.

       • resource_type: Scope type according to the specified ID:

         • organization-manager.organization: Organization.
         • resource-manager.cloud: Cloud.
         • resource-manager.folder: Folder.

     • data_events_filters: Data event filters. You can configure several filters of this type, one filter per service. A filter for one service has the following structure:

       • service: Name of the service in which the trail will process events. You can get it from the data event reference.
       • resource_scopes: Places to collect data events from. You can configure this parameter the same way as the management event filter.
       • included_events: Collect only specified events. This is an optional parameter. If not specified, all events will be collected. To collect all events except the specified ones, replace included_events with excluded_events. These parameters are mutually exclusive.
         You can get a full list of events from the data event reference.

   For more information about the yandex_audit_trails_trail resource parameters in Terraform, see the provider documentation.

2. Create the resources:

   1. In the terminal, go to the directory where you edited the configuration file.

   2. Make sure the configuration file is correct using this command:

      terraform validate
      

      If the configuration is correct, you will get this message:

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.

   4. Apply the changes:

      terraform apply
      

   5. Type yes and press Enter to confirm the changes.

   Terraform will create all the required resources. You can check the new resources and their settings using the management console or this CLI command:

   yc audit-trails trail get <trail_name>
   

To update a trail, use the update REST API method for the Trail resource or the TrailService/Update gRPC API call.

To delete a trail, run this command:

yc audit-trails trail delete <trail_name_or_ID>

To find out the names and IDs of available trails, use this tutorial.

To delete a trail created using Terraform:

1. Open the Terraform configuration file and delete the trail description section.

   Example of a trail description in a Terraform configuration:

   resource "yandex_audit_trails_trail" "basic_trail" {
     name        = "<trail_name>"
     folder_id   = "<folder_ID>"
     description = "<trail_description>"
     labels = {
       key = "value"
     }
     service_account_id = "<service_account_ID>"
   
   
     # Only one destination must be specified:
     # storage_destination , logging_destination, data_stream_destination
     # Settings for all destinations are provided for illustration purposes.
   
     logging_destination {
       log_group_id = "<log_group_ID>"
     }
     storage_destination {
       bucket_name   = "<bucket_ID>"
       object_prefix = "<prefix>"
     }
     data_stream_destination {
       database_id = "<YDS_database_ID>"
       stream_name = "<YDS_name>"
     }
   
     # Filtering policy settings
   
     filtering_policy {
       management_events_filter {
         resource_scope {
           resource_id   = "<organization_ID>"
           resource_type = "resource-manager.organization"
         }
       }  
       data_events_filter {
         service = "<service>"
         included_events = ["<service_event_type>","<service_2_event_type>"]
         resource_scope {
           resource_id   = "<cloud_ID>"
           resource_type = "resource-manager.cloud"
         }
         resource_scope {
           resource_id   = "<folder_ID>"
           resource_type = "resource-manager.folder"
         }
       }
       data_events_filter {
         service = "<service_2>"
         resource_scope {
           resource_id   = "<ID_of_cloud_2>"
           resource_type = "resource-manager.cloud"
         }
         resource_scope {
           resource_id   = "<cloud_3_ID>"
           resource_type = "resource-manager.cloud"
         }
       }
       data_events_filter {
         service = "<service_3>"
         resource_scope {
           resource_id   = "<folder_2_ID>"
           resource_type = "resource-manager.folder"
         }
         resource_scope {
           resource_id   = "<folder_3_ID>"
           resource_type = "resource-manager.folder"
         }
       }
     }
   }
   

2. In the command line, go to the directory with the Terraform configuration file.

3. Check the configuration using this command:

   terraform validate
   

   If the configuration is correct, you will get this message:

   Success! The configuration is valid.
   

4. Run this command:

   terraform plan
   

   The terminal will display a list of resources with their parameters. No changes will be made at this step. If the configuration contains any errors, Terraform will point them out.

5. Apply the configuration changes:

   terraform apply
   

6. Confirm the changes: type yes into the terminal and press Enter.

7. To make sure the trail has been deleted, use this tutorial.

To delete a trail, use the delete REST API method for the Trail resource or the TrailService/Delete gRPC API call.