alanwill/aws-tailor

Tailor - the AWS Account Provisioning Service

Table of Contents

• What is Tailor?
• Architecture
  • Serverless
  • Extensible
  • Reusable
• Configured AWS and Third Party Services
  • IAM
    • Lambda Roles
    • ECS Role
  • CloudTrail
  • Config
  • Direct Connect
  • VPC
  • Enterprise Support
  • Cloudability
• Lambda functions
  • talr-receptionist
    • Request
    • Responses
    • Function Inputs
  • talr-cla
    • Input
    • Output
  • talr-director
    • Input
    • Output
  • talr-iam
    • Input
    • Output
  • talr-cloudtrail
    • Input
    • Output
  • talr-config
    • Input
    • Output
  • talr-entsupport
    • Input
    • Output
  • talr-vpc
    • Input
    • Output
  • talr-directconnect
    • Input
    • Output
  • talr-inquirer
    • Input
    • Output
  • talr-validator
    • Input
    • Output
  • talr-notify
    • Input
    • Output
• DynamoDB Tables
  • talr-cbInfo
  • talr-accountInfo
  • talr-taskStatus
• SNS Topics
  • talr-cla-request
  • talr-cla-response
  • talr-dispatch-request
  • talr-cfn-response
  • talr-notify-request
  • talr-events-push
• API Reference
  • POST /account
  • POST /iam
  • POST /cloudtrail
  • POST /config
  • POST /entsupport
  • POST /vpc
  • POST /directconnect
  • GET /account
• Error Messages
• Task Status
• Conventions/Standards
• Operations
  • Accessing IPAM console

What is Tailor?

Tailor is a service that provisions and configures AWS accounts in accordance to a company's standards. It's built to support an infinite number of accounts.

"Tailor-made AWS accounts"

The primary intent is to provision new AWS accounts as well as configure existing accounts.

The following AWS services are configured (or enabled) via Tailor:

• IAM
• CloudTrail
• Config
• Direct Connect
• VPC
• Enterprise Support

Architecture

Tailor is architected to be a serverless, extensible and reusable service. Additionally it's built with the Serverless Framework which enables rapid development of AWS Lambda functions and their related resources. The AWS specific codebase is written entirely in Python 2.7 using the AWS Python SDK and deployed to AWS Lambda while the API proxy facade is written in Node.js and deployed to Apigee Edge.

Serverless

Tailor's architecture requires the management of zero servers. There are no machines to patch, configure or maintain. It relies on various AWS Lambda functions for its primary compute layer.

Extensible

Tailor is composed of various Lambda functions that each perform a specific task or set of tasks, for example configure CloudTrail or configure IAM. Due to the discreet nature of these functions, Tailor allows for new functions to be added in order to extend the service's capabilities.

Reusable

One of the core design principles behind Tailor is to be reusable. Not only is the same service sharable by multiple divisions with distinct Payer accounts, but the entire code base can be run in another environment and would work out of the box.

Configured AWS and Third Party Services

IAM

The Identity and Access Management (IAM) service is leveraged for generally 2 use cases, the first is to enable access to an AWS account. When a user logs into AWS with their corporate SSO credentials, the role that governs their authorization is one of 6 IAM roles with a trust relationship to an IAM SAML provider, a.k.a IAM SAML Roles. The second use case, is for roles which can be assumed by other AWS services, for example Lambda and ECS roles. Tailor creates the roles and policies that support both these use cases.

Lambda Roles

ECS Role

CloudTrail

Config

Direct Connect

VPC

Enterprise Support

Cloudability

Lambda functions

Tailor is comprised of a number of discrete Lambda functions written in Python. Below we'll list them all and explain what each does.

talr-receptionist

The receptionist function receives and validates account requests in the form of a JSON payload via HTTP POST calls to /account.

Request

A creation request must include the following JSON payload in the body of the request:

{
  "accountRequest": {
      "accountCbAlias" : "acme-main",
      "accountRegulated" : True,
      "accountVpcAzCount" : "2",
      "accountVpcPrefix" : "/24",
      "accountRegion" : "us-east-1",
      "accountTagCostCenter" : "1000100099",
      "accountTagLongProjectName" : "My Super Fancy Project",
      "accountTagShortProjectName" : "MSFP",
      "accountTagEnvironment" : "tst",
      "accountUserAccessList" : "obamabadmin",
      "accountTechnicalContactFullName": "Walter White",
      "accountTechnicalContactUsername": "whitew",
      "requestorFullName" : "John Doe",
      "requestorUsername" : "doej",
      "requestorManager" : "Fred Flinstone",
      "requestorDepartment" : "Internal Affairs",
      "requestorEmailAddress" : "[email protected]",
      "externalTransactionId" : "RITM00001",
      "comment" : "Special Tag here"
  }
}

See Function Inputs below for field constraints.

Responses

A successful response will return an HTTP 200 status code with the following content:

{
    "code": "2000",
    "message" : "Request Accepted",
    "requestId": "f7ad919d-c855-4bb7-9635-fc7c22cba537"
}

A request which will lead to an account with a duplicated email address will be caught in the validation process and a failure response sent as an HTTP 409 status code:

{
    "code": "4090",
    "message": "Duplicate request"
}

Other possible error codes include code 4000 (HTTP status 400) which means that one of the fields in the JSON body is either missing or incorrectly populated (check the value including its length):

{
    "code": "4000",
    "message": "Bad request"
}

Function Inputs

The following table outlines all input fields which talr-receptionist either calculates, derives or validates from the client's payload:

Values from the above fields are persisted to DynamoDB in talr-accountInfo and the Consolidated Billing (cb) info is looked up from talr-cbInfo.

talr-cla

The CLA function calls the AWS Accounts Service (aka CLA - Create Linked Account API) to create a linked account.

Input

Output

talr-director

The director function, receives the response from the CLA service via subscription to talr-cla-response. Since the CLA service reports a few different responses, talr-director iterates through each response and responds appropriately.

For a success, it validates that the account is accessible by setting the IAM account alias then updating talr-taskStatus table with a success event. For a failure, it updates the talr-taskStatus table with a failure event.

Input

Output

talr-iam

This function configures the standard suite of IAM roles as well as the SAML provider and populates policies both AWS Managed and Customer Managed for each role.

Input

Output

talr-cloudtrail

This function configures Cloudtrail by creating a default All Region trail then setting events to be persisted to a central S3 bucket that's used by all accounts. SNS is not configured.

Input

Output

talr-config

This function configures AWS Config in every region and provisions a delivery channel. Events are configured to be sent to a central bucket common across all linked accounts, per payer account. Config Rules are also provisioned.

Input

Output

talr-entsupport

This function creates a Support Case in the payer account to configure the new linked account with Enterprise Support.

Input

Output

talr-vpc

This function invokes the cfn-core Cloudformation template asynchronously in each region specified by the requestor. Cloudformation publishes its completion status to talr-cfn-response. The CIDR block for the VPC is looked up in an IPAM and the function determines the size of each subnet based on the VPC size requested by the user.

DENY policies for the ServerAdmins and ApplicationAdmins IAM roles are also provisioned.

Input

Output

talr-directconnect

This function configures Direct Connect per VPC by looking up available VLANs in IPAM. It runs once a success event has been published to talr-cfn-response signaling that the VPC was provisioned successfully.

Input

Output

talr-inquirer

The inquirer function accepts HTTP GET calls to look up account provisioning status. It can also be used to look up when an account was created.

Input

Output

talr-validator

The validator function checks the status of each task function to ensure it completed. Once all tasks are completed it composes an email for the user and publishes an event to talr-notify-request to send the email. An event is also sent to talr-events-push with a payload that can be consumed by tertiary systems needing to be notified when an account is created.

Input

Output

talr-notify

This function receives a payload from the talr-notify-request SNS topic which includes the contents of an email to be sent, including the recipients. The function then uses SES to send the email.

Input

Output

DynamoDB Tables

talr-cbInfo

talr-accountInfo

talr-taskStatus

SNS Topics

talr-cla-request

talr-cla-response

talr-dispatch-request

talr-cfn-response

talr-notify-request

talr-events-push

API Reference

Tailor's APIs are described in Postman collections, click on the button below to import them and start using the APIs immediately.

POST /account

POST /iam

POST /cloudtrail

POST /config

POST /entsupport

POST /vpc

POST /directconnect

GET /account

Error Messages

Task Status

Sample DynamoDB Item:

{
  "requestId": "e74743c6-8e8e-40f3-b200-3509b8912e13",
  "REQUEST_VALIDATION": {
    "startTimestamp": "1464742381.02",
    "endTimestamp": "1464742382.07",
    "function": "talr-receptionist",
    "message": "None"
  },
  "CLA_SUBMISSION": {
    "startTimestamp": "1464742382.86",
    "endTimestamp": "1464742386.08",
    "function": "talr-cla",
    "message": "None"
  },  
  "CLA_CREATION": {},
  "CLA_VALIDATION": {},
  "CLOUDTRAIL": {},
  "IAM": {},
  ...
}

Conventions/Standards

• Code written in Python 2.7
• Times are recorded in epoch format
• Coding conventions follow the PEP8 standard

Operations

Accessing IPAM console

• Launch the cfn-nipap-daemon.json CloudFormation template with the following parameters:
• TailorComponentsSecurityGroup. GroupId of the existing tailor-nipap-backend-SgTailorComponents security group.
• TailorNipapDaemonAmi. Id of the Tailor NIPAP Daemon AMI found in the same account.
• Once the stack creates from the EC2 console right click on it and Launch More Like This
• Click on Launch then launch the instance with a keypair.
• Modify the *NipapDaemonSg* security group that's attached to the instance to add an inbound SSH rule as well as TCP 5000 (web UI).
• SSH to the instance using the ubuntu user
• Once on the instance run sudo paster serve /etc/nipap/nipap-www.ini
• Navigate to the NIPAP UI at http://:5000
• Log in with tailor NIPAP user and password