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

Installation Requirements

Requirements for installing Shipa Self-Hosted

This page describes the software, hardware, and networking requirements for the nodes where Shipa will be installed.

📘

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.

Kubernetes Clusters

Today, Shipa supports Kubernetes clusters versions 1.16 and higher.

Tested and supported clusters are:

  • On-premises clusters
  • Minikube
  • GKE (Google Kubernetes Engine)
  • AKS (Azure Kubernetes Service)
  • EKS (Amazon Elastic Kubernetes Service)
  • OKE (Oracle Kubernetes Engine)
  • LKE (Linode Kubernetes Engine)

🚧

Single-zone clusters

Only single-zone clusters are supported on Shipa's free version.

Container Runtime Requirements

Shipa currently supports only 64-bit x86 Linux nodes.

It is tested with ContainerD and Docker as container runtime. However, it should work in any runtime that implements Container Runtime Interface (CRI).

CPU and Memory

Hardware requirements scale based on the size of your deployment that is controlled by Shipa. These resource consumptions are at the node level, nodes where Shipa will be installed.

Deployment SizeNodesvCPUsRam
Size 1Up to 20028 GB
Size 2Up to 500416 GB
Size 3Up to 1000832 GB
Size 41000+Contact our teamContact our team

Networking Requirements

During the install, Shipa creates and uses two public IPs for Load Balancers. These Load Balancer services expose some of the Shipa services, using the following ports:

PortService
5000Docker Registry
8080Shipa API over HTTP
8081Shipa API over HTTPS

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=<Static IP>

Updated about a month ago



Installation Requirements


Requirements for installing Shipa Self-Hosted

Suggested Edits are limited on API Reference Pages

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