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

Plan Management

By leveraging Shipa, you can easily define resource plans that can be bound to applications to limit resource consumption.

apiVersion: shipa.crossplane.io/v1alpha1
kind: Plan
metadata:
  name: cross-plan
spec:
  forProvider:
    name: cross-plan
    teams: ["cross-team"]
    cpushare: 8
    memory: 2G
    swap: 32M

Top-Level Attributes

Component

Type

Description

apiVersion

string

the version of the API.

kind

string

the kind of custom resource that will be created by Shipa.

Plan is the kind used by Shipa for managing resource plans.

metadata

the name of the custom resource that will be created by Shipa.

spec

the specification that will be used by Shipa when creating the plan.

Metadata

Component

Type

Description

name

string

the name of the custom resource that will be created by Shipa.

Specification

Component

Type

Description

name

string

the name of the plan.

Required: Yes

teams

string

the teams that can leverage this plan to assign to their applications.

Required: Yes

cpushare

int

The amount of CPU resources that should be assigned to the application as limit

Required: Yes

memory

string

The amount of memory resources that should be assigned to the application as limit.

examples are 1M, 1G, 1K

Required: Yes

swap

string

the amount of swap resources that should be assigned to the application as limit.

examples are 1M, 1G

Required: No
Condition: Only available for frameworks bound to Shipa nodes, not Kubernetes

Updated 4 months ago


Plan Management


Suggested Edits are limited on API Reference Pages

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