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

Frameworks

Frameworks are a logical definition of controls and policies. Framework policies are applied to applications created and deployed using a specific framework.

Frameworks can enforce policies across RBAC, network policies, security scanning, and more.

Frameworks can be bound to different clusters or cloud nodes and enforce different policies based on their configuration.

Cluster

A cluster is a named group of Kubernetes nodes that belong to a specific Kubernetes cluster. Shipa API has a scheduler algorithm that distributes applications intelligently across a cluster of nodes.

Shipa Node

A Shipa node is a physical or virtual machine with Docker installed.

Shipa nodes can be hosted both, on a cloud provider or on-premises infrastructure.

Managed Shipa Node

A managed Shipa node is a node created and managed by Shipa.

Using Shipa's cloud provider native integration, Shipa manages the created nodes, performe self-healing, auto-scale and others.

Unmanaged Node

An unmanaged node is a node created manually, and just registered with Shipa.

When using unmanaged nodes, Shipa is not able to manage these as it does with managed nodes. The management responsibilities are then transferred to the user who actually created and added the node to Shipa.

Applications

Within Shipa, an application consists of:

  • The application source code
  • An operating system dependencies list
  • A language-level dependencies list
  • Instructions on how to run the application

Within Shipa, applications have a name, a unique address, a platform, associated development teams, a repository, and a set of units.

Currently, languages supported out-of-the-box by Shipa include Python, PHP, Java, Golang, Ruby, JavaScript, and Docker container images.

Units

For Shipa, a unit is a container.

A unit has everything an application needs to run; the fetched operational system and language level dependencies, the application’s source code, the language runtime, and the application’s processes defined in the Procfile.

Platforms

A platform is a well-defined pack with installed dependencies for a language or framework that a group of applications will need. A platform can also be a container template (Docker image).

Platforms are easily extendable and managed by Shipa. Every application runs on top of a platform.

Updated 17 days ago


Concepts


Suggested Edits are limited on API Reference Pages

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