DC/OS Kubernetes CLI
A CLI is provided as a way to interact with the cluster manager and allow complete control over the life-cycle of Kubernetes clusters running on DC/OS.
Commands
The kubernetes
CLI has two useful top level commands that each refer to the particular objects you can run actions against.
- manager - commands run against the cluster
manager
. - cluster - commands run against a specific Kubernetes cluster.
For more details on available commands, run:
Manager Commands
Manager Describe
View the configuration for this service:
Manager Plans
Plan List
Show all plans for this service:
Plan Status
Display the status of the plan with the provided plan name:
Plan Start
Start the plan with the provided name and any optional plan arguments:
Plan Stop
Stop the running plan with the provided name:
Plan Stop differs from Plan Pause in the following ways:
- Pause can be issued for a specific phase or for all phases within a plan. Stop can only be issued for a plan.
- Pause updates the underlying Phase/Step state. Stop both ceases execution and of the plan and resets the plan to its initial pending state.
Plan Pause
Pause the plan, or a specific phase in that plan with the provided phase name (or UUID):
Plan Resume
Resume the plan, or a specific phase in that plan with the provided phase name (or UUID):
Plan Force-Restart
Restart the plan with the provided name, or a specific phase in the plan with the provided name, or a specific step in a phase of the plan with the provided step name.
Plan Force-Complete
Force complete a specific step in the provided phase. Example uses include the following: Abort a sidecar operation due to observed failure or known required manual preparation that was not performed.
Manager Pod
Pod List
Display the list of known pod instances:
Pod Status
Display the status for tasks in one pod or all pods:
Pod Info
Display the full state information for tasks in a pod:
Pod Restart
Restarts a given pod without moving it to a new agent:
Pod Replace
Replace should be used only when the current instance of the pod should be completely destroyed. All persistent data (read: volumes) of the pod will be destroyed. Replace should be used when a DC/OS agent is being removed, is permanently down, or pod placement constraints need to be updated. Destroys a given pod and moves it to a new agent:
Manager Update
Update Start
Launches an update operation:
Update Force-Complete
Force complete a specific step in the provided phase:
Update Force-Restart
Restart update plan, or specific step in the provided phase:
Update Package-Version
View a list of available package versions to downgrade or upgrade to:
Update Pause
Pause update plan:
Update Resume
Resume update plan:
Update Status
View status of a running update:
Manager Debug
Debug Config
List IDs of all available configurations:
Display a specified configuration:
Display the target configuration:
List ID of the target configuration:
Debug Pod
Pauses a pod’s tasks for debugging:
Resumes a pod’s normal execution following a pause command:
Debug State
Display the Mesos framework ID:
List names of all custom properties:
Display the content of a specified property:
Refresh the state cache, used for debugging:
Cluster Commands
The cluster sub-command itself represents a list of actions that can be made against a cluster, existing or otherwise (such as the case of create).
Cluster List
Lists Kubernetes clusters:
Cluster Kubeconfig
Generates a kubeconfig entry for a cluster:
Cluster Describe
View the configuration for a cluster:
Cluster Default
Default Show
Print the name of the default Kubernetes cluster:
Default Unset
Unset the default Kubernetes cluster:
Default Set
Set the default Kubernetes cluster:
Cluster Create
Create a cluster:
Cluster Update
Update a cluster:
Cluster Delete
Delete a cluster:
Cluster Backup
Create a backup of the state of a cluster:
Cluster Restore
Restore a backup of the state of a cluster:
Cluster Debug
Debug Config
List IDs of all available configurations:
Display a specified configuration:
Display the target configuration:
List ID of the target configuration:
Debug Pod
Pauses a pod’s tasks for debugging:
Resumes a pod’s normal execution following a pause command:
Display the list of known pod instances:
Display the status for tasks in one pod or all pods:
Display the full state information for tasks in a pod:
Restarts a given pod without moving it to a new agent:
Destroys a given pod and moves it to a new agent:
Debug State
Display the Mesos framework ID:
List names of all custom properties:
Display the content of a specified property:
Refresh the state cache, used for debugging:
Debug Plan
Show all plans for this service:
Display the status of the plan with the provided plan name:
Start the plan with the provided name and any optional plan arguments:
Stop the running plan with the provided name:
Pause the plan, or a specific phase in that plan with the provided phase name (or UUID):
Resume the plan, or a specific phase in that plan with the provided phase name (or UUID):
Restart the plan with the provided name, or a specific phase in the plan with the provided name, or a specific step in a phase of the plan with the provided step name.
Force complete a specific step in the provided phase. Example uses include the following: Abort a sidecar operation due to observed failure or known required manual preparation that was not performed.
Debug Endpoints
View client endpoints for this DC/OS service: