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 Self-Managed Shipa

📘

Follow the instructions in this section if you prefer to self-manage Shipa in your cluster. Otherwise, feel free to jump to the Setup Shipa Cloud section to register with Shipa Cloud.

Setting up a self-managed Shipa is easy. We'll install the Shipa components inside your Kubernetes cluster and we'll make sure that the cluster is added as a target inside the Shipa platform.

Requirements

The only requirement for running self-managed Shipa is a Kubernetes cluster. If using the free version of Shipa, the cluster must be running in a single-zone. Regional clusters are reserved for the Pro version.

This quickstart assumes that a Kubernetes cluster is already running and can be accessed through kubectl.

The list of more detailed requirements can be found in Installation Requirements.

🚧

All the commands in this quickstart were verified in macOS, Linux, and Windows Subsystem for Linux (WSL). You might need to modify the commands if you are using Windows (without WSL).

If this is your first time using Shipa, you might need to download the shipa command-line interface (CLI) onto your local machine.

📘

The CLI is highly recommended, but not mandatory if you are planning to use Shipa only from the Web UI.

Install Shipa onto your cluster

It's time to install Shipa inside your remote Kubernetes cluster. More detailed instructions, including those for running Shipa in a local Kubernetes cluster, can be found in Installing Shipa.

📘

Follow the Installing Helm instructions if you do not already have helm CLI.

🚧

Please change the values of the --set arguments in the helm upgrade command to match the desired initial username and password.

Bear in mind that the minimum password length is seven characters.

helm repo add shipa-charts https://shipa-charts.storage.googleapis.com

helm repo update

helm upgrade --install shipa shipa-charts/shipa \
  --set [email protected] --set auth.adminPassword=this-is-a-secret \
  --namespace shipa-system --create-namespace --timeout=1000s --wait

It might take a couple of minutes until the process is finished and Shipa is fully operational.

Add the cluster as a Shipa target

We are almost done. All that's left is to add the newly installed Shipa instance as a target so that CLI knows how to find the API.

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 --set-current

shipa login

📘

Please use the values specified as adminUser and adminPassword in the helm upgrade command.

📘

Please visit Shipa Target Management for more information about targets.

Updated about a month ago


What's Next

Shipa is now up and running and we can access it from both CLI and Web UI. 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 Self-Managed Shipa


Suggested Edits are limited on API Reference Pages

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