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

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:

📘

Helm Chart

You can access the Shipa Helm chart through the following link:

https://github.com/shipa-corp/helm-chart

1. Create a namespace where the Shipa services should be installed

NAMESPACE=shipa-system
kubectl create namespace $NAMESPACE

2. Download Shipa helm chart

curl  -L -s -o shipa1.1.1.zip https://github.com/shipa-corp/helm-chart/archive/v1.1.1.zip && unzip shipa1.1.1.zip && cd helm-chart-1.1.1

3. Apply the limits to the chosen namespace

kubectl apply -f limits.yaml --namespace=$NAMESPACE

4. Update Helm dependencies

helm dep up

5. Create the values.override.yaml with the Admin user and password that will be used for Shipa

📘

Admin Password

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

cat > values.override.yaml << EOF
auth:
  adminUser: admin-email-here
  adminPassword: admin-password-here
EOF

6. Install Shipa

helm install shipa . --timeout=1000s --namespace=$NAMESPACE -f values.override.yaml

📘

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=

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 executing the Helm install, the install process itself will take several minutes, depending on the Node configuration.

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

📘

Install completion

When you see the Shipa Dashboard service running, which should be called dashboard-web-1-x, the install is complete.

Updated 11 days ago


What's Next

Getting started with Shipa

Getting Started with Shipa
Downloading the 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.