Setup Shipa Cloud - Quickstart

Quickstart to start leveraging Shipa Cloud e.g SaaS


Follow the instructions in this section if you prefer to use Shipa Cloud. Otherwise, if you would like to self-manage Shipa in your cluster, please visit the Setup Self-Managed Shipa section.

Setting up Shipa Cloud is easy. We'll register, install a few components inside your Kubernetes cluster, create a framework we'll use to deploy applications, add your cluster to Shipa Cloud, and make sure that the Shipa CLI targets the Cloud.


Please open Shipa Cloud Sign Up in your favorite browser and follow the on-screen instructions to register. If you have registered before, can head straight to Shipa Cloud


Next, connect a Kubernetes cluster so that Shipa Cloud can start deploying applications.

Connect a Cluster

Once signed up, the first action needed is to connect a Kubernetes cluster of your choice. Shipa Cloud will need access to the Kubernetes API Endpoint.


In the Action Needed section or left-hand navigation in Clusters, click + Connect Cluster.
A Magic Link will be generated for you to connect your Kubernetes cluster. Enter the Kubernetes API Endpoint e.g the Kubernetes control plane address to generate the Magic Link.



FInding Your Kubernetes API Endpoint

If you need to find your Kubernetes Endpoint, can run the following kubectl command.

kubectl cluster-info | grep 'Kubernetes' | awk '/http/ {print $NF}'

If using a local Kubernetes cluster like minikube or k3d, will need to expose the Kubernetes API using a tool like
ngrok or a minikube tunnel command.

Once entered, click Generate Command and execute the Magic Link.


Copy and paste the kubectl command and execute the command.

$ curl -k "" | kubectl apply -f -

  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 22003    0 22003    0     0  60479      0 --:--:-- --:--:-- --:--:-- 61806
namespace/shipa created
secret/sh.helm.release.v1.shipa-agent.v1 created
serviceaccount/shipa-agent created
secret/shipa-agent created
configmap/shipa-agent-config created created created created created
service/shipa-agent-api created
deployment.apps/shipa-agent created

Click Done in the UI. In a few moments, your Kubernetes cluster should be wired to Shipa Cloud.


Now you are ready to deploy an application with Shipa Cloud.

Discover existing applications

You can discover applications on your cluster by providing label present on your Deployment or DaemonSet or StatefulSet in App Discovery tab of Framework associated with your cluster using an environment.

Deploy an Application

Head back to the Shipa Dashboard in the Action Needed or left-hand navigation under Applications click + Add Application.


In the Deploy Application window, can provide some basics about the application. In later documentation sections can learn about Frameworks and Teams. Examples of each have been seeded into your Shipa Cloud Account.

Name: myfirstapp
Framework: sample-framework
Team: shipa-team


Scroll down and you can pick an image of your choice to deploy. If you do not have one, can click on "Test With Sample Image", then click Deploy.

Sample Image URL:


Head back to Applications in the left-hand navigation and can dig into your newly deployed app.


By clicking into the Application, you can click on the public URL of your application.


Click on the URL, and congratulations, you have deployed your first workload on Kubernetes through Shipa Cloud.


Clicking back into the Application and clicking on "View Map", you can take a look at your workload's dependencies in a Shipa Application Map.


You are now well on your way on your Shipa Cloud journey.

Continue Learning

Make sure to stay tuned to the Shipa Blog and check out Shipa Shorts on YouTube to dig into more concepts and capabilities quickly.

A great next step would be to install the Shipa CLI e.g Shipa Client

brew tap shipa-corp/cli

brew install shipa-cloud-cli

shipa login


Shipa OAuth/SSO CLI Authentication

If using Shipa Cloud, you could register with one of several OAuth/SSO providers. To wire the CLI to SSO, head to Shipa Cloud -> Settings -> General then your token for Single Sign On CLI shipa sso login <token>


Upgrading Connected Clusters

From time to time to take advantage of new features, will need to upgrade Shipa on your connected Kubernetes clusters. Is simple via the CLI.

shipa cluster list
shipa cluster upgrade CLUSTERNAME

What’s Next

We are now ready to explore how to deploy and manage our applications with Shipa.

We can manage our applications through the Web UI or the Shipa CLI.