Stacks Quickstart

Updated 2 months ago

Koyeb Stacks are environments to upload, process, and store any files. Each Stack you create is a new, isolated environment you can use to process and store your data.

Create Stacks

1. From the Control Panel navigation bar, click the "CREATE" button and select Stack.
2. Add a Workflow to your Stack. Workflows allow you to perform processing actions on the data ingested by your Stacks. You can use Workflow templates or compose your Workflows.
3. Give a name to your Stack. Stack names are similar to bucket names. It must be unique and comply with the DNS naming convention, contain between 3 and 63 characters, and only lower-case characters, numbers, periods, and dashes.
4. Optionally, add a Store to your Stack. By default, when you create a new Stack, a Koyeb Managed Store is created. Koyeb allows you to connect existing Managed Stores or third-party cloud storage service as a Stack Store so you can integrate your Stack with your existing cloud storage services.
5. Click the "CREATE STACK" button.

Interact with Stacks using S3cmd

To interact with your Stack and upload content, you can use any S3-compatible SDKs and tools.

In this guide, we demonstrate how to upload content to your Stack using S3cmd. S3cmd is a command-line tool and client for uploading, retrieving, and managing data using the S3 protocol.

1. Download and install S3cmd.
2. Create new Stack credentials to interact with the Koyeb S3-compatible API. On the left side panel, click Account and go to the Security tab. On the Stack credentials section, click the "NEW" button to generate new Stack credentials.
3. In a terminal, type s3cmd --configure to generate an S3cmd configuration file to interact with your Stack.

1
2
3
4
5
Access Key: <GENERATED_ACCESS_KEY>
Secret Key: <GENERATED_SECRET_KEY>
Default Region [US]: eu-west-1
S3 Endpoint [s3.amazonaws.com]: eu-west-1.stacks.prod.koyeb.com
...

If you now type in your terminal: s3cmd ls, you see the list of your existing Stacks.

You can now start uploading files and interact with S3cmd. For instance, to upload files to a Stack run, the following command s3cmd put ~/file01 ~/file02 ... s3://stack-name. Your Stack Workflows process all data uploaded before being stored.

For more information on how S3cmd works, check out the documentation.

You can also explore and track your Stack data from the Stack explorer page.

Delete Stacks

Deleting Stacks are permanent and irreversible. When you delete Stacks, all Workflows and configurations associated with the Stacks are deleted. Your Stacks Stores are kept safe and stay untouched.

1. From the Control Panel, click Stacks on the left side panel.
2. The list of your Stack appears. In the list, click the menu icon on the right side of the Stack you want to delete.
3. In the menu, select Delete. A warning modal appears and asks for confirmation before deleting.
4. Click the "DELETE" button.
5. Your Stack is deleted.