Skip to main content
Version: 2.3

Access Keys in Loft

Access keys let you authenticate with Loft API endpoints and Loft CLI in non-interactive environments such as from within CI/CD pipelines.

Create Access Key​

  1. Go to the Profile view using the menu on the left
  2. Switch to the Access Keys tab
  3. Click the button to create a new access key
  4. In the drawer that appears on the right, use the field Display Name to specify a Name for your access key
  5. OPTIONAL: Expand the Limit Access Key Scope section to specify which clusters, namespaces and virtual clusters this access key can be used for
  6. On the very bottom, click on the button to create this access key

Use Access Key​

Log in via CLI​

You can use an access key to log into Loft from non-intercative environments:

loft login [domain] --access-key=[ACCESS_KEY]

# Retrieve kube-contexts afterward:
loft use space/vcluster/cluster [name]

Kube-Context​

You can use an access key to manually construct a valid kube-context for:

CRDs​

OwnedAccessKey​

apiVersion
string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind
string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta)

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

object (com.github.loft-sh.api.pkg.apis.management.v1.OwnedAccessKeySpec)
object (com.github.loft-sh.api.pkg.apis.management.v1.OwnedAccessKeyStatus)
{
  • "apiVersion": "string",
  • "kind": "string",
  • "metadata": {
    },
  • "spec": {
    },
  • "status": {
    }
}