Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 3.3 KB

01-setup.md

File metadata and controls

65 lines (44 loc) · 3.3 KB
Raw

Provider account setup

Watch the video guide here

Serverless needs access to your cloud providers account so that it can create and manage resources on your behalf.

Here we'll provide setup instructions for different cloud provider accounts. Just pick the one for your provider and follow the steps to get everything in place for Serverless.

Amazon Web Services

Creating an administrative IAM User

We're going to create an admin user which can access and configure the services in your AWS account. To get you up and running quickly, we're going to create a AWS IAM User with administrative access to your AWS account.

Note: In a production environment we recommend reducing the permissions to the IAM User which the Framework uses.

Unfortunately, the frameworks functionality is growing so fast, we can't yet offer you a finite set of permissions it needs. In the interim, ensure that your AWS API Keys are kept in a safe, private location.

  1. Create or login to your Amazon Web Services Account and go to the Identity & Access Management (IAM) Page
  2. Click on Users and then Create New Users. Enter serverless-admin in the first field and click Create
  3. View and copy the API Key & Secret. You'll need it in the next step
  4. In the User record in the AWS IAM Dashboard, look for Managed Policies on the Permissions tab and click Attach Policy
  5. In the next screen, search for and select AdministratorAccess then click Attach

Signing up for an AWS Subscription

Most AWS services require you to have a credit card set up, otherwise you can't deploy your resources and the following error message will appear:

AWS Access Key Id needs a subscription for the service

If you created a new AWS account make sure that a credit card is set up for the account.

Setting the AWS API Key & Secret

To start using Serverless and access the AWS API you need to set the AWS API Access Key & Secret.

Quick Setup

As a quick setup to get started you can export them as environment variables so they would be accessible to Serverless and the AWS SDK in your shell:

export AWS_ACCESS_KEY_ID=<key>
export AWS_SECRET_ACCESS_KEY=<secret>
serverless deploy

Advanced & Longer Term Setup

For a more permanent solution you can also set up credentials through the aws-cli, or by configuring the credentials file of the aws-cli directly. To set them up through the aws-cli install it first then run aws configure to configure the aws-cli and credentials. Serverless will automatically use those credentials. You can even set up a different profiles for different accounts, which can be used by Serverless as well.

$ aws configure
AWS Access Key ID [None]: AKIAIOSFODNN7EXAMPLE
AWS Secret Access Key [None]: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Default region name [None]: us-west-2
Default output format [None]: ENTER

You can also edit the credentials file which is located in ~/.aws/credentials directly. Read more about that file in the AWS documentation