config

Client configuration

Usage

apolo config [OPTIONS] COMMAND [ARGS]...

Client configuration.

Commands:

UsageDescription

List available command aliases

Configure local docker client

List available clusters/org pairs

Log into Apolo Platform

Log into Apolo Platform in non-GUI environ

Log into Apolo Platform with token

Log out

Print current settings

Print current authorization token

Switch the active cluster

Switch the active organization

Switch the active project

aliases

List available command aliases

Usage

apolo config aliases [OPTIONS]

List available command aliases.

Options

NameDescription

--help

Show this message and exit.

docker

Configure local docker client

Usage

apolo config docker [OPTIONS]

Configure local docker client

This command configures local docker client to use Apolo Platform's docker registry.

Options

NameDescription

--help

Show this message and exit.

--docker-config PATH

Specifies the location of the Docker client configuration files

get-clusters

List available clusters/org pairs

Usage

apolo config get-clusters [OPTIONS]

List available clusters/org pairs.

This command re-fetches cluster list and then displays each cluster with available orgs.

Options

NameDescription

--help

Show this message and exit.

login

Log into Apolo Platform

Usage

apolo config login [OPTIONS] [URL]

Log into Apolo Platform.

URL is a platform entrypoint URL.

Options

NameDescription

--help

Show this message and exit.

login-headless

Log into Apolo Platform in non-GUI environ

Usage

apolo config login-headless [OPTIONS] [URL]

Log into Apolo Platform in non-GUI environ

URL is a platform entrypoint URL.

The command works similar to "apolo login" but instead of opening a browser for performing OAuth registration prints an URL that should be open on guest host.

Then user inputs a code displayed in a browser after successful login back in apolo command to finish the login process.

Options

NameDescription

--help

Show this message and exit.

login-with-token

Log into Apolo Platform with token

Usage

apolo config login-with-token [OPTIONS] TOKEN [URL]

Log into Apolo Platform with token.

TOKEN is authentication token provided by administration team. URL is a platform entrypoint URL.

Options

NameDescription

--help

Show this message and exit.

logout

Log out

Usage

apolo config logout [OPTIONS]

Log out.

Options

NameDescription

--help

Show this message and exit.

show

Print current settings

Usage

apolo config show [OPTIONS]

Print current settings.

Options

NameDescription

--help

Show this message and exit.

--energy

Including cluster energy consumption and CO2 emissions information

show-token

Print current authorization token

Usage

apolo config show-token [OPTIONS]

Print current authorization token.

Options

NameDescription

--help

Show this message and exit.

switch-cluster

Switch the active cluster

Usage

apolo config switch-cluster [OPTIONS] [CLUSTER_NAME]

Switch the active cluster.

CLUSTER_NAME is the cluster name to select. The interactive prompt is used if the name is omitted (default).

Options

NameDescription

--help

Show this message and exit.

switch-org

Switch the active organization

Usage

apolo config switch-org [OPTIONS] ORG_NAME

Switch the active organization.

ORGNAME is the organization name to select. Use literal "NOORG" to switch to using current cluster directly instead of on behalf of some org.

Options

NameDescription

--help

Show this message and exit.

switch-project

Switch the active project

Usage

apolo config switch-project [OPTIONS] [PROJECT_NAME]

Switch the active project.

PROJECT_NAME is the project name to select. The interactive prompt is used if the name is omitted (default).

Options

NameDescription

--help

Show this message and exit.

Last updated