Configuring file storage access permissions
To grant a user, group, or service account access to file storage, assign a role for it.
Assigning a role
- In the management console
, select the folder the file storage belongs to. - Select Compute Cloud.
- In the left-hand panel, select
File storages. - Select a file storage from the list.
- Go to the
Access bindings tab. - Click Assign bindings.
- In the window that opens, select a group, user, or service account to be granted access to the file storage.
- Click
Add role and select the required roles. - Click Save.
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
-
See the CLI command description for assigning a role for a file storage:
yc compute filesystem add-access-binding --help
-
Get a list of file storages in the default folder:
yc compute filesystem list
Result:
+----------------------+-------------------+------------+---------------+--------+-------------+ | ID | NAME | SIZE | ZONE | STATUS | DESCRIPTION | +----------------------+-------------------+------------+---------------+--------+-------------+ | epdtcr9blled******** | first-filesystem | 1073741824 | ru-central1-a | READY | | | epd3f4gv8bs4******** | second-filesystem | 1073741824 | ru-central1-a | READY | | +----------------------+-------------------+------------+---------------+--------+-------------+
-
View the list of roles already assigned for the resource:
yc compute filesystem list-access-bindings <file_storage_ID>
-
Assign the role using the command:
-
To a user:
yc compute filesystem add-access-binding <file_storage_ID> \ --user-account-id <user_ID> \ --role <role>
Where:
-
To a service account:
yc compute filesystem add-access-binding <file_storage_ID> \ --service-account-id <service_account_ID> \ --role <role>
Where:
--service-account-id
is the service account ID.--role
: Role you want to assign.
-
With Terraform
Terraform is distributed under the Business Source License
For more information about the provider resources, see the documentation on the Terraform
If you don't have Terraform, install it and configure the Yandex Cloud provider.
To assign a role to access file storage using Terraform:
-
In the Terraform configuration file, describe the parameters of the resources you want to create:
resource "yandex_compute_filesystem_iam_binding" "sa-access" { filesystem_id = "<file_storage_ID>" role = "<role>" members = ["<subject_type>:<subject_ID>","<subject_type>:<subject_ID>"] }
Where:
filesystem_id
: File storage ID.role
: Role to assign.members
: List of types and IDs of subjects the roles are assigned to. Specify it asuserAccount:<user_ID>
orserviceAccount:<service_account_ID>
.
For more information about the
yandex_compute_filesystem_iam_binding
resource parameters, see the provider documentation . -
Create resources:
-
In the terminal, change to the folder where you edited the configuration file.
-
Make sure the configuration file is correct using the command:
terraform validate
If the configuration is correct, the following message is returned:
Success! The configuration is valid.
-
Run the command:
terraform plan
The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.
-
Apply the configuration changes:
terraform apply
-
Confirm the changes: type
yes
in the terminal and press Enter.
Terraform will create all the required resources. You can check the update using the management console
or this CLI command:yc compute filesystem list-access-bindings <file_storage_ID>
-
Use the updateAccessBindings REST API method for the Filesystem resource or the FilesystemService/UpdateAccessBindings gRPC API call. In the request body, set the action
property to ADD
and specify the user type and ID in the subject
property.
Assigning multiple roles
- In the management console
, select the folder the file storage belongs to. - Select Compute Cloud.
- In the left-hand panel, select
File storages. - Select a file storage from the list.
- Go to the
Access bindings tab. - Click Assign bindings.
- In the window that opens, select a group, user, or service account to be granted access to the file storage.
- Click
Add role and select the required roles. - To add another role, click Add role.
- Click Save.
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
You can assign multiple roles using the set-access-bindings
command.
Alert
The set-access-bindings
command completely rewrites the access permissions for the resource. All current resource roles will be deleted.
-
Make sure the resource has no roles assigned that you would not want to lose:
yc compute filesystem list-access-bindings <file_storage_ID>
-
See the CLI command description for assigning roles for a file storage:
yc compute filesystem set-access-bindings --help
-
Assign roles:
yc compute filesystem set-access-bindings <file_storage_ID> \ --access-binding role=<role>,subject=<subject_type>:<subject_ID>
Where:
-
--access-binding
: Role to assign:role
: ID of the role to assign.subject
: Type and ID of the subject getting the role.
For example, assign roles to multiple users and a service account:
yc compute filesystem set-access-bindings my-filesystem \ --access-binding role=editor,subject=userAccount:gfei8n54hmfh******** --access-binding role=viewer,subject=userAccount:helj89sfj80a******** --access-binding role=editor,subject=serviceAccount:ajel6l0jcb9s********
-
With Terraform
Terraform is distributed under the Business Source License
For more information about the provider resources, see the documentation on the Terraform
If you don't have Terraform, install it and configure the Yandex Cloud provider.
To assign multiple roles for file storage using Terraform:
-
In the Terraform configuration file, describe the appropriate access permissions:
resource "yandex_compute_filesystem_iam_binding" "role1" { filesystem_id = "<file_storage_ID>" role = "<role_1>" members = ["<subject_type>:<subject_ID>"] } resource "yandex_compute_filesystem_iam_binding" "role2" { filesystem_id = "<file_storage_ID>" role = "<role_2>" members = ["<subject_type>:<subject_ID>"] }
Where:
filesystem_id
: File storage ID.role
: Role to assign.members
: List of types and IDs of subjects the roles are assigned to. Specify it asuserAccount:<user_ID>
orserviceAccount:<service_account_ID>
.
For more information about the
yandex_compute_filesystem_iam_binding
resource parameters, see the provider documentation . -
Create resources:
-
In the terminal, change to the folder where you edited the configuration file.
-
Make sure the configuration file is correct using the command:
terraform validate
If the configuration is correct, the following message is returned:
Success! The configuration is valid.
-
Run the command:
terraform plan
The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.
-
Apply the configuration changes:
terraform apply
-
Confirm the changes: type
yes
in the terminal and press Enter.
Terraform will create all the required resources. You can check the update using the management console
or this CLI command:yc compute filesystem list-access-bindings <file_storage_ID>
-
Use the setAccessBindings REST API method for the Filesystem resource or the FilesystemService/SetAccessBindings gRPC API call.
Revoking a role
- In the management console
, select the folder the file storage belongs to. - Select Compute Cloud.
- In the left-hand panel, select
File storages. - Select a file storage from the list.
- Go to the
Access bindings tab. - In the line with the user you need, click
and select Edit roles. - Click
next to a role to delete it. - Click Save.
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
-
See the CLI command description for revoking a role for a file storage:
yc compute filesystem remove-access-binding --help
-
View the roles and assignees for the resource:
yc compute filesystem list-access-bindings <file_storage_ID>
-
To revoke access permissions, run this command:
yc compute filesystem remove-access-binding <file_storage_ID> \ --role <role_ID> \ --subject <subject_type>:<subject_ID>
Where:
--role
: ID of the role to revoke.--subject
: Subject to revoke the role from.
For example, this command revokes the
viewer
role for file storage from a user with theajel6l0jcb9s********
ID:yc compute filesystem remove-access-binding my-filesystem \ --role viewer \ --subject userAccount:ajel6l0jcb9s********
With Terraform
Terraform is distributed under the Business Source License
For more information about the provider resources, see the documentation on the Terraform
If you don't have Terraform, install it and configure the Yandex Cloud provider.
To revoke a role assigned for file storage using Terraform:
-
Open the Terraform configuration file and delete the fragment with the role description:
resource "yandex_compute_filesystem_iam_binding" "role1" { filesystem_id = "<file_storage_ID>" role = "<role>" members = ["<subject_type>:<subject_ID>"] }
-
Apply the changes:
-
In the terminal, change to the folder where you edited the configuration file.
-
Make sure the configuration file is correct using the command:
terraform validate
If the configuration is correct, the following message is returned:
Success! The configuration is valid.
-
Run the command:
terraform plan
The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.
-
Apply the configuration changes:
terraform apply
-
Confirm the changes: type
yes
in the terminal and press Enter.
You can check the update using the management console
or this CLI command:yc compute filesystem list-access-bindings <file_storage_ID>
-
To revoke file storage roles, use the updateAccessBindings REST API method for the Filesystem resource or the FilesystemService/UpdateAccessBindings gRPC API call. In the request body, set the action
property to REMOVE
and specify the user type and ID in the subject
property.