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

Creating Plans

To create a new plan to use when deploying applications, use the plan create command.

$ shipa plan create <name> -c cpushare [-m memory] [-s swap] [-t teams] [--default]

Flags:

Flag

Description

-c, --cpushare

(= 0) Relative CPU share each unit will have available. This value is relative, so specifying the same value for all plans means all units will equally share processing power.

-d, --default

(= false) Set plan as default. This will remove the default flag from any other plan. The default plan will be automatically used when creating an application without explicitly setting a plan

-m, --memory

(= "0") Amount of available memory for units in bytes or an integer value followed by M, K, or G for megabytes, kilobytes, or gigabytes, respectively

-s, --swap

(= "0") Amount of available swap space for units in bytes or an integer value followed by M, K, or G for megabytes, kilobytes, or gigabytes, respectively

-t, --teams

(= []) Teams which are allowed to use this plan

Listing Plans

To list available plans when creating an application, use the plan list command

$ shipa plan list [--bytes]

Flags:

Flag

Description

-b, --bytes

(= false) byte-sized units for memory and swap.

Removing Plans

To remove an existing plan, use the plan remove command.

$ shipa plan remove <name>

When removed, the plan is no longer available for newly created applications. Applications that were created using the removed plan will be unaffected. They will keep using the same value amount of resources described by the plan before deletion.

Updated 5 months ago


Plans


Suggested Edits are limited on API Reference Pages

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