Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V2.0.0 #154

Merged
merged 36 commits into from
Oct 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
b098eb7
1.2.0
Jul 13, 2019
caecf4a
Merge branch 'master' of https://github.com/awslabs/aws-deployment-fr…
bundyfx Jul 17, 2019
9dd7e8d
Merge branch 'master' of https://github.com/awslabs/aws-deployment-fr…
bundyfx Jul 28, 2019
5e1dca1
Merge branch 'master' of https://github.com/awslabs/aws-deployment-fr…
bundyfx Jul 29, 2019
1ef6979
1.3.0
bundyfx Jul 29, 2019
5538699
Merge branch 'master' of https://github.com/awslabs/aws-deployment-fr…
bundyfx Jul 31, 2019
cbe9a46
1.3.0
bundyfx Aug 1, 2019
12b74ab
1.3.0
bundyfx Aug 1, 2019
114903e
1.2.5
bundyfx Aug 2, 2019
f0b7aa0
1.2.5
bundyfx Aug 2, 2019
2729ef1
1.3.0
bundyfx Aug 18, 2019
7ad8382
Merge branch 'master' of https://github.com/awslabs/aws-deployment-fr…
bundyfx Aug 18, 2019
8484dc1
2.0.0
bundyfx Aug 24, 2019
49771f6
2.0.0
bundyfx Aug 25, 2019
007fd6f
2.0.0
bundyfx Aug 25, 2019
8d5fcc2
2.0.0
bundyfx Aug 25, 2019
3339905
2.0.0
bundyfx Aug 25, 2019
509b95a
2.0.0
bundyfx Sep 13, 2019
999cb36
2.0.0
bundyfx Sep 22, 2019
f2e54eb
2.0.0
bundyfx Sep 24, 2019
4993330
2.0.0
bundyfx Sep 25, 2019
137eac2
2.0.0
bundyfx Oct 1, 2019
0d79ceb
2.0.0
bundyfx Oct 6, 2019
fd77282
Merge branch 'master' of https://github.com/awslabs/aws-deployment-fr…
bundyfx Oct 6, 2019
00b47ed
2.0.0
bundyfx Oct 7, 2019
67a0e2f
2.0.0
bundyfx Oct 8, 2019
a8b6740
2.0.0
bundyfx Oct 9, 2019
6b7ad46
2.0.0
bundyfx Oct 9, 2019
f767168
2.0.0
bundyfx Oct 9, 2019
015ba63
2.0.0
bundyfx Oct 9, 2019
1c06bbf
2.0.0
bundyfx Oct 9, 2019
521abde
2.0.0
bundyfx Oct 11, 2019
c3832bd
2.0.0
bundyfx Oct 12, 2019
ef8c1ce
2.0.0
bundyfx Oct 12, 2019
1a2031f
2.0.0
bundyfx Oct 13, 2019
59ca715
2.0.0
bundyfx Oct 13, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 0 additions & 22 deletions docs/FAQ.md

This file was deleted.

232 changes: 87 additions & 145 deletions docs/admin-guide.md

Large diffs are not rendered by default.

Binary file removed docs/images/adf-bootstrap-high-level.png
Binary file not shown.
20 changes: 20 additions & 0 deletions docs/installation-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Installation Guide

## Pre-Requisites

- [awscli](https://aws.amazon.com/cli/).
- [git](https://git-scm.com/)
- [AWS CodeCommit Setup](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-https-unixes.html)
- [AWS CloudTrail configured](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html) in the us-east-1 region within the AWS Organizations Master AWS Account.

## Installation Instructions

1. Ensure you have setup [AWS CloudTrail](https://aws.amazon.com/cloudtrail/) *(Not the default trail)* in your Master Account that spans all regions, the trail itself should be created in *us-east-1* region. Events [triggered via CloudTrail](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_incident-response.html) for AWS Organizations can only be acted upon in the US East (N. Virginia) Region.

2. In the AWS Console from your master account within **us-east-1**, head over to the Serverless Application Repository *(SAR)*. From there, search for aws-deployment-framework *(or "adf")* (ensure the checkbox *"Show apps that create custom IAM roles or resource policies"* is checked). If you are deploying ADF for the first time, fill in the required parameters for your specific use-case. For example, if you have no AWS Organization or dedicated deployment account already created, you can enter an account name and email address and ADF will create you an AWS Organization, the deployment OU, along with an AWS Account that will be used to house deployment pipelines throughout your Organization. If you already have an AWS Account you want to use as your deployment account you can specify its Account ID in the parameter *DeploymentAccountId* and leave the *DeploymentAccountName* and *DeploymentAccountEmail* empty. Next, specify the *DeploymentAccountMainRegion* parameter as the region that will host your deployment pipelines and would be considered your main AWS region. In the *DeploymentAccountTargetRegions* section of the parameters enter a list of AWS Regions that you might want to deploy your resources or applications into via AWS CodePipeline *(this can be updated whenever)*. Also specify a main notification endpoint *(email)* to receive updates about the bootstrap process. When you have entered all required information press **'Deploy'**.

3. As the stack *serverlessrepo-aws-deployment-framework* completes you can now open AWS CodePipeline from within the master account in us-east-1 and see that there is an initial pipeline execution that has been started. When ADF is deployed for the first time, it will make the initial commit with the skeleton structure of the *aws-deployment-framework-bootstrap* CodeCommit repository. From that initial commit, you can clone the repository to your local environment and make the changes required to define your desired base stacks via AWS CloudFormation templates or Service Control Policies.

4. Once the AWS CodePipeline Execution from the previous step is complete, move the Deployment Account that was created in step 2 *(or pre-existing)* into the OU called `deployment`. This action will trigger [AWS Step Functions](https://aws.amazon.com/step-functions/) to run and start the bootstrap process for the deployment account. You can view the progress of this in the AWS Step Functions console from the master account in the us-east-1 region.

5. Once the Step Function has completed, switch roles over to the newly bootstrapped deployment account in the region you defined as your main region from step 2. An AWS CodeCommit repository will have been created and will contain the initial skeleton structure committed which serves as a starting point for defining your pipelines throughout your organization. Before defining pipelines, you will most likely want to create more AWS accounts and build out your Organization. Bootstrap further accounts by moving them into the OU that corresponds to their purpose. At this point you can follow the [sample guide](./samples-guide.md) to get started with the samples included in this repository which will show in detail how pipelines function in ADF. **Note** Each account you reference in your `deployment_map.yml` must be bootstrapped into an OU prior to adding it to a pipeline.
Loading