CLI Cluster Management

Adding New Kubernetes Clusters

To create and provision a Kubernetes cluster definition and connection, use the cluster connect command.
You can connect a cluster by using your cluster's control plane (Kubernetes API Endpoint) address.

Connecting current/active Kubernetes cluster to Shipa via kubectl.

kubectl apply -f $(shipa cluster connect -n cluster-name -c)
##Cluster name should have at most 40 characters, containing only lower case letters, numbers or dashes, starting with a letter.

By running shipa cluster connect -c you can get the control plane address from your active Kubernetes cluster context. The output of this command is a URL pointing to the Shipa Cluster Connect Chart; Then use kubectl to apply this chart.


Freshly Connected CLI Cluster - No Framework

Please note that the Shipa CLI connected cluster doesn't have a Framework attached yet. You can update the Kubernetes cluster to assign it a Framework using shipa cluster update command after connecting.


shipa cluster update CLUSTER_NAME -k framework1 -k framework2

Additional Cluster Connection Configuration

As part of the cluster connection, you can pass in configuration also via YAML.

A sample minimalistic YAML file to connect a cluster without an ingress.

  name: eks-cluster
- framework1

Sample cluster.yaml to leverage an existing nginx ingress.

  name: eks-cluster
- framework1
  type: nginx
  serviceType: LoadBalancer

To add a cluster using a YAML file with cluster details, give a path to the YAML. Once executed the output will be a connection string.

shipa cluster connect -f cluster.yaml"

Next, make sure you are still in the Kubernetes cluster context you want to add, and use kubectl to apply the manifest from the connection string.

kubectl apply -f ""

You can also combine both of the above commands into a singular command below:

kubectl apply -f $(shipa cluster connect -f cluster.yaml)

Updating Clusters

To update an existing cluster to update framework, use the following command or use cluster yaml file

shipa cluster update eks-cluster -k framework1 -k framework2

Listing Clusters

To list registered clusters, use the cluster list command.

shipa cluster list

Removing Clusters

To remove a registered cluster, use the cluster remove command.

shipa cluster remove <name> [-y]

Removes a registered cluster.


-y, --assume-yes(= false) Don't ask for confirmation