Skip to main content

Access Keys

Access Keys in vCluster Platform are used for authentication to vCluster Platform via the vCluster CLI, or by any HTTP utilities (i.e. curl). Access Keys can be generated by any vCluster Platform user, the generated Access Key will provide the key's user with the same permissions as the user who generated the key.

Access Keys may optionally be scoped, that is, have their access limited to a particular vCluster Platform project, virtual cluster, or namespace. However, scoped access only allows the access key permissions to the resources the user or team has access to already. This is a great option to use for keys generated for automated processes such as a CI pipeline.

Create an Access Key​

  1. Select the Users field on the left menu bar.

  2. Click the Users button on the User Management screen.

  3. Find the user you would like to generate an Access Key for from the list of users. Click the user.

  4. In the User Access Key management screen click the button.

  5. In the drawer that appears from the right, give the Access Key a display name in the Enter a display name for this access key box.

  6. Optional If you'd like to limit the scope of the Access Key, expand the Limit Access Key Scope configuration section. In this section you can select the clusters, namespaces, and virtual clusters of which to limit the Access Key scope to.

  7. Click the button.

  8. In the pop up window, make sure to copy the generated Access Key from the prompt as you will not be able to fetch this key again!

  9. Click the button.

Login via Access Key​

You can use an access key to login to vCluster Platform via the vCluster CLI:

vcluster login my-vcluster-platform-url.com --access-key ACCESS_KEY