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

This page describes the software, hardware, and networking requirements for the nodes where Shipa will be installed. Shipa can be installed on a single node or a highly available Kubernetes cluster.

Kubernetes Clusters

Today, Shipa supports Kubernetes clusters versions 1.10 and higher.

Tested and supported clusters are:

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

Certain clusters, such as GKE, offer different versions of Linux and container runtimes. As described in the following section, while Shipa supports the different Linux distributions such as GKE's Container Optimized OS (cos).

Container Runtime Requirements

Shipa works with any modern Linux distribution.

For the container runtime, Shipa works with virtually any modern Docker version container runtime.

Containerd is also supported.

Shipa supports all 64-bit x86 operating systems.

Some distributions of Linux may have default firewall rules that block communication with Helm. The user should check the default firewall rules for Oracle Linux and open the required ports with firewalld if necessary.

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 Size

Nodes

vCPUs

Ram

Size 1

Up to 50

2

4GB

Size 2

Up to 200

2

8 GB

Size 3

Up to 500

4

16 GB

Size 4

Up to 1000

8

32 GB

Size 5

1000+

Contact our team

Contact 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:

Port

Service

22

Guardian

5000

Docker Registry

8080

Shipa API over HTTP

8081

Shipa 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 14 hours ago

Installation Requirements


Suggested Edits are limited on API Reference Pages

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