Assigning access rules for catalog objects in Managed Service for Trino

1. Create a Terraform configuration file describing your infrastructure.

2. Add to the configuration file the yandex_trino_access_control resource containing the catalogs rule list.

   resource "yandex_trino_cluster" "<cluster_name>" {
     ...
   }
   
   resource "yandex_trino_catalog" "<catalog_1_name>" {
     ...
   }
   
   resource "yandex_trino_catalog" "<catalog_2_name>" {
     ...
   }
   
   ...
   
   resource "yandex_trino_catalog" "<catalog_N_name>" {
     ...
   }
   
   resource "yandex_trino_access_control" "trino_access_control" {
     ...
     cluster_id  = yandex_trino_cluster.<cluster_name>.id
     catalogs = [
       # Rule 1
       {
         permission    = "<access_level>"
         catalog       = {
           ids         = [
             yandex_trino_catalog.<catalog_1_name>.id,
             yandex_trino_catalog.<catalog_2_name>.id,
             ... 
             yandex_trino_catalog.<catalog_N_name>.id
           ]
           name_regexp = "<regular_expression>"
         }
         users         = ["<list_of_user_IDs>"]
         groups        = ["<list_of_group_IDs>"]
         description   = "<rule_description>"
       },
       # Rule 2
       {
         ... 
       },
       ...
       # Rule N
       {
         ... 
       }
     ]
     ...
   }
   

   Where:

   • catalogs: List of catalog rule sections. Each rule contains the required permission parameter as well as optional parameters: catalog, groups, users, and description.

   • permission: User or group access level to catalogs assigned by the rule:

     • NONE: All operations on catalog objects are prohibited.
     • READ_ONLY: Only read operations are allowed, e.g., reading data from a table.
     • ALL: All operations are allowed. In which case user access to catalog objects is controlled by more granular rules, e.g., table rules.

   • catalog: Catalogs the rule applies to. If the catalog section is not specified, the rule applies to all cluster catalogs.

     • ids: List of catalog IDs. These catalogs must be created in the same manifest.
     • name_regexp: Regular expression. The rule applies to the catalogs whose names match the regular expression.

     You can specify either ids or name_regexp but not both.

   • groups: List of group IDs the rule applies to. If you do not specify groups, the rule applies to all user groups.

   • users: List of user IDs the rule applies to. If you do not specify users, the rule applies to all users.

   • description: Rule description.

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

1. Get an IAM token for API authentication and put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. Create a file named body.json and paste the following code into it:

   {
     <cluster_parameters>
     ...
     "trino": {
       "catalogs": [
         {
           "name": "catalog_1_name",
           ...
         },
         {
           "name": "catalog_2_name",
           ...
         },
         ...
         {
           "name": "catalog_N_name",
           ...
         }
       ]
       ...
       "access_control": {
         "catalogs": [
           {
             "permission": "<access_level>",
             "catalog": {
               "names": {
                 "any": [
                   "<catalog_1_name>",
                   "<catalog_2_name>",
                   ...
                   "<catalog_N_name>"
                 ]
               },
               "name_regexp": "<regular_expression>"
             },
             "users": [
               "<list_of_user_IDs>"
             ],
             "groups": [
               "<list_of_group_IDs>"
             ],
             "description": "<rule_description>"
           },
           {
             <Rule_2_section>
           },
           ...
           {
             <Rule_N_section>
           }
         ]
       }
     }
   }
   

   Where:

   • access_control: Access rule configuration in the cluster.

   • catalogs: List of catalog rule sections. Each rule contains the required permission parameter as well as optional parameters: catalog, groups, users, and description.

   • permission: User or group access level to catalogs assigned by the rule:

     • NONE: All operations on catalog objects are prohibited.
     • READ_ONLY: Only read operations are allowed, e.g., reading data from a table.
     • ALL: All operations are allowed. In which case user access to catalog objects is controlled by more granular rules, e.g., table rules.

   • catalog: Catalogs the rule applies to. If the catalog section is not specified, the rule applies to all cluster catalogs.

     • names: List of catalog names. You must create catalogs within the same ClusterService/Create call.
     • name_regexp: Regular expression. The rule applies to the catalogs whose names match the regular expression.

     The catalog section must contain either the nested names section or the name_regexp parameter.

   • groups: List of group IDs the rule applies to. If you do not specify groups, the rule applies to all user groups.

   • users: List of user IDs the rule applies to. If you do not specify users, the rule applies to all users.

   • description: Rule description.

   For available cluster parameters and their descriptions, see this guide.

4. Call the ClusterService/Create method, e.g., via the following gRPCurl request:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/trino/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d @ \
       trino.api.cloud.yandex.net:443 \
       yandex.cloud.trino.v1.ClusterService.Create \
       < body.json
   

5. Check the server response to make sure your request was successful.

1. Open the current Terraform configuration file describing your infrastructure.

   To learn how to create this file, see Creating a cluster.

2. If you have not set the access rules yet, add the yandex_trino_access_control resource containing the catalogs rule list.

   resource "yandex_trino_cluster" "<cluster_name>" {
     ...
   }
   
   resource "yandex_trino_catalog" "<catalog_1_name>" {
     ...
   }
   
   resource "yandex_trino_catalog" "<catalog_2_name>" {
     ...
   }
   
   ...
   
   resource "yandex_trino_catalog" "<catalog_N_name>" {
     ...
   }
   
   resource "yandex_trino_access_control" "trino_access_control" {
     ...
     cluster_id  = yandex_trino_cluster.<cluster_name>.id
     catalogs = [
       # Rule 1
       {
         permission    = "<access_level>"
         catalog       = {
           ids         = [
             yandex_trino_catalog.<catalog_1_name>.id,
             yandex_trino_catalog.<catalog_2_name>.id,
             ... 
             yandex_trino_catalog.<catalog_N_name>.id
           ]
           name_regexp = "<regular_expression>"
         }
         users         = ["<list_of_user_IDs>"]
         groups        = ["<list_of_group_IDs>"]
         description   = "<rule_description>"
       },
       # Rule 2
       {
         ... 
       },
       ...
       # Rule N
       {
         ... 
       }
     ]
     ...
   }
   

   Where:

   • catalogs: List of catalog rule sections. Each rule contains the required permission parameter as well as optional parameters: catalog, groups, users, and description.

   • permission: User or group access level to catalogs assigned by the rule:

     • NONE: All operations on catalog objects are prohibited.
     • READ_ONLY: Only read operations are allowed, e.g., reading data from a table.
     • ALL: All operations are allowed. In which case user access to catalog objects is controlled by more granular rules, e.g., table rules.

   • catalog: Catalogs the rule applies to. If the catalog section is not specified, the rule applies to all cluster catalogs.

     • ids: List of catalog IDs. These must exist or be created in the same manifest.
     • name_regexp: Regular expression. The rule applies to the catalogs whose names match the regular expression.

     You can specify either ids or name_regexp but not both.

   • groups: List of group IDs the rule applies to. If you do not specify groups, the rule applies to all user groups.

   • users: List of user IDs the rule applies to. If you do not specify users, the rule applies to all users.

   • description: Rule description.

3. If you have already set the access rules, edit the yandex_trino_access_control resource description. You can:

   • Add new rules.
   • Update the existing ones.
   • Delete the rules you no longer need.

4. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

5. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

1. Get an IAM token for API authentication and put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. If you have not set any access rules yet, create a file named body.json and paste the following code into it:

   {
     "cluster_id": "<cluster_ID>",
     "update_mask": {
       "paths": [
         "trino.access_control.catalogs"
       ]
     },
     "trino": {
       "access_control": {
         "catalogs": [
           {
             "permission": "<access_level>",
             "catalog": {
               "name_regexp": "<regular_expression>",
               "ids": {
                 "any": [
                   "<list_of_catalog_IDs>"
                 ]
               },
               "names": {
                 "any": [
                   "<list_of_catalog_names>"
                 ]
               }
             },
             "users": [
               "<list_of_user_IDs>"
             ],
             "groups": [
               "<list_of_group_IDs>"
             ],
             "description": "<rule_description>"
           },
           {
             <Rule_2_section>
           },
           ...
           {
             <Rule_N_section>
           }
         ]
       }
     }
   }
   

   Where:

   • cluster_id: Cluster ID.

     You can get the cluster ID with the list of clusters in the folder.

   • update_mask: List of parameters to update as an array of strings (paths[]).

     Format for listing settings

     "update_mask": {
       "paths": [
         "<setting_1>",
         "<setting_2>",
         ...
         "<setting_N>"
       ]
     }
     

     Warning

     When you update a cluster, all parameters of the object you are modifying will take their defaults unless explicitly provided in the request. To avoid this, list the settings you want to change in the update_mask parameter.

   • access_control: Access rule configuration in the cluster.

   • catalogs: List of catalog rule sections. Each rule contains the required permission parameter as well as optional parameters: catalog, groups, users, and description.

   • permission: User or group access level to catalogs assigned by the rule:

     • NONE: All operations on catalog objects are prohibited.
     • READ_ONLY: Only read operations are allowed, e.g., reading data from a table.
     • ALL: All operations are allowed. In which case user access to catalog objects is controlled by more granular rules, e.g., table rules.

   • catalog: Catalogs the rule applies to. If the catalog section is not specified, the rule applies to all cluster catalogs.

     • ids: List of catalog IDs. These must be the existing catalogs.
     • names: List of catalog names. These must be the existing catalogs.
     • name_regexp: Regular expression. The rule applies to the catalogs whose names match the regular expression.

     The catalog section must contain either one of the nested ids or names sections, or the name_regexp parameter.

   • groups: List of group IDs the rule applies to. If you do not specify groups, the rule applies to all user groups.

   • users: List of user IDs the rule applies to. If you do not specify users, the rule applies to all users.

   • description: Rule description.

4. If you have already set the access rules, open the existing body.json rules file and edit it as needed. You can:

   • Add new rules.
   • Update the existing ones.
   • Delete the rules you no longer need.

5. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/trino/v1/cluster_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d @ \
     trino.api.cloud.yandex.net:443 \
     yandex.cloud.trino.v1.ClusterService.Update \
     < body.json
   

6. Check the server response to make sure your request was successful.

The configuration file for this rule set is as follows:

resource "yandex_trino_access_control" "trino_access_control" {
  ...
  cluster_id  = <cluster_ID>
  catalogs = [
    {
      permission    = "NONE"
      groups        = ["banned_group_id"]
    },
    {
      permission    = "ALL"
      catalog       = {
        ids         = ["cat1_id", "cat2_id"]
      }
      users         = ["user1_id", "user2_id"]
      groups        = ["analytics_group_id"]
    },
    {
      permission    = "READ_ONLY"
      catalog       = {
        name_regexp = ".*_prod"
      }
    }
  ]
  ...
}

The body.json file for this rule set is as follows:

{
  "cluster_id": "<cluster_ID>",
  "update_mask": {
    "paths": [
      "trino.access_control.catalogs"
    ]
  },
  "trino": {
    "access_control": {
      "catalogs": [
        {
          "permission": "NONE",
          "groups": [
            "banned_group_id"
          ]
        },
        {
          "permission": "ALL",
          "catalog": {
            "ids": {
              "any": [
                "cat1_id",
                "cat2_id"
              ]
            }
          },
          "users": [
            "user1_id",
            "user2_id"
          ],
          "groups": [
            "analytics_group_id"
          ]
        },
        {
          "permission": "READ_ONLY",
          "catalog": {
            "name_regexp": ".*_prod"
          }
        }
      ]
    }
  }
}