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

Getting Started with Shipa

Shipa documentation explains step-by-step procedures to utilize the various functionalities available on Shipa; however, the steps below can offer a quick start when using Shipa for the first time.

📘

Getting Started Video

A video explaining the steps below is available through this link

Instructions

Downloading the CLI

The Shipa CLI is available for different operating systems, and you can find the download link here.

Once downloaded and available in your terminal, you are ready for the next steps!

Shipa Target Management and Login

With the Shipa CLI downloaded and available on your local machine, you can now set the target on your CLI, pointing to your Shipa instance using the following command:

shipa target add <label> <target> [--set-current|-s]

📘

Shipa Target

You can get the target IP of your Shipa instance and add it as a target by running the following commands:

$ export SHIPA_HOST=$(kubectl --namespace=shipa-system get svc shipa-ingress-nginx -o jsonpath="{.status.loadBalancer.ingress[0].ip}") && if [[ -z $SHIPA_HOST ]]; then export SHIPA_HOST=$(kubectl --namespace=shipa-system get svc shipa-ingress-nginx -o jsonpath="{.status.loadBalancer.ingress[0].hostname}") ; fi

$ shipa target-add shipa $SHIPA_HOST -s

Sample target add command

After adding the Shipa target to your CLI, you can now login by using the following command:

shipa login

The username and password should be the same as those you used during the install process.

Listing Applications

Once you are logged in, you can now list existing applications that were deployed automatically during the install process.

By default, only the dashboard application is deployed during install, and you can access it online by using the Address URL from the command output:

shipa app list

Output showing the dashboard's URL

Deploying Sample Application

Deploying your sample application is divided into 2 steps:

  • Creating an application
  • Deploying the application code

We will be deploying a Ruby application. When deploying applications directly from the source, Shipa will automatically build the image for your application. To do so, Shipa requires the Platform for the specific programming language to be added to Shipa. You can add the Ruby platform to Shipa using the following command:

shipa platform add ruby

📘

Shipa Platforms

You can add additional platforms to Shipa by changing the platform name at the end of the command.

For more details about the Shipa platforms, please visit this link.

We can now create your application framework on Shipa by using the command below:

shipa app create sample-app ruby -t shipa-admin-team

The command above will create a framework that will then be used by Shipa to deploy your application in the Kubernetes cluster. The new application will show as idle until you deploy the application code.

Shipa dashboard

With your framework created, you can now download a sample Ruby application code using the command below:

git clone https://github.com/shipa-corp/ruby-sample.git

With the download finished, you can now access the application folder:

cd ruby-sample

From inside the ruby-sample folder, you can now deploy your Ruby application to Kubernetes using Shipa with the following command:

shipa app deploy -a sample-app -f .

Once the deployment process is complete, you can see your application information, including the application's endpoint from Shipa's dashboard:

Sample application with Running status

Application info and endpoint URL

That's it. You have deployed your first application to Kubernetes using Shipa!

Sample Applications

You can find sample applications that can be used when deploying apps on Shipa by using the links below:

Updated 3 months ago


Getting Started with Shipa


Suggested Edits are limited on API Reference Pages

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