release clusters shell

Command reference doc for the Release CLI

Starts a local shell with the given cluster's Kubernetes and AWS access credentials configured

Description

Starts a local shell with the following environment variables set:

• KUBECONFIG set to a temporary file containg the cluster's Kubernetes config

• AWS_ACCESS_KEY_ID and AWS_SECRET_KEY set to credentials with access to the AWS account

This allows you to execute any locally installed command that respects those variables such as the aws CLI, kubectl, k9s, and many others.

This runs an an instance of your default shell respecting your $SHELL variable, falling back to bash if it's not set.

The temporary Kubeconfig file and environment variables will be cleaned up when you exit the shell.

Tip: Configure your shell to display the current Kubernetes cluster and AWS details in your prompt to make it clear which cluster/AWS account you're currently accessing.

release clusters shell [flags]

Examples

Start a shell for the default cluster:
> release clusters shell

Start a shell for a specific cluster:
> release clusters shell --cluster CLUSTER-NAME-OR-ID

Start a shell configured for a given app environment's namespace:
> release clusters shell --app APP-NAME-OR-ID --environment ENVIRONMENT-HANDLE-OR-ID

Options

--account <string>	Account name or ID (default: $RELEASE_ACCOUNT or "account" in config file)
--app <string>	App name or ID (default: $RELEASE_APP or "app" in config file)
--cluster <string>	Cluster context or ID
--environment <string>	Environment handle or ID

Options inherited from parent commands

--config <string>	config file (default is $HOME/.release.yaml)
--debug	enable debug logging

Related

• release clusters - Manage clusters