Setting up workload identity federations

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

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

1. View the description of the command for creating a workload identity federation:

   yc iam workload-identity oidc federation create --help
   

2. Create a workload identity federation in the default folder:

   yc iam workload-identity oidc federation create \
     --name <federation_name> \
     --issuer "<OIDC_provider_URL>" \
     --audiences "<resource_1>","<resource_2>",...,"<resource_n>" \
     --jwks-url "<JWKS_address>"
   

   Where:

   • --name: Name of the new federation, e.g., sample-iam-federation. The naming requirements are as follows:

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

   • --issuer: URL of the OIDC provider.

     To get this value, refer to the OIDC provider's documentation or contact their support.

   • --audiences: Resources to issue the token for. You can specify multiple resources at once, separated by commas.

     To get this value, refer to the OIDC provider's documentation or contact their support.

   • --jwks-url: URL for retrieving the current public key issued by the OIDC provider and used for JWT signature verification.

     To get this value, refer to the OIDC provider's documentation or contact their support.

   Result:

   id: aje2c4qv19lf********
   name: sample-iam-federation
   folder_id: b1gfq9pe6rd2********
   enabled: true
   audiences:
     - https://gitlab.example.ru
     - https://gitlab.example.com
   issuer: https://gitlab.com
   jwks_url: https://gitlab.com/oauth/discovery/keys
   created_at: "2024-12-28T16:04:31.530652473Z"
   

   Save the value of the new workload identity federation ID. You will need it to create federated credentials.

   For more information about the yc iam workload-identity oidc federation create command, see the CLI reference.

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 documentation on the Terraform website or mirror website.

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

1. In the Terraform configuration file, define the parameters of the federation you want to create:

   resource "yandex_iam_workload_identity_oidc_federation" "wlif" {
     name        = "<federation_name>"
     folder_id   = "<folder_ID>"
     audiences   = ["<resource_1>","<resource_2>",...,"<resource_n>"]
     issuer      = "<OIDC_provider_URL>"
     jwks_url    = "<JWKS_address>"
   }
   

   Where:

   • name: Name of the new federation, e.g., sample-iam-federation. The naming requirements are as follows:

     • It must be from 2 to 63 characters long.
     • It may 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 workload identity federation in.

   • audiences: Resources to issue the token for. You can specify multiple resources at once, separated by commas.

     To get this value, refer to the OIDC provider's documentation or contact their support.

   • issuer: URL of the OIDC provider.

     To get this value, refer to the OIDC provider's documentation or contact their support.

   • jwks_url: URL for retrieving the current public key issued by the OIDC provider and used for JWT signature verification.

     To get this value, refer to the OIDC provider's documentation or contact their support.

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

2. Create resources:

   1. In the terminal, change to the folder where you edited the configuration file.

   2. 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.
      

   3. 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.

   4. Apply the configuration changes:

      terraform apply
      

   5. Confirm the changes: type yes in the terminal and press Enter.

   Terraform will create a workload identity federation. You can check the new federation using the management console or this CLI command:

   yc iam workload-identity oidc federation list
   

To create a workload identity federation, use the create REST API method for the Federation resource or the FederationService/Create gRPC API call.

1. View the description of the command for creating federated credentials:

   yc iam workload-identity federated-credential create --help
   

2. Create federated credentials, specifying the ID of the appropriate service account:

   yc iam workload-identity federated-credential create \
     --service-account-id <service_account_ID> \
     --federation-id <federation_ID> \
     --external-subject-id "<external_subject_ID>"
   

   Where:

   • --service-account-id: ID of the Yandex Cloud service account.

     The service account can reside in a folder other than the one containing the workload identity federation.

   • --federation-id: Workload identity federation ID obtained in the previous step.

   • --external-subject-id: External subject ID.

     To get this value, refer to the OIDC provider's documentation or contact their support.

   Result:

   id: aje401v1sup8********
   service_account_id: ajek7v5j65cg********
   federation_id: aje2c4qv19lf********
   external_subject_id: project_path:root/test-iam-wlif:ref_type:branch:ref:master
   created_at: "2024-12-28T16:33:47.057632267Z"
   

   For more information about the yc iam workload-identity federated-credential create command, see the CLI reference.

1. In the Terraform configuration file, define the parameters of the federated credentials you want to create:

   resource "yandex_iam_workload_identity_federated_credential" "fc" {
     service_account_id  = "<service_account_ID>"
     federation_id       = "<federation_ID>"
     external_subject_id = "<external_subject_ID>"
   }
   

   Where:

   • service_account_id: ID of the Yandex Cloud service account.

     The service account can reside in a folder other than the one containing the workload identity federation.

   • federation_id: Workload identity federation ID.

   • external_subject_id: External subject ID.

     To get this value, refer to the OIDC provider's documentation or contact their support.

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

2. Create resources:

   1. In the terminal, change to the folder where you edited the configuration file.

   2. 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.
      

   3. 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.

   4. Apply the configuration changes:

      terraform apply
      

   5. Confirm the changes: type yes in the terminal and press Enter.

   Terraform will create the specified federated credentials. You check the new service account federated credentials using the management console or this CLI command:

   yc iam workload-identity federated-credential list \
     --service-account-id <service_account_ID>
   

To create federated credentials, use the create REST API method for the FederatedCredential resource or the FederatedCredentialService/Create gRPC API call.