The Shipa Developer Hub

Welcome to the Shipa developer hub. You'll find comprehensive guides and documentation to help you start working with Shipa as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Changelog

Setup Shipa Cloud

📘

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.

Register

Please open Shipa Cloud in your favorite browser and follow the on-screen instructions to register.

Next, we'll prepare your cluster so that Shipa Cloud can connect to it and start deploying applications.

Create A Framework

Next, we'll add a Framework.

Frameworks are Shipa's policy engine and logical grouping of rules applied to the applications you deploy through them.

Please go back to the Shipa Cloud Web UI and select Frameworks from the left-hand menu.

Click the Create Framework (+) icon.

Type any Name and select the Make this my default framework checkbox.

Leave the rest of the fields intact and click the Next button.

Select shipa-plan and click the Next button.

Select the Make the framework public checkbox and click the Next button.

Change the App quota to Unlimited and click the Next button.

Click the Next button a couple of times more, and finish the creation of the Framework by pressing the Create button.

📘

Please visit the Framework Management section of the docs for more info.

Add A Cluster

We're almost done. All that's left is to connect a cluster where Shipa will deploy applications.

Select Clusters from the Shipa Cloud Web UI's left-hand menu and click the Add Cluster (+) button.

Type any Name, select the Framework we defined earlier, and click the Next button.

Next, we need to install Cert Manager and create a Kubernetes ServiceAccount and a RoleBinding which Shipa can use to connect to your cluster. Once we create those, we'll need to retrieve the Address, the Token, and the CA Certificate.

Feel free to execute the command that follows if you are unsure how to create those and retrieve the information we'll need.

curl https://gist.githubusercontent.com/vfarcic/4b94570d5cb24f23b27d6f0576ec7612/raw | bash

The output of that command should contain the Address, the Token, and the CA Certificate. Please copy them and paste them into the fields in the Shipa Web UI and click the Next button.

With Traefik, the fields are optional. Shipa automatically configures it as part of its internal cluster connection workflow, and you do not need to enter any specific information.

Click the Next button to finish the process of adding a cluster.

📘

Please visit Connecting Clusters section of the docs for more information.

Add The Cluster As A Shipa Target And Login

Please execute the command that follows to add Shipa Cloud as a target of the Shipa CLI.

shipa target add shipa-cloud target.shipa.cloud --set-current

shipa login

Please type the email and password you used to register with Shipa Cloud.

📘

Please visit Shipa Target Management section of the docs for more information.

Updated 8 days ago


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.

Managing Applications From The Web UI
Managing Applications Using The CLI

Setup Shipa Cloud


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.