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

Installing Shipa

📘

This document applies only to Self-Managed Shipa. If, instead, you prefer Shipa Cloud, please visit https://apps.shipa.cloud and register. From there on, you can add existing Kubernetes cluster to be managed by Shipa Cloud by following the instructions in Connecting Clusters.

Users can install Shipa on any existing Kubernetes cluster (version 1.10.x and newer), and Shipa leverages Helm charts for the install.

Below are the steps required to have Shipa installed in your existing Kubernetes cluster:

Step 1: Add Shipa helm repo

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

helm repo update

Step 2: Install Shipa

❗️

Make sure to replace [...] in the commands that follow with your email and a password.

📘

Admin Password

Shipa requires you to use a minimum password length of 7 or more characters.

export ADMIN_EMAIL=[...]

export ADMIN_PASSWORD=[...]

helm install shipa shipa-charts/shipa \
    --namespace shipa-system --create-namespace \
    --set auth.adminUser=$ADMIN_EMAIL \
    --set auth.adminPassword=$ADMIN_PASSWORD \
    --timeout=1000s \
    --wait

📘

Static vs Dynamic IPs

By default, during the install, Shipa uses dynamic public IP set by the cloud provider. If preferred, static IP can be used instead by applying the optional parameter below when using Helm install:

--set service.nginx.loadBalancerIP=

📘

Please consult Helm Values for the information about the additional customization of the Shipa setup.

The output of the install should look like the following:

NAME: shipa
LAST DEPLOYED: <Deployment Date>
NAMESPACE: shipa-system
STATUS: deployed
REVISION: 1

🚧

Install time

After running the Helm install command, the install process will take several minutes, depending on the Cluster Node configuration.

During this process, containers will be created and restarted until all Shipa related services are running successfully.

📘

Uninstalling shipa

helm uninstall shipa removes all Shipa resources except the MongoDB persistence volume claim so users can take a backup of the previous installation.

If you are creating a new installation on the same cluster and namespace used by the previous Shipa installation, please delete persistence volume claim left from the previously uninstalled Shipa instance.

Updated 2 months ago


What's Next

Getting started with Shipa

Install Shipa Client

Installing Shipa


Suggested Edits are limited on API Reference Pages

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