Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
Skip to Content
CLICommands

orl imports credential create

Create a model import credential, part of the orl CLI for OpenRelay GPU VMs, pods, batches and billing. Usage, every flag and an example.

orl imports credential create --name <name> --type <type>

Saves a credential your model imports read a private source with: a Hugging Face token, an S3 role or key pair, or a Google Cloud credential. A Google Cloud credential is a workload identity pool provider or a service account key. A secret is sealed with a key only the organization's import sessions can use, and is never returned. An s3_role answers with the external id issued for it and the role its trust policy must admit; a gcs_federation with the subject its pool must admit. A field the type does not take, or a malformed secret, answers 400. An organization holds at most 50, and a role or pool provider another organization registered answers 409 CREDENTIAL_CLAIMED.

Flags

FlagTypeRequired
--access-key-idstringnoAn s3_keys pair's access key id (AKIA...).
--audiencestringnoA gcs_federation credential's workload identity pool provider, in the customer's project (//iam.googleapis.com/projects/<number>/locations/global/workloadIdentityPools/<pool>/providers/<provider>).
--namestringyesWhat the credential is, for the people who pick it; at most 100 characters.
--role-arnstringnoAn s3_role credential's role, in the customer's account (arn:aws:iam::<account>:role/<name>).
--secretstringnoThe secret, never returned: an hf_token's Hugging Face access token (hf_...), an s3_keys pair's secret access key, or a gcs_key's service account key, the JSON Google Cloud issued. Not set for s3_role or gcs_federation.
--service-accountstringnoThe service account a gcs_federation credential acts as (<name>@<project>.iam.gserviceaccount.com), which must let the pool's principal for the org impersonate it. Unset to read as that principal.
--typehf_token, s3_role, s3_keys, gcs_federation, gcs_keyyeshf_token: a Hugging Face access token, for private and gated hf:// models. s3_role: a role in the customer's account that imports assume, with the external id issued for the org, to read s3:// objects. s3_keys: an access key pair of the customer's that reads s3:// objects. gcs_federation: a workload identity pool provider in the customer's Google Cloud project that admits the org's import sessions, to read gs:// objects. gcs_key: a service account key of the customer's that reads gs:// objects.
--bodystringnoa JSON object of request body fields, merged under any of this command's own flags that are also set, e.g. {"key":"value"}
--body-filestringnoread the --body JSON object from a file (- for stdin)

This wraps the createModelImportCredential API operation.

On this page