ShuttleOps lets you connect to your self-managed and hosted Kubernetes services.  You can set up as many connections as needed, and enjoy the same features by setting a default connection and sharing that connection with other users and teams as well.

 

Generate a ShuttleOps Kubernetes Cluster Token 

In order to connect your Kubernetes clusters to ShuttleOps, you will need to create a ShuttleOps service account and generate an access token.  The steps below will guide you to create a ShuttleOps service account and generate a token.

 

Note: You can also view the contents of the shuttleops-role-sa-binding.yaml file on GitHub here:

https://github.com/ShuttleOps/service-account-tokens

 

Step 1: Generate an access token

Open a terminal window and run the following commands:

kubectl apply -f https://raw.githubusercontent.com/ShuttleOps/service-account-tokens/main/shuttleops-role-sa-binding.yaml

TOKENNAME=`kubectl -n kube-system get serviceaccount/shuttleops -o jsonpath='{.secrets[0].name}'`

 

For macOS and Linux, run the following command:

kubectl -n kube-system get secret $TOKENNAME -o jsonpath='{.data.token}'| base64 --decode


For Windows OS, run the following commands:

TOKEN_BASE64=`kubectl -n kube-system get secret $TOKENNAME -o jsonpath='{.data.token}'`

[Text.Encoding]::Utf8.GetString([Convert]::FromBase64String(${TOKEN_BASE64}))

Copy and save the Cluster Token displayed on the screen, you will need it when setting up your Kubernetes connection in ShuttleOps.

 

Step 2: Obtain the cluster certificate

To view your Kubernetes cluster certificate, fun the following command:

kubectl config view --flatten --minify

Copy and save the CA certificate displayed on the screen, you will need it when setting up your Kubernetes connection in ShuttleOps.

  

Connect a Kubernetes Account

Click the Connect tab. Click Connect (or Edit) on the Kubernetes card.

 

If you’ve already connected a Kubernetes account to ShuttleOps and you want to connect another account, click + Add New. Enter the following information to connect your Kubernetes account to ShuttleOps. When you’re done, click Save.

 

Name  The name of the Kubernetes connection in ShuttleOps.  You will reference this name is the Deploy section of the app.

Cluster Name  The name of the cluster associated with this connection.  You will reference this name on the Manage page, on the Cluster tab.

API URL  The URL of the API used to access this cluster.

Token  The Token for the cluster API.

Kubernetes Version  Select the version of your Kubernetes cluster.

CA Certificate  The certificate used to access the cluster.  

 

ShuttleOps will automatically validate the credential. To validate the connection, simply click on the Manage tab, then click on the Clusters tab. You will be able to view the cluster added here. Drill down into the cluster to see namespaces, deployments and services.

 

Disconnect a Kubernetes Account

You can disconnect a Kubernetes account from ShuttleOps. Click the Connect tab. Click Edit on the Kubernetes card. Select a Kubernetes account from the list, then click Delete Connection.