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 New Volumes

$ shipa volume create <volume-name> <plan-name> [-k/--framework <framework>] [-t/--team <team>] [-c/--capacity] [-am/--access-modes] [-o/--opt key=value]...

The command above creates a new persistent volume based on an existing volume plan.

Flag

Description

--am, --access-modes

(= "") access-mode for the volume, such as ReadWriteOnce. (mandatory)

-c, --capacity

(= "") The size of the volume that should be created by Shipa (mandatory)

-o, --opt

(= {}) Any additional options that should be used by Shipa when creating the volume (not mandatory)

-k, --framework

(= "") the framework that owns the service (mandatory if the user has access to more than one framework)

-t, --team

(= "") the team that owns the service (mandatory if the user has access to more than one team)

Updating Existing Volumes

$ shipa volume update <volume-name> <plan-name> [-k/--framework <framework>] [-t/--team <team>] [-c/--capacity] [-am/--access-modes] [-o/--opt key=value]...

The command above updates an existing persistent volume.

-o, --opt

(= {}) backend specific volume options

-k, --framework

(= "") the framework that owns the service (mandatory if the user has access to more than one framework)

-t, --team

(= "") the team that owns the service (mandatory if the user has access to more than one team)

--am, --access-modes

(= "") access-mode for the volume, such as ReadWriteOnce. (mandatory)

-c, --capacity

(= "") The size of the volume that should be created by Shipa (mandatory)

Deleting Volumes

$ shipa volume delete <volume-name>

Deletes an existing persistent volume.

Listing Volumes

$ shipa volume list

Lists existing persistent volumes.

Creating Volume Plans

$ shipa volume plan create <name> [--storage-class class]

Creates a volume plan that will be used by Shipa and users when managing volumes

Flags:

Flag

Description

--storage-class

(= "") Storage class name configured on Kubernetes for the chosen CSI provider (mandatory)

Listing Volume Plans

$ shipa volume plan list

Lists existing volume plans.

Binding Volumes to Applications

$ shipa volume bind <volume-name> <mount point> [-a/--app <appname>] [-r/--readonly] [--no-restart]

Binds an existing volume to an application.

Flags:

Flag

Description

-a, --app

(= "") The name of the application

--no-restart

(= false) prevents restarting the application

-r, --readonly

(= false) the volume will be available only for reading

Unbinding Volumes from Applications

$ shipa volume unbind <volume-name> <mount point> [-a/--app <appname>]

Unbinds a volume from an application.

Flags:

Flag

Description

-a, --app

(= "") The name of the application

--no-restart

(= false) prevents restarting the application

Updated 2 months ago


Volume


Suggested Edits are limited on API Reference Pages

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