Skip to main content

Logging In

orka3 login

Log in to your Orka cluster with your MacStadium Customer Portal credentials. This operation launches a browser window with a login form. Prerequisites: You must be an administrator or a member of your company account in the MacStadium Customer Portal. If you can’t access the MacStadium Customer Portal, contact your account administrator and request to be invited to the account. After you log in successfully, Orka generates an authentication token and stores it in ~/.kube/config. Syntax:
Options:
Examples:

orka3 user login

Alternative command for logging in. Functions identically to orka3 login. Syntax:
Examples:

orka3 user logout

Log out of the Orka cluster. Syntax:
Options:
Examples:

Managing Tokens

orka3 user get-token

Print your authentication token from ~/.kube/config. You can use this token to log in to the Web UI or work with the Orka API. Syntax:
Options:
Examples:

orka3 user set-token

Log in with a valid authentication token. This operation lets you bypass logging in through the browser. You can obtain a token by:
  • Printing your authentication token: orka3 user get-token
  • Generating a service account token: orka3 serviceaccount token SERVICE_ACCOUNT_NAME
Syntax:
Options:
Examples:

Service Accounts

Service accounts are intended for use by CI/CD integrations and automation. To use the cluster with one of the available Orka integrations, create a service account, obtain an authentication token for it, and configure the token in your preferred integration. Admin Only: All service account operations require administrative privileges. If --namespace is not set, operations default to the orka-default namespace.

orka3 serviceaccount create

Create a service account with the specified name in the orka-default namespace or another specified namespace. After the service account is created, you cannot move it across namespaces. Service Account Name Requirements:
  • Does not exceed 253 characters
  • Consists of lowercase alphanumeric characters, dashes (-) or periods (.)
  • Begins and ends with a lowercase alphanumeric character
  • Must be unique to the namespace
After creating a service account, obtain a token for it:
Syntax:
Options:
Examples:

orka3 serviceaccount list

List the service accounts in the orka-default namespace or another specified namespace. You can also use this command to check if a specific service account already exists. Syntax:
Options:
Examples:

orka3 serviceaccount token

Obtain an authentication token for the specified service account name.
  • If --duration is not set, the token is valid for 8760 hours (1 year). Orka might return a token with a shorter or longer lifetime.
  • If --namespace is not set, assumes the service account is in the orka-default namespace.
Syntax:
Options:
Examples:

orka3 serviceaccount delete

Delete one or more service accounts in the orka-default namespace or another specified namespace.
Deleting a service account also invalidates any tokens associated with it. This cannot be undone.
Syntax:
Options:
Examples: