usage: ck [OPTIONS] SUBCOMMAND
SUBCOMMAND is one of the following.
acm
Launch the ACM console for current or given context
console
Launch the OpenShift console for current or given context
creds
Display credentials for a cluster
current
Display the current kubeconfig context
delete
Delete a cluster by deleting its ClusterClaim
disable-schedule
Disable scheduled hibernation/resumption for current or given cluster
enable-sa
Enable namespace service accounts for current or given cluster
enable-schedule
Enable scheduled hibernation/resumption for current or given cluster
get
Get a ClusterPool, ClusterClaim, or ClusterDeployment
hibernate
Hibernate a cluster
kubeconfig
Display the location of the kubeconfig file
list
List ClusterPools, ClusterClaims, and ClusterDeployments
lock
Lock a cluster
new
Get a new cluster by creating a ClusterClaim
pw
Copy a cluster password to the clipboard
run
Resume a hibernating cluster
state
Get the power state of a cluster
unlock
Unlock a cluster
use
Switch kubeconfig context
with
Run any command with the given context
The following OPTIONS are available:
-h Display usage for SUBCOMMAND
-v Verbosity level for information printed to stderr. Default: 0
🔝 Back to top
usage: ck acm [CONTEXT]
Launch the ACM console for current or given context
If the context matches a ClusterClaim, the kubeadmin password is copied to the clipboard
CONTEXT is the name of a kubeconfig context
'ck' context refers to the ClusterPool host
The following OPTIONS are available:
-d Display the ACM URL only
-f Force operation if cluster is currently locked
🔝 Back to top
usage: ck console [CONTEXT]
Launch the OpenShift console for current or given context
If the context matches a ClusterClaim, the kubeadmin password is copied to the clipboard
CONTEXT is the name of a kubeconfig context
'ck' context refers to the ClusterPool host
The following OPTIONS are available:
-d Display the console URL only
-f Force operation if cluster is currently locked
🔝 Back to top
usage: ck creds [OPTIONS] [CONTEXT]
Display credentials for a cluster
CAUTION: This will display the admin password.
CONTEXT is the name of a kubeconfig context that matches a ClusterClaim
The following OPTIONS are available:
-f Force operation if cluster is currently locked
-p Extract a single property, like password or api_url
-c Use the current credentials without fetching
-r Refresh the credentials by fetching a fresh copy (default)
🔝 Back to top
usage: ck current
Display the current kubeconfig context
🔝 Back to top
usage: ck delete [OPTIONS] [CONTEXT]
Delete a cluster by deleting its ClusterClaim
CONTEXT is the name of a kubeconfig context that matches a ClusterClaim
The following OPTIONS are available:
-f Force operation if cluster is currently locked
-y Delete without confirmation
🔝 Back to top
usage: ck disable-schedule [OPTIONS] [CONTEXT]
Disable scheduled hibernation/resumption for current or given cluster
CONTEXT is the name of a kubeconfig context that matches a ClusterClaim
The following OPTIONS are available:
-f Force operation if cluster is currently locked
🔝 Back to top
usage: ck enable-sa [OPTIONS] [CONTEXT]
Enable namespace service accounts for current or given cluster
Run if you do not have permission to edit the ClusterDeployment for a ClusterClaim
CONTEXT is the name of a kubeconfig context that matches a ClusterClaim
🔝 Back to top
usage: ck enable-schedule [OPTIONS] [CONTEXT]
Enable scheduled hibernation/resumption for current or given cluster
CONTEXT is the name of a kubeconfig context that matches a ClusterClaim
The following OPTIONS are available:
-f Force operation if cluster is currently locked
🔝 Back to top
usage: ck get pool|claim|cluster [NAME] [ARGS]
Get a ClusterPool, ClusterClaim, or ClusterDeployment
Each resource type supports a number of aliases (singular and plural)
and is case-insensitve
pool (cp, ClusterPool)
claim (cc, ClusterClaim)
cluster (cd, ClusterDeployment)
NAME is the name of the resource or the related ClusterClaim
if omitted, the current kubeconfig context is used if it matches a ClusterClaim
ARGS are additional args passed through to 'oc get' such as '-o yaml'
🔝 Back to top
usage: ck hibernate [CONTEXT]
Hibernate a cluster
CONTEXT is the name of a kubeconfig context that matches a ClusterClaim
The following OPTIONS are available:
-f Force operation if cluster is currently locked
🔝 Back to top
usage: ck kubeconfig [OPTIONS] [CONTEXT]
Display the location of the kubeconfig file
CONTEXT is the name of a kubeconfig context that matches a ClusterClaim
The following OPTIONS are available:
-r Refresh the kubeconfig by fetching a fresh copy
🔝 Back to top
usage: ck list pools|claims|clusters
List ClusterPools, ClusterClaims, and ClusterDeployments
Each resource type supports a number of aliases (singular and plural)
and is case-insensitve
pools (cp, ClusterPool)
claims (cc, ClusterClaim)
clusters (cd, ClusterDeployment)
🔝 Back to top
usage: ck lock [OPTIONS] [CONTEXT]
Lock a cluster
A locked cluster will not be hibernated/resumed on schedule
Other users are prevented from running certain subcommands on locked
clusters, like 'ck run', 'ck hibernate', and 'ck delete'
CONTEXT is the name of a kubeconfig context that matches a ClusterClaim
The following OPTIONS are available:
-i Use the provided lock ID instead of username
🔝 Back to top
usage: ck new [OPTIONS] POOL CLAIM
Get a new cluster by creating a ClusterClaim
POOL is the name of the ClusterPool
CLAIM is the name for the new ClusterClaim
The following OPTIONS are available:
-l Lifetime of the cluster in hours
-m Manual power management; do not enable scheduled hibernation
🔝 Back to top
usage: ck pw [OPTIONS] [CONTEXT]
Copy a cluster password to the clipboard
CAUTION: This will display the admin password.
CONTEXT is the name of a kubeconfig context that matches a ClusterClaim
The following OPTIONS are available:
-r Refresh the credentials by fetching a fresh copy
🔝 Back to top
usage: ck run [CONTEXT]
Resume a hibernating cluster
CONTEXT is the name of a kubeconfig context that matches a ClusterClaim
The following OPTIONS are available:
-f Force operation if cluster is currently locked
🔝 Back to top
usage: ck state [CONTEXT]
Get the power state of a cluster
CONTEXT is the name of a kubeconfig context that matches a ClusterClaim
🔝 Back to top
usage: ck unlock [OPTIONS] [CONTEXT]
Unlock a cluster
Removes a lock from a cluster
If you remove the last lock, you may wish to hibernate the cluster
CONTEXT is the name of a kubeconfig context that matches a ClusterClaim
The following OPTIONS are available:
-a Remove all locks
-i Use the provided lock ID instead of username
🔝 Back to top
usage: ck use CONTEXT
Switch kubeconfig context
If the context matches a ClusterClaim and the cluster is currently
hibernating, it is resumed
CONTEXT is the name of a kubeconfig context
'ck' context refers to the ClusterPool host
-f Force operation if cluster is currently locked
🔝 Back to top
usage: ck with CONTEXT COMMAND
Run any command with the given context
If the context matches a ClusterClaim and the cluster is currently
hibernating, it is resumed
CONTEXT is the name of a kubeconfig context
'ck' context refers to the ClusterPool host
COMMAND is any command, such as a script that invokes oc or kubectl
-f Force operation if cluster is currently locked
🔝 Back to top