Stackery Quickstart Guide

With Stackery, you can get up and running and deploy your first serverless stack in just a few minutes.

If you're brand new to Stackery and serverless, we recommend reading the Introduction to Stackery before diving into this guide.

This guide will walk you through the steps of deploying a stack with the default template, as well as with an existing AWS SAM template.

Prerequisites

To get started with Stackery, the only thing you need is an active AWS account with the ability to create access keys and a terminal or shell. When you're ready to get started, have your AWS Console open to the IAM manager page, as you will need your access key later on.

Install Stackery

Head over to the Stackery Sign Up Page and create an account.

Once your account is created, you will be redirected to the getting started process in the app. Pull up your terminal (or shell in Windows) and enter the following to download and install Stackery on your machine:

OS X or Linux

$ bash <(curl -fsSL https://stackery.io/install.sh)

Windows

Download https://ga.cli.stackery.io/windows.zip
Unzip it and move stackery.exe to your preferred installation location.

Complete the installation by running:

$ stackery login

This will prompt you for the email address and password you entered on the sign-up page. Once authenticated, the Stackery CLI will provision a new API key for your account. This API key will be stored in a .stackery.toml file in your home folder and used for all further Stackery access from the command line.

Link your AWS account

Next, you will use the Stackery CLI to enter your AWS credentials. Note that your credentials are never transmitted to Stackery - they are stored locally and used to create a role for severless deployment automation. This role is set up with the absolute minimal permissions set required to carry out the task.

Setting up your AWS account will require an Access key ID and a Secret access key, which you can find at AWS Console / IAM / Users / Security Credentials. Keep these handy and enter:

$ stackery aws setup

Follow the prompts to move on to the next step in the Stackery Dashboard.

You may need to run the aws setup command multiple times to link additional AWS accounts to your Stackery account.

Create and edit your first stack

Once you have linked your AWS account, you are ready to bootstrap and deploy your first serverless project! Choose your language (at the moment the choices are JavaScript/Node.js, Python, and Java, with .NET support coming soon) and follow the commands for each language. We'll use JavaScript for our example.

Enter the following command first:

$ stackery create --stack-name myAwesomeStack --template-git-url https://github.com/stackery/hello-world-node8.git

Once you have run that, enter the following to prepare your deployment and complete the getting started process in the Stackery Dashboard:

$ stackery deploy --stack-name myAwesomeStack --env-name development --git-ref master

If you want to make any changes to the default stack before deploying, you can do so in the Stackery Dashboard or in your codebase.

Once you're happy with your changes, press the Commit button, which will push them into your AWS CodeCommit account (you can also link a GitHub account later on).

Deploying in the Stackery Dashboard

Your newly created stack is now ready to be deployed to AWS Cloudformation. Just click the Prepare Deployment button, and once the deployment is ready, hit Deploy.

You will be redirected to your AWS Console, where you can review your stack and click Execute when you're ready. In a few moments, you can click over to your Deployments tab to see your newly deployed stack in action.

Success! You've deployed a serverless app!

Deploying in the CLI

You can do everything in the Stackery CLI that you can in the Stackery Dashboard - just quicker in the case of deployment! Here are the steps for deploying in the CLI:

(Optional) $ stackery list to make sure you're logged in and can see the stack you want to deploy.

$ stackery deploy --stack-name myAwesomeStack --env-name development --git-ref master

And that's it!

Deploying with an existing SAM template

If you have an existing serverless stack with a template.yaml file, you can load it into the Stackery Dashboard from your GitHub or CodeCommit repo - all you need is a link to the repo.

Just click the Create New Stack button and fill out the required information, and your stack will be ready to deploy!

Next steps

Now that you've deployed your first stack on Stackery, use this documentation site to become familiar with the CLI commands and the resource nodes, and see our Support Site for further guides, FAQs, and to contact support should you run into any issues.

You can also try your hand at some of the tutorials below to further explore the possibilities of Stackery and serverless:

Happy deploying!

Search results

To Top