featured-article-image

Getting Started

There are four steps to getting started with Stackery:

  1. Create an account
  2. Install the Stackery command line tool
  3. Use the Stackery command line tool to login to your Stackery account and provision an API key
  4. Use the Stackery command line tool to link your Stackery account to your AWS account

Regions

Because Stackery requires certain services to be available in the region you link with Stackery, only the following regions may be used at this time:

  • US East (N. Virginia)
  • US East (Ohio)
  • US West (Oregon)
  • EU (Ireland)
  • EU (Frankfurt)
  • Asia Pacific (Tokyo)
  • Asia Pacific (Singapore)
  • Asia Pacific (Sydney)

If you want to use Stackery in a different region please contact us at support@stackery.io.

1. Create An Account

Go to https://app.stackery.io/sign-up to create an account. The form will ask for the following information:

  • Email (this will be pre-filled with your email address and cannot be changed)
  • Organization Name
  • First Name
  • Last Name
  • Password

2. Install Stackery Command Line Tool

The command line tool makes it easy to link cloud service provider accounts to your Stackery account and configure, deploy, and monitor your stacks.

OS X

$ curl -Ls https://cli.stackery.io/osx.zip > /tmp/stackery.zip
$ unzip /tmp/stackery.zip -d /usr/local/bin

Linux

$ curl -Ls https://cli.stackery.io/linux.zip > /tmp/stackery.zip
$ unzip /tmp/stackery.zip -d /usr/local/bin

Windows

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

3. Login To Stackery And Provision An API Key

Next, run:

$ stackery login

This will prompt you for your email address and password. Once authenticated, it 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.

Finally, run:

$ stackery setup-provider

This will search for AWS credentials on your machine, from the environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY and/or the shared AWS credentials file ~/.aws/credentials, and ask you to select which credentials you want to use. The credentials will be stored in the .stackery.toml configuration file in your home folder.

If you do not have the credentials you want to use on your machine you will need to provide an access key and secret. AWS credentials come in two forms: account root credentials and IAM user credentials. You can use either type of credentials with Stackery. Root credentials are the quickest way to get started using Stackery if you are new to AWS, but IAM user credentials are a more secure mechanism once user and group policies have been set up. You can find documentation for generating root credentials here and documentation for generating IAM user credentials here.

The tool will then create a link between your AWS account and your Stackery account. To complete linking the accounts, the tool will create an AWS CloudFormation stack named stackery in your AWS account. The stack includes the following resources:

  • IAM Role that enables stackery to deploy resources into your account
  • S3 Bucket to hold deployment assets
  • SNS Topic to receive deployment notifications
  • Lambda Function to forward notifications to Stackery

These resources have no up-front costs. You should expect minimal costs, often on the order of pennies per month, for these base resources once you begin creating stacks in Stackery.

You can review the CloudFormation template at https://s3-us-west-2.amazonaws.com/prod-stackery/templates/stackery.template.

Required Permissions

To successfully link an AWS account you need certain permissions. The following is a list of AWS IAM Actions required to link an AWS account. If you are missing any permissions the stackery stack will fail to create. To resolve permissions issues please contact your AWS account administrator.

  • cloudformation:CreateStack
  • cloudformation:DeleteStack
  • cloudformation:DescribeStacks
  • cloudformation:UpdateStack
  • iam:AttachRolePolicy
  • iam:CreatePolicy
  • iam:CreatePolicyVersion
  • iam:CreateRole
  • iam:DeletePolicy
  • iam:DeletePolicyVersion
  • iam:DeleteRole
  • iam:DeleteRolePolicy
  • iam:DetachRolePolicy
  • iam:GetPolicy
  • iam:GetPolicyVersion
  • iam:GetRole
  • iam:GetRolePolicy
  • iam:ListAccountAliases
  • iam:ListPolicyVersions
  • iam:PassRole
  • iam:PutRolePolicy
  • lambda:AddPermission
  • lambda:CreateEventSourceMapping
  • lambda:CreateFunction
  • lambda:DeleteEventSourceMapping
  • lambda:DeleteFunction
  • lambda:GetEventSourceMapping
  • lambda:GetFunction
  • lambda:GetFunctionConfiguration
  • lambda:GetPolicy
  • lambda:RemovePermission
  • lambda:UpdateEventSourceMapping
  • lambda:UpdateFunctionCode
  • lambda:UpdateFunctionConfiguration
  • s3:CreateBucket
  • s3:DeleteBucket
  • sns:CreateTopic
  • sns:DeleteTopic
  • sns:GetTopicAttributes
  • sns:ListTopics
  • sns:Publish
  • sns:SetTopicAttributes
  • sns:Subscribe
  • sns:Unsubscribe

Login To Stackery

Once you have successfully linked your AWS account to your Stackery account you can log into the Stackery dashboard.

Questions / Issues?

If you have any questions or issues during the setup process please reach out to us at support@stackery.io.

Try Stackery For Free

Gain control and visibility of your serverless operations from architecture design to application deployment and infrastructure monitoring.