doctl kubernetes cluster kubeconfig save
Generated on 9 Apr 2025
from doctl
version
v1.124.0
Usage
doctl kubernetes cluster kubeconfig save <cluster-id|cluster-name> [flags]
Aliases
s
Description
Adds the credentials for the specified cluster to your local kubeconfig. After this, your kubectl installation can directly manage the specified cluster.
Example
The following example saves the credentials for a cluster named example-cluster
to your local kubeconfig:
doctl kubernetes cluster kubeconfig save example-cluster
Flags
Option | Description |
---|---|
--alias |
An alias for the cluster context name. Defaults to ‘do-[region]-[cluster-name]’ |
--expiry-seconds |
The length of time the cluster credentials are valid for, in seconds. By default, the credentials are automatically renewed as needed. Default: 0 |
--help , -h |
Help for this command |
--set-current-context |
Sets the current kubectl context to that of the newest cluster in your account Default: true |
Related Commands
Command | Description |
---|---|
doctl kubernetes cluster kubeconfig | Display commands for managing your local kubeconfig |
Global Flags
Option | Description |
---|---|
--access-token , -t |
API V2 access token |
--api-url , -u |
Override default API endpoint |
--config , -c |
Specify a custom config file Default: |
--context |
Specify a custom authentication context name |
--http-retry-max |
Set maximum number of retries for requests that fail with a 429 or 500-level error
Default: 5 |
--http-retry-wait-max |
Set the minimum number of seconds to wait before retrying a failed request
Default: 30 |
--http-retry-wait-min |
Set the maximum number of seconds to wait before retrying a failed request
Default: 1 |
--interactive |
Enable interactive behavior. Defaults to true if the terminal supports it (default false)
Default: false |
--output , -o |
Desired output format [text|json] Default: text |
--trace |
Show a log of network activity while performing a command Default: false |
--verbose , -v |
Enable verbose output Default: false |