Skip to content

Latest commit

 

History

History
1359 lines (1081 loc) · 61.7 KB

CHANGELOG.md

File metadata and controls

1359 lines (1081 loc) · 61.7 KB

Changelog

ADF releases follow the Semantic Versioning specification.

Unreleased


v4.0.0

This is a security-focused release of the AWS Deployment Framework (ADF) that aims to restrict the default access required and provided by ADF via the least-privilege principle.

Key security enhancements include:

  • Applying IAM best practices by restricting excessive permissions granted to IAM roles and policies used by ADF.
  • Leveraging new IAM features to further limit access privileges granted by default, reducing the potential attack surface.
  • Where privileged access is required for specific ADF use cases, the scope and duration of elevated privileges have been minimized to limit the associated risks.

By implementing these security improvements, ADF now follows the principle of least privilege, reducing the risk of unauthorized access or privilege-escalation attacks.

Please make sure to go through the list of changes breaking changes carefully.

As with every release, it is strongly recommended to thoroughly review and test this version of ADF in a non-production environment first.

Breaking changes

Security: Confused Deputy Problem

Addressed the Confused Deputy problem in IAM roles created by ADF to use by the AWS Services. Where supported, the roles are restricted to specific resources via an aws:SourceArn condition. If you were using the ADF roles for other resources or use cases not covered by ADF, you might need to patch the Assume Role policies accordingly.

Security: Cross-Account Access Role and the new Jump Role

ADF relies on the privileged Cross-Account Access Role to bootstrap accounts. In the past, ADF used this role for every update and deployment of the bootstrap stacks, as well as account management features.

With the release of v4.0, a jump role is introduced to lock-down the usage of the privileged cross-account access role. Part of the bootstrap stack, the adf-bootstrap-update-deployment-role is created. This role grants access to perform restricted updates that are frequently performed via the aws-deployment-framework-bootstrap pipeline. By default, the jump role is granted access to assume into this update deployment role.

A dedicated jump role manager is responsible to grant the jump role access to the cross-account access role for AWS accounts where ADF requires access and the adf-bootstrap-update-deployment-role is not available yet. For example, accounts that are newly created only have the cross-account access role to assume into. Same holds for ADF managed accounts that are not updated to the new v4.0 bootstrap stack yet.

During the installation/update of ADF, a new parameter enables you to grant the jump role temporary access to the cross-account access role as an privileged escalation path. This parameter is called GrantOrgWidePrivilegedBootstrapAccessUntil. By setting this to a date/time in the future you will grant access to the cross-account access role until that date/time. This would be required if you modify ADF itself or the bootstrap stack templates. Changing permissions like the adf-cloudformation-deployment-role is possible without relying on the cross-account access role. For most changes deployed via the bootstrap pipeline it does not require elevated privileged access to update.

With the above changes, the aws-deployment-framework-bootstrap CodeBuild project no longer has unrestricted access to the privileged cross-account role. Starting from version 4.0, access to assume the privileged cross-account access role is restricted and must be obtained through the Jump Role as described above.

Security: Restricted account management access

Account Management is able to access non-protected organization units. Prior to ADF v4.0, the account management process used the privileged cross-account assess role to operate. Hence it could move an account or update the properties of an account that is located in a protected organization unit too. With the release of v4.0, it is only able to move or manage accounts if they are accessible via the Jump Role. The Jump Role is restricted to non-protected organization units only.

This enhances the security of ADF, as defining a organization unit as protected will block access to that via the Jump Role accordingly.

Security: Restricted bootstrapping of management account

The adf-global-base-adf-build stack in the management account was initially deployed to facilitate bootstrap access to the management account. It accomplished this by creating a cross-account access role with limited permissions in the management account ahead of the bootstrapping process.

ADF created this role as it is not provisioned by AWS Organizations or AWS Control Tower in the management account itself. However, ADF required some level of access to deploy the necessary bootstrap stacks when needed.

It is important to note that deploying this role and bootstrapping the management account introduces a potential risk. A pipeline created via a deployment map could target the management account and create resources within it, which may have unintended consequences.

To mitigate the potential risk, it is recommended to implement strict least-privilege policies and apply permission boundaries to protect the management account. Additionally, thoroughly reviewing all deployment map changes is crucial to ensure no unintended access is granted to the management account.

With the release of ADF v4.0, the adf-global-base-adf-build stack is removed and its resources are moved to the main ADF CloudFormation template. These resources will only get deployed if the new AllowBootstrappingOfManagementAccount parameter is set to Yes. By default it will not allow bootstrapping of the management account.

Security: Restricted bootstrapping of deployment account

Considering the sensitive workloads that run in the deployment account, it is important to limit the permissions granted for pipelines to deploy to the deployment account itself. You should consider the deployment account a production account.

It is recommended to apply the least-privilege principle and only allow pipelines to deploy resources that are required in the deployment account.

Follow these steps after the changes introduced by the ADF v4.0 release are applied in the main branch of the aws-deployment-framework-bootstrap repository.

Please take this moment to review the following:

  • Navigate to the adf-boostrap/deployment folder in that repository.

  • Check if it contains a global-iam.yml file:

    • If it does not contain a global-iam.yml file yet, please ensure you copy the example-global-iam.yml file in that directory.
    • If it does, please compare it against the example-global-iam.yml file in that directory.
  • Apply the least-privilege principle on the permissions you grant in the deployment account.

Security: Shared Modules Bucket

ADF uses the Shared Modules Bucket as hosted in the management account in the main deployment region to share artifacts from the aws-deployment-framework-bootstrap repository.

The breaking change enforces all objects to be owned by the bucket owner from v4.0 onward.

Security: ADF Role policy restrictions

With the v4.0 release, all ADF roles and policies were reviewed, applying the latest best-practices and granting access to ADF resources only where required. This review also includes the roles that were used by the pipelines generated by ADF.

Please be aware of the changes made to the following roles:

adf-codecommit-role

The adf-codecommit-role no longer grants read/write access to all buckets. It only grants access to the buckets created and managed by ADF where it needed to. Please grant access accordingly if you use custom S3 buckets or need to copy from an S3 bucket in an ADF-generated pipeline.

adf-codebuild-role

The adf-codebuild-role can only be used by CodeBuild projects in the main deployment region. ADF did not allow running CodeBuild projects in other regions before. But in case you manually configured the role in a project in a different region it will fail to launch.

The adf-codebuild-role is no longer allowed to assume any IAM Role in the target accounts if those roles would grant access in the Assume Role Policy Document.

The adf-codebuild-role is restricted to assume only the adf-readonly-automation-role roles in the target accounts. And, in the case that the Terraform ADF Extension is enabled, it is allowed to assume the adf-terraform-role too.

It is therefore not allowed to assume the adf-cloudformation-deployment-role any longer. If you were deploying with cdk deploy into target accounts from an ADF pipeline you will need to specifically grant the adf-codebuild-role access to assume the adf-cloudformation-deployment-role. However, we strongly recommend you synthesize the templates instead and let AWS CloudFormation do the deployment for you.

For Terraform support, CodeBuild was granted access to the adf-tflocktable table in release v3.2.0. This access is restricted to only grant read/write access to that table if the Terraform extension is enabled. Please bear in mind that if you enable Terraform access the first time, you will need to use the GrantOrgWidePrivilegedBootstrapAccessUntil parameter if ADF v4.0 bootstrapped to accounts before. As this operation requires privileged access.

The adf-codebuild-role is allowed to assume into the adf-terraform-role if the Terraform extension is enabled. As written in the docs, the adf-terraform-role is configured in the global-iam.yml file. This role is commented out by default. When you define this role, it is important to make sure to grant it least-privilege access only.

adf-cloudformation-role

The adf-cloudformation-role is no longer assumable by CloudFormation. This role is used by CodePipeline to orchestrate various deployment actions across accounts. For example, CodeDeploy, S3, and obviously the CloudFormation actions.

For CloudFormation, it would instruct the service to use the CloudFormation Deployment role for the actual deployment. The CloudFormation deployment role is the role that is assumed by the CloudFormation service. This change should not impact you, unless you use this role in relation with CloudFormation that is not managed by ADF.

With v4.0, the adf-cloudformation-role is only allowed to pass the CloudFormation Deployment role to CloudFormation and no other roles to other services.

If you were/want to make use of a custom CloudFormation deployment role for specific pipelines, you need to make sure that the adf-cloudformation-role is allowed to perform an iam:PassRole action with the given role. It is recommended to limit this to be passed to the CloudFormation service only. You can find an example of this in the adf-bootstrap/deployment/global.yml file where it allows the CloudFormation role to perform iam:PassRole with the adf-cloudformation-deployment-role. When required, please grant this access in the adf-bootstrap/deployment/global-iam.yml file in the aws-deployment-framework-bootstrap repository.

Additionally, the adf-cloudformation-role is not allowed to access S3 buckets except the ADF buckets it needs to transfer pipeline assets to CloudFormation.

adf-codepipeline-role

The adf-codepipeline-role is no longer assumable by CloudFormation, CodeDeploy, and S3. The role itself was not passed to any of these services by ADF.

If you relied on the permissions that were removed, feel free to extend the role permissions via the global-iam.yml stack.

Security: Restricted access to ADF-managed S3 buckets only

With v4.0, access is restricted to ADF-managed S3 buckets only. If a pipeline used the S3 source or deployment provider, it will require the required access to those buckets. Please add the required access to the global-iam.yml bootstrap stack in the OU where it is hosted.

Grant read access to the adf-codecommit-role for S3 source buckets. Grant write access to the adf-cloudformation-role for S3 buckets an ADF pipeline deploys to.

Security: Bootstrap stack no longer named after organization unit

The global and regional bootstrap stacks are renamed to adf-global-base-bootstrap and adf-regional-base-bootstrap respectively.

In prior releases of ADF, the name ended with the organization unit name. As a result, an account could not move from one organization unit to another without first removing the bootstrap stacks. Additionally, it made writing IAM policies and SCPs harder in a least-privilege way.

When ADF v4.0 is installed, the legacy stacks will get removed by the aws-deployment-framework-bootstrap pipeline automatically. Shortly after removal, it will deploy the new bootstrap stacks.

With v4.0, accounts can move from one organization unit to another, without requiring the removal of the ADF bootstrap stacks.

Security: KMS Encryption required on Deployment Account Pipeline Buckets

The deployment account pipeline buckets only accepts KMS Encrypted objects from v4.0 onward. Ensuring that all objects are encrypted with the same KMS Key.

Before, some objects used KMS encryption while others did not. The bucket policy now requires all objects to be encrypted via the KMS key. All ADF components have been adjusted to upload with this key. If, however, you copy files from systems that are not managed by ADF, you will need to adjust these to encrypt the objects with the KMS key as well.

Security: TLS Encryption required on all ADF-managed buckets

S3 Buckets created by ADF will require TLS 1.2 or later. All actions that occur on these buckets with older TLS versions will be denied via the bucket policies that these buckets received.

New installer

The dependencies that are bundled by the move to the AWS Cloud Development Kit (CDK) v2 increased the deployment size of ADF. Unfortunately it increased the deployment size beyond the limit that is supported by the Serverless Application Repository (SAR).

Hence a new installation mechanism is required.

Please read the installation instructions carefully.

In case you are upgrading an existing installation of ADF, please consider following the upgrade steps as defined in the admin guide.

CDK v2

ADF v4.0 is built on the AWS Cloud Development Kit (CDK) v2. Which is an upgrade to CDK v1 that ADF relied on before.

For most end-users, this change would not have an immediate impact. If, however, you made customizations to ADF it might require you to upgrade these customizations to CDK v2 as well.

CodeBuild default image

As was written in the CodeBuild provider docs, it is a best-practice to define the exact CodeBuild container image you would like to use for each pipeline.

However, in case you rely on the default, in prior ADF releases it would default to UBUNTU_14_04_PYTHON_3_7_1. This container image is no longer supported. With ADF v4.0, using the CodeBuild provider requires defining the specific CodeBuild container image to use. This way, it will not fallback to a default that might be secure today but deprecated in the future.

For each pipeline definition in the deployment maps, the CodeBuild image will need to be defined. Alternatively, upgrade ADF and check which pipelines failed to deploy after. Most likely all pipelines already define the CodeBuild image to use, as the previous default image is not supported by AWS CodeBuild.

ADF Renaming of Roles

ADF v4.0 changes most of the roles that it relies on. The reason for this change is to make it easier to secure ADF with Service Control Policies and IAM permission boundaries. Where applicable, the roles received a new prefix. This makes it easier to identify what part of ADF relies on those roles and whom should have access to assume the role or modify it.

Previous prefix Previous name New prefix New name
/ ${CrossAccountAccessRoleName}-readonly /adf/organizations/ adf-organizations-readonly
/ adf-update-cross-account-access-role /adf/bootstrap/ adf-update-cross-account-access
/adf-automation/ adf-create-repository-role /adf/pipeline-management/ adf-pipeline-management-create-repository
/adf-automation/ adf-pipeline-provisioner-generate-inputs /adf/pipeline-management/ adf-pipeline-management-generate-inputs
/adf-automation/ adf-pipeline-create-update-rule /adf/pipeline-management/ adf-pipeline-management-create-update-rule
/ adf-event-rule-${AWS::AccountId}-${DeploymentAccountId}-EventRole-* /adf/cross-account-events/ adf-cc-event-from-${AWS::AccountId}-to-${DeploymentAccountId}
------------------ --------------------------------------------------------------------- ---------------------------- ---------------------------------------------------------------

ADF Renaming of Resources

Type Previous name New name
StateMachine EnableCrossAccountAccess adf-bootstrap-enable-cross-account
StateMachine ADFPipelineManagementStateMachine adf-pipeline-management
StateMachine PipelineDeletionStateMachine-* adf-pipeline-management-delete-outdated
Lambda DeploymentMapProcessorFunction adf-pipeline-management-deployment-map-processor
Lambda ADFPipelineCreateOrUpdateRuleFunction adf-pipeline-management-create-update-rule
Lambda ADFPipelineCreateRepositoryFunction adf-pipeline-management-create-repository
Lambda ADFPipelineGenerateInputsFunction adf-pipeline-management-generate-pipeline-inputs
Lambda ADFPipelineStoreDefinitionFunction adf-pipeline-management-store-pipeline-definition
Lambda ADFPipelineIdentifyOutOfDatePipelinesFunction adf-pipeline-management-identify-out-of-date-pipelines
-------------- ----------------------------------------------- --------------------------------------------------------

ADF Parameters in AWS Systems Manager Parameter Store

Some of the parameters stored by ADF in AWS Systems Manager Parameter Store were located at the root of the Parameter Store. This made it hard to maintain and restrict access to the limited set of ADF specific parameters.

With ADF v4.0, the parameters used by ADF are located under the /adf/ prefix. For example, /adf/deployment_account_id.

The global-iam.yml bootstrap stack templates get copied from their example-global-iam.yml counterparts. When this was copied in v3.2.0, the default path for the deployment_account_id parameter should be updated to /adf/deployment_account_id. Please apply this new default value to the CloudFormation templates accordingly. If you forget to do this, the stack deployment of the adf-global-base-iam stack might fail with a failure stating that it does not have permission to fetch the deployment_account_id parameter.

The error you run into if the parameter path is not updated:

An error occurred (ValidationError) when calling the CreateChangeSet operation: User: arn:aws:sts::111111111111:assumed-role/${CrossAccountAccessRoleName}/base_update is not authorized to perform: ssm:GetParameters on resource: arn:aws:ssm:${deployment_region}:111111111111:parameter/deployment_account_id because no identity-based policy allows the ssm:GetParameters action (Service: AWSSimpleSystemsManagement; Status Code: 400; Error Code: AccessDeniedException; Request ID: xxx).

If an application or customization to ADF relies on one of these parameters they will need to be updated to include this prefix. Unless the application code relies on ADF's ParameterStore class, in that case it will automatically prefix the /adf/ to all parameters read or written.

With the changes in the IAM policies, ADF's access is restricted to the /adf/ prefix. This, unfortunately implies that old parameters are not deleted when you update your installation of ADF. There is no cost associated to these parameters, so you can leave them as is. Feel free to delete the old parameters.

The parameters that are managed by ADF that got their path changed are:

For the management account, in the AWS Organizations region (us-east-1, or us-gov-west-1):

Old Parameter Path New Parameter Path
/adf_log_level /adf/adf_log_level
/adf_version /adf/adf_version
/bucket_name /adf/bucket_name
/confit /adf/config
/cross_account_access_role /adf/cross_account_access_role
/deployment_account_id /adf/deployment_account_id
/deployment_account_region /adf/deployment_account_region
/kms_arn /adf/kms_arn
/notification_channel /adf/notification_channel
/organization_id /adf/organization_id
/protected /adf/protected
/scp /adf/scp
/shared_modules_bucket /adf/shared_modules_bucket
/tagging-policy /adf/tagging_policy
/target_regions /adf/target_regions

For the management account, in other ADF regions:

Old Parameter Path New Parameter Path
/adf_version /adf/adf_version
/bucket_name /adf/bucket_name
/cross_account_access_role /adf/cross_account_access_role
/deployment_account_id /adf/deployment_account_id
/kms_arn /adf/kms_arn

For the deployment account, in the deployment region:

Old Parameter Path New Parameter Path
/adf_log_level /adf/adf_log_level
/adf_version /adf/adf_version
/auto_create_repositories /adf/scm/auto_create_repositories
/cross_account_access_role /adf/cross_account_access_role
/default_scm_branch /adf/scm//default_scm_branch
/deployment_account_bucket /adf/shared_modules_bucket
/master_account_id /adf/management_account_id
/notification_endpoint /adf/notification_endpoint
/notification_type /adf/notification_type
/organization_id /adf/organization_id

For the deployment account, in other ADF regions:

Old Parameter Path New Parameter Path
/adf_log_level /adf/adf_log_level
/adf_version /adf/adf_version
/cross_account_access_role /adf/cross_account_access_role
/deployment_account_bucket /adf/shared_modules_bucket
/master_account_id /adf/management_account_id
/notification_endpoint /adf/notification_endpoint
/notification_type /adf/notification_type
/organization_id /adf/organization_id

For a target account, in each ADF region:

Old Parameter Path New Parameter Path
/bucket_name /adf/bucket_name
/deployment_account_id /adf/deployment_account_id
/kms_arn /adf/kms_arn

AWS CodeStar Connections OAuth Token support dropped

ADF v4.0 discontinued the support for the OAuth Token stored in SSM Parameter Store. As this method is not advised to be used by CodePipeline, and might leave the OAuth Token accessible to other users of the deployment account. As this is not a security best practice, ADF v4.0 no longer supports it.

To upgrade, please read the Administrator Guide on Using AWS CodeConnections for Bitbucket, GitHub, or GitLab.

AWS CodeStar Connections changed to AWS CodeConnections

The AWS CodeStar Connection service changed its name to AWS CodeConnections.

If you configured a CodeStar Connection before, you can continue to use that. You do not need to update the CodeStar policy as defined in the aws-deployment-framework-bootstrap/adf-bootstrap/deployment/global-iam.yml stack.

However, please update the pipeline definitions in your deployment map files. The changes you need to make are renaming the source provider from codestar to codeconnections. Also update the codestar_connection_path source property to codeconnections_param_path.

Both of these changes can be seen in the following example:

pipelines:
  - name: sample-vpc
    default_providers:
      source:
        # provider: codestar
        provider: codeconnections
        properties:
          # codestar_connection_path: /adf/my_connection_arn_param
          codeconnections_param_path: /adf/my_connection_arn_param

If you are upgrading from the GitHub OAuth token or otherwise require a new source code connection, please proceed with the AWS CodeConnections configuration as defined in the Admin Guide - Using AWS CodeConnections for Bitbucket, GitHub, or GitLab.

Features

  • Update CDK from v1 to v2 (#619), by @pergardebrink, resolves #503, #614, and #617.

  • Account Management State Machine will now opt-in to target regions when creating an account (#604) by @StewartW.

  • Add support for nested organization unit targets (#538) by @StewartW, resolves #20.

  • Enable single ADF bootstrap and pipeline repositories to multi-AWS Organization setup, resolves #410:

    • Introduce the org-stage (#636) by @AndyEfaa.
    • Add support to allow empty targets in deployment maps (#634) by @AndyEfaa.
    • Add support to define the "default-scm-codecommit-account-id" in adfconfig.yml, no value in either falls back to deployment account id (#633) by @AndyEfaa.
    • Add multi AWS Organization support to adfconfig.yml (#668) by @alexevansigg.
    • Add multi AWS Organization support to generate_params.py (#672) by @AndyEfaa.
  • Terraform: add support for distinct variable files per region per account in Terraform pipelines (#662) by @igordust, resolves #661.

  • CodeBuild environment agnostic custom images references, allowing to specify the repository name or ARN of the ECR repository to use (#623) by @abhi1094.

  • Add kms_encryption_key_arn and cache_control parameters to S3 deploy provider (#669) by @alFReD-NSH.

  • Allow inter-ou move of accounts (#712) by @sbkok.

Fixes

  • Fix Terraform terrascan failure due to incorrect curl call (#607), by @lasv-az.
  • Fix custom pipeline type configuration not loaded (#612), by @lydialim.
  • Fix Terraform module execution error (#600), by @stemons, resolves #599 and #602.
  • Fix resource untagging permissions (#635) by @sbkok.
  • Fix GitHub Pipeline secret token usage (#645) by @sbkok.
  • Fix Terraform error masking by tee (#643) by @igordust, resolves #642.
  • Fix create repository bug when in rollback complete state (#648) by @alexevansigg.
  • Fix cleanup of parameters upon pipeline retirement (#652) by @sbkok.
  • Fix wave calculation for non-default CloudFormation actions and multi-region deployments (#624 and #651), by @alexevansigg.
  • Fix ChatBot channel ref + add notification management permissions (#650) by @sbkok.
  • Improve docs and add CodeStar Connection policy (#649) by @sbkok.
  • Fix Terraform account variables were not copied correctly (#665) by @donnyDonowitz, resolves #664.
  • Fix pipeline management state machine error handling (#683) by @sbkok.
  • Fix target schema for tags (#667) by @AndyEfaa.
  • Fix avoid overwriting truncated pipeline definitions with pipelines that share the same start (#653) by @AndyEfaa.
  • Fix updating old global-iam stacks in the deployment account (#711) by @sbkok.
  • Remove default org-stage reference to dev (#717) by @alexevansigg.
  • Fix racing condition on first-usage of ADF pipelines leading to an auth error (#732) by @sbkok.
  • Fix support for custom S3 deployment roles (#732) by @sbkok, resolves #355.
  • Fix pipeline completion trigger description (#734) by @sbkok, resolves #654.

Improvements

  • Sanitizing account names before using them in SFn Invocation (#598) by @StewartW, resolves #597.
  • Improve Terraform documentation sample (#605), by @lasv-az.
  • Fix CodeDeploy sample to work in gov-cloud (#609), by @sbkok.
  • Fix documentation error on CodeBuild custom image (#622), by @abhi1094.
  • Speedup bootstrap pipeline by removing unused SAM Build (#613), by @AlexMackechnie.
  • Upgrade CDK (v2.88), SAM (v1.93), and others to latest compatible version (#647) by @sbkok, resolves #644.
  • Update pip before installing dependencies (#606) by @lasv-az.
  • Fix: Adding hash to pipelines processing step function execution names to prevent collisions (#641) by @avolip, resolves #640.
  • Modify trust relations for roles to ease redeployment of roles (#526) by @AndreasAugustin, resolves #472.
  • Limit adf-state-machine-role to what is needed (#657) by @alFReD-NSH.
  • Upload SCP policies with spaces removed (#656) by @alFReD-NSH.
  • Move from ACL enforced bucket ownership to Ownership Controls + MegaLinter prettier fix (#666) by @sbkok.
  • Upgrade CDK (v2.119), SAM (v1.107), Jinja2 (v3.1.3), and others to latest compatible version (#676) by @sbkok.
  • Fix initial value type of allow-empty-targets (#678) by @sbkok.
  • Fix Shared ADF Lambda Layer builds and add move to ARM-64 Lambdas (#680) by @sbkok.
  • Add /adf params prefix and other SSM Parameter improvements (#695) by @sbkok, resolves #594 and #659.
  • Fix pipeline support for CodeBuild containers with Python < v3.10 (#705) by @sbkok.
  • Update CDK v2.136, SAM CLI 1.114, and others (#715) by @sbkok.
  • AWS CodeStar Connections name change to CodeConnections (#714) by @sbkok, resolves #616.
  • Adding retry logic for #655 and add tests for delete_default_vpc.py (#708) by @javydekoning, resolves #655.
  • Fix allow-empty-targets to match config boolean style (#725) by @sbkok.
  • Require previously optional CodeBuild image property in build/deploy from v4 onward (#731) by @sbkok, resolves #626 and #601.
  • YAML files are interpreted via YAML.safe_load instead of YAML.load (#732) by @sbkok.
  • Hardened all urlopen calls by checking the protocol (#732) by @sbkok.
  • Added check to ensure the CloudFormation deployment account id matches with the /adf/deployment_account_id if that exists (#732) by @sbkok.
  • Add automatic creation of the /adf/deployment_account_id and /adf/management_account_id if that does not exist (#732) by @sbkok.
  • Separate delete outdated state machine from pipeline creation state machines (#732) by @sbkok.
  • Review and restrict access provided by ADF managed IAM roles and permissions (#732) by @sbkok, resolves #608 and #390.
  • Add automatic clean-up of legacy bootstrap stacks, auto recreate if required (#732) by @sbkok.

Installation improvements

With the addition of CDK v2 support. The dependencies that go with it, unfortunately increased the deployment size beyond the limit that is supported by the Serverless Application Repository. Hence the SAR installer is replaced by a new installation process. Please read the Installation Guide how to install ADF. In case you are upgrading, please follow the admin guide on updating ADF instead.

  • New installation process (#677) by @sbkok.
  • Auto generate unique branch names on new version deployments (#682) by @sbkok.
  • Ensure tox fails at first pytest failure (#686) by @sbkok.
  • Install: Add checks to ensure installer dependencies are available (#702) by @sbkok.
  • Install: Add version checks and pre-deploy warnings (#726) by @sbkok.
  • Install: Add uncommitted changes check (#733) by @sbkok.

Documentation, ADF GitHub, and code only improvements

  • Fixing broken Travis link and build badge (#625), by @javydekoning.
  • Temporarily disabled cfn-lint after for #619 (#630), by @javydekoning.
  • Upgrade MegaLinter to v7 and enable cfn-lint (#632), by @javydekoning.
  • Fix linter failures (#637) by @javydekoning.
  • Linter fixes (#646) by @javydekoning.
  • Add docs enhancement regarding ADF and AWS Control Tower (#638) by @AndyEfaa.
  • Fix include all tests in pytest.ini for bootstrap CodeBuild project (#621) by @AndyEfaa.
  • Remove CodeCommitRole from initial base stack (#663) by @alFReD-NSH.
  • Fix bootstrap pipeline tests (#679) by @sbkok.
  • Add AccessControl property on S3 Buckets (#681) by @sbkok.
  • Version bump GitHub actions (#704) by @javydekoning, resolves #698.
  • Bump express from 4.17.3 to 4.19.2 in /samples/sample-fargate-node-app (#697) by @dependabot.
  • Update copyright statements and license info (#713) by @sbkok.
  • Fix dead-link in docs (#707) by @javydekoning.
  • Add BASH_SHFMT linter + linter fixes (#709) by @javydekoning.
  • Fix sample expunge VPC, if-len, and process deployment maps (#716) by @sbkok.
  • Moving CDK example app to latest CDK version (#706) by @javydekoning, resolves #618.
  • Fix Markdown Anchor Link Check (#722) by @sbkok.
  • Improve samples (#718) by @sbkok.
  • Explain special purpose of adf-bootstrap/global.yml in docs (#730) by @sbkok, resolves #615.
  • Rename deployment_account_bucket to shared_modules_bucket (#732) by @sbkok.
  • Moved CodeCommit and EventBridge templates from lambda to the bootstrap repository to ease maintenance (#732) by @sbkok.

v3.2.1

It is strongly recommended to upgrade to v4.0 or later as soon as possible. The security fixes introduced in v4.0 are not ported back to v3 due to the requirement of breaking changes. Continued use of v3 or earlier versions is strongly discouraged.

The upcoming v4 release will introduce breaking changes. As always, it is recommended to thoroughly review and test the upgrade procedure in a non-production environment before upgrading in production.

ADF v3.2.0 had a few issues that prevented clean installation in new environments, making it harder to test the upgrade process. This release, v3.2.1, resolves those installation issues and includes an updated installer for ADF to simplify the installation process.

We hope this shortens the time required to prepare for the v4 upgrade.


Fixes

  • Fix management account config alias through ADF account management (#596) by @sbkok.
  • Fix CodeBuild stage naming bug (#628) by @pozeus, resolves #627.
  • Fix Jinja2 template rendering with autoescape enabled (#690) by @sujay0412.
  • Fix missing deployment_account_id and initial deployment global IAM bootstrap (#686) by @sbkok, resolves #594 and #659.
  • Fix permissions to enable delete default VPC in management account (#699) by @sbkok.
  • Fix tagging of Cross Account Access role in the management account (#700) by @sbkok.
  • Fix CloudFormation cross-region changeset approval (#701) by @sbkok.
  • Fix clean bootstrap of the deployment account (#703) by @sbkok, resolves #696.
  • Bump Jinja2 from 3.1.3 to 3.1.4 (#720 and #721) by @dependabot.
  • Fix account management lambdas in v3.2 (#729) by @sbkok.
  • Fix management account missing required IAM Tag Role permission in v3.2 (#729) by @sbkok.

Installation enhancements

This release is the first release with the new installation process baked in. Please read the Installation Guide how to install ADF. In case you are upgrading, please follow the admin guide on updating ADF instead.

Changes baked into this release to support the new installation process:

  • New installation process (#677) by @sbkok.
  • Ensure tox fails at first pytest failure (#686) by @sbkok.
  • Install: Add checks to ensure installer dependencies are available (#702) by @sbkok.
  • Install: Add version checks and pre-deploy warnings (#726) by @sbkok.
  • Install: Add uncommitted changes check (#733) by @sbkok.

v3.2.0

Please note: this update refactored the account creation and pipeline generation to use Step Functions. Thereby, the process to track how the update progresses and how you could validate its operation changed. Please read the docs on updating ADF.

We are thankful to the community that helped enhance ADF. With this release, we decided to list the contributions per author (listed in alphabetical order) within each section. Highlighting the great contributions and enhancements that were made by them.

Features

apogorielov:

  • Add ability to override the default branch for all source code providers #370.

benbridts:

  • Allow top-level keys starting with x- or x_ in deployment maps to add support for YAML anchors #347.

dsudduth:

  • Fix AWS partition reference, adding support for AWS Gov Cloud #381, closes #332.

ivan-aws:

  • Add ability to use CodeStar sources in deployment map #312.
  • Add support to configure object ACL with S3 put object calls #412.

pozeus:

  • Add support for CodeBuild to pull from docker hub #349, requested in #196.

srabidoux:

  • Add support for account-specific SCP deployments #395.

stemons:

  • Add support for Terraform deployments #397, closes #259, implements #114.

StewartW:

  • Add ChatBot support for notifications, lifting the limit on pipelines that notify through Slack #367, closes 257, closes 297.
  • Add support for pipeline triggers #392, closes #372.
  • Add ability to define CodeCommit artifact format #389, closes #387.
  • Add deployment waves for targets, removing the manual effort to spread 50 accounts per stage #358, closes #290, implements #128, closes #296, closes #250, closes #427.
  • Add support to exclude specific account ids from a target group #358, closes #145.

sbkok:

  • Add ability to disable trigger on changes for S3/CC/GH source providers #357:
    • Allows starting the pipeline only upon a completion_trigger event, closes #308.
    • Allows you to disable reacting to the Github webhook, closes #337.
  • Add support to change the default branch on ADF bootstrap and pipelines repositories #508.
  • Add support for CodeBuild to run inside a VPC #517.
  • Refactor generate_params.py helper, adding support for per parameter/tag resolution from specific to least specific params file #559, closes #452, closes #294.
  • Add support for CodeStar CodeBuild clone ref, allowing to work on git commits in CodeBuild in pipelines #563.
  • Allow CloudFormation parameter file name configuration per target #565.

Fixes

benbridts:

  • Remove unacceptable characters from CloudFormation Stack names #346.

dependabot:

  • Bump ejs from 2.6.1 to 3.1.7 in Fargate node sample application #480.
  • Bump express from 4.16.4 to 4.17.3 in Fargate node sample application #555.

javydekoning:

  • Fix resource reference in Step Function state machine policy #461, closes #460.
  • Fix string should be array reference in Event Bridge Rule #456, closes #455.
  • Bump Jinja2 and Boto3 versions to 3.1.1 and 1.21.31 respectively #457, closes #454.
  • Ensure account alias is configured or fail #465, closes #242.
  • Fix account file processing and add debug logging #459, closes #458.

mhdaehnert:

  • Separate artifact storage bucket for CodePipeline and CodeBuild to improve parallel execution #271, closes #270.

Nr18:

  • Fix S3 object ownership controls #448, closes #447.
  • Fix param overrides functionality to support using the same source #446, closes #445.

rickardl:

  • Support paginator for parameters and empty descriptions in moved to root lambda #273, fixes #272.

tylergohl:

  • Add retry for InvalidTemplateError and GenericAccountConfigureError #384, closes #383.

StewartW:

  • Fix deployment account Step Function time outs #401, closes #400.
  • Fix incorrect step name in step function #406.
  • Update get account region function to use opted-in regions to #423, closes #420.
  • Reduce adf-codepipeline-role policy size when ADF deploys to many regions #475, closes #474.

sbkok:

  • Add missing requirements file for shared python helpers, fixes use of retrieve_organization_accounts.py helper #352.
  • Fix duplicate notification endpoint setup in pipeline generation #362.
  • Fix specifying the tag on CodeBuild repository image to use #377, closes #374.
  • Fix permission to set Support Subscription upon account creation #402, closes #379.
  • Fix duplicated steps in Account Bootstrap Step Function #414.
  • Fix global-iam example comment explaining where it is deployed #421.
  • Fix use of correct region for AWS Organizations API depending on the partition it runs in #485.
  • Fix correct use of build/deploy parameters for CodeBuild provider #489, closes #488.
  • Fix account processing to be part of our SAR distribution #487.
  • Fix Makefile use of find command on macOS #497, closes #473.
  • Fix update process to only flag helpers as executable #499.
  • Fix correct use of partitions #502.
  • Fix use of NodeJS 14 with Standard 5.0 CodeBuild containers #500, closes #385.
  • Fix MarkupSafe to v2.0.1 as v2.1 breaks compatibility with Jinja2<3.0.0 #498, closes #467, closes #441.
  • Fix use of separate container image per target #501, closes #382.
  • Fix wrapt version dependency #504.
  • Fix syncing deployment map files to S3 when needed #506.
  • Fix missing permission on cross-account org read-only role #509.
  • Fix permission to update termination protection on pipeline stacks #511.
  • Fix ADF state machines #514, closes #513.
  • Fix updating account alias when needed #515.
  • Fix tenacity version dependency #520.
  • Fix Step Function input file syncing to upload only when content changed #530, part of #518.
  • Fix pipeline generation policies #533.
  • Fix repository creation permission in pipeline management #536.
  • Fix stale pipeline deletion #535.
  • Fix account creation wait for bootstrap to complete #537, closes #518.
  • Fix initial commit implementation #534.
  • Fix account bootstrap on organization unit move #539.
  • Fix IAM Tag permissions #545.
  • Fix initial commit on new/fresh install #544.
  • Fix ADF Config storage, needs to be stored before used the first time #548.
  • Fix pipeline regeneration upon account move #550, closes #549.
  • Fix syncing to S3 in the root of the bucket #558.
  • Fix CodePipeline source account id lookup to support missing account id for providers like CodeStar #561.
  • Fix CreateRolePolicy permissions on global.yml bootstrap stacks #564.
  • Fix clean-up of stale deployment map files in the pipeline bucket #562.
  • Fix CodePipeline references to a specific config per stage over a default provider config #565.
  • Fix executable flags of helper scripts #573.
  • Fix CloudFormation permissions to update the pipeline notification SNS topic subscriptions #572.
  • Fix permissions to enable CodeBuild as a deployment provider #571.
  • Fix typos in pipeline management logical id #567.
  • Fix generate_params.py pipeline regions lookup #584.
  • Fix bootstrapping in non-protected OUs only #590.

Improvements

benbridts:

  • Clean up of protected organization unit error message #353.
  • Improvements to the Serverless Application Repository template #343, closes #342.

javydekoning:

  • Add CloudFormation linting using cfn-lint #466, closes #464.
  • Replace Travis with GitHub Actions #481.
  • Add YAML linting using yamllint #470, closes #463.
  • Fix yamllint findings #482.
  • Upgrade to CDK v1.168, pylint v2.13 and others #486.
  • Add MegaLint to organize execution of all linters configured #492, part of #491.
  • Fix linting issues in RDK sample #495.
  • Fix editor config linting #516, part of #491.
  • Improve docs, add markdown linting, and change master account to management account in docs #521, part of #491.
  • Improve code and docs by adding CSpell checks to enforce correct spelling #574.
  • Improve CSpell linter output #578.

Nr18:

  • Encrypt SNS topic using ADF's CMK KMS Key #429, closes #422.
  • Define CodeCommit description in deployment maps #469, closes #468.

ntwobike:

  • Add RDK sample to deploy custom Config rules #451.

skycolangelom:

  • Fix retry logic for DescribeRegions while creating new accounts #238, rebased and improved in #348.
  • Fix deleting default VPC when it is non-empty #238, rebased + improved in #348.

StewartW:

  • Add pipeline type parameters to enable support for other pipelines in the future #285, closes #185.
  • Add Bootstrap Repository Pipeline high-level overview documentation from a tech perspective #393, closes #211.
  • Refactor Account management to use a Step Function #394.
  • Reduce number of IAM API calls during cross-account access setup process #408.
  • Refactor Pipeline management to use a Step Function, added tech diagrams #424, closes #211.
  • Add in role paths for new account management roles #523.
  • Fix MegaLint style error #531.
  • Add deployment map source to SSM Params to identify out-of-date pipelines #525.
  • Add retry logic on pipeline generation RunCDK stage when CodeBuild is throttled #580.

sbkok:

  • Upgrade urlize from v2.11.2 to v2.11.3 #341.
  • Lock down buckets created by ADF, block public access #350.
  • Improve ADF version references in the main template #351.
  • Upgrade dependencies (CDK to v1.105, Pylint to v2.8.2, SAM CLI to v1.23.0, and others) #364.
  • Upgrade dependencies (CDK to v1.114, Pylint to v2.9.3, SAM CLI to v1.26.0, and others) #376, closes #388.
  • Improved error message with accounts yaml read failures #403, closes #213.
  • Enable setting the log level when deploying from the SAR + adding a troubleshoot ADF guide #409.
  • Update docs to state the default branch used as the source #418.
  • Change example email domains and account ids #416.
  • Update to CDK v1.137, pylint v2.12, and others to latest available #417.
  • Upgrade to Python 3.9 #415.
  • Add editorconfig to repository #483.
  • Refactor line lengths and code style #490.
  • Update CDK, use of NodeJS 16 where possible, and CodeBuild Standard 5.0 images #496, closes #291.
  • Only invoke pipeline deletion when needed #510.
  • Add reference to Step Function Pipeline Management state machine from pipelines CodeBuild execution #512.
  • Add retry logic to Step Function Lambda invocations and improved log messages #513, closes #371.
  • Make consistent use of Id in pipeline management implementation #532.
  • Add account creation in-progress retry logic, fixes SubscriptionRequiredException #540, closes #519, fixes #366.
  • Add retries to account bootstrap process #543, closes #366.
  • Update to CDK v1.181.1 and others #553.
  • Improve readability of pipeline generation executions in the newly introduced pipeline generation state machine #557.
  • Improve parameter validation on install/update of ADF, improving install/update experience #554.
  • Update to CDK v1.182.0 #560.
  • Improve adf-pipelines CodeBuild permissions to start state machines and optimized CodeBuild machine type #569.
  • Add CodeBuild VPC permissions to default permissions to easy provisioning pipelines inside VPCs #570.
  • Improve policy names in adf-bootstrap example global-iam.yml files to be unique #568.
  • Improve code readability of CodeBuild class through refactoring #566.
  • Update ADF update process and troubleshooting documentation #576.
  • Improve CloudFormation error reporting in the aws-deployment-framework-bootstrap pipeline #582.
  • Reduce number of cross-account access IAM API calls #581.
  • Add exponential back-off retries on Enable Cross-Account Access state machine #581.
  • Refactor and tighten roles used by Enable Cross-Account Access state machine #581.
  • Do not retry pipeline generation if an account is not found or the deployment map is invalid #583.
  • Refactor pipeline management pipeline input generation and execution #584.

Many thanks to our community for driving this release. And special thanks to apogorielov, benbridts, dsudduth, ivan-aws, javydekoning, mhdaehnert, Nr18, ntwobike, pozeus, rickardl, skycolangelom, srabidoux, stemons, StewartW, and tylergohl for contributing new features and improvements to ADF!


v3.1.2

Fixes

  • Fix use of the resolve: intrinsic function on the first parameter in the parameter files, #336.

v3.1.1

Fixes

  • Fixes timeout and environment_variables to be used when defined in the default CodeBuild Deployment provider properties #307, closes #306.
  • Fixes intrinsic functions for account_region param files #333, closes #147.
  • Fixes use of deployment from source directly when build stage is disabled #334, closes #236 and closes #318.

v3.1.0

Features

  • Adds Enterprise Support to account creation process #233, closes #232:
    • ADF will raise a ticket to add the account to an existing AWS support subscription when an account is created. As a prerequisite, your organization management account must already have enterprise support activated.
  • Adds nested deployment map support #266 and #328, closes #265:
    • This enables usage of sub directories within the deployment_maps folder.

Fixes

  • Fixes specific role usage to be used in Build and Deploy only #295.
  • Corrects removing pipelines anchor in docs #279.
  • Fixes CI builds due to isort version mismatch #284.
  • Fixes error handling of generate_params intrinsic upload function #277, closes #276.
  • Fixes spec_inline attribute of CodeBuild in docs #289.
  • Fixes provider spec_inline support of CodeBuild in #293.
  • Fixes supported list of intrinsic upload path styles, enables usage of s3-url and s3-key-only #275, closes #299.
  • Fixes create deployment account concurrency failure #287, closes #280.
  • Fixes approval stage usage, by limiting specific role usage to Build and Deploy steps #295.
  • Fixes yarnpkg GPG #313, closes #325.
  • Removes dependency on botocore.vendored.requests #326, closes #324.

Improvements

  • Improves docs on providers and their properties #274.
  • Separates pipeline cleanup from input generation script #288.
  • Upgrades Python from v3.7 to v3.8 #313.
  • Upgrades CodeBuild image from "aws/codebuild/standard:2.0" to "aws/codebuild/standard:5.0" #313, closes #267, closes #300.
  • Upgrades CDK from v1.32 to v1.88 #313, closes #292.

Many thanks to our community for driving this release. And special thanks to @StewartW for contributing new features to ADF!


v3.0.6

Fixes

  • Account Alias’ are no longer automatically created as the accounts full name.
  • Adding in additional wait time for account creation process (Temporary Fix)

Improvements

  • CDK Version 1.25 -> 1.32
  • Adding ability to tag pipelines (example included in docs)
  • Adding in CloudFormation:* in global-iam-example.yml for target accounts.

v3.0.5

Fixes

  • Fix CodeBuild use specific image in target stage #253.
  • Fix import references of export to output key #248.
  • Fix CodeBuild assume role to generate parameters #247.

Improvements

  • Adds s3-key-only style #249.

v3.0.4

Fixes

  • Fix CloudFormation deployment role generation.
  • Fix overwrite of deployment/global-iam.yml #227.
  • Fix IAM for retrieve organization accounts helper #229.
  • Fix IAM for package transform helper to function #228.
  • Version lock missing CDK dependencies #225.

Improvements

  • Add S3-URI and S3-URL as upload path styles #224.
  • Allow adf-automation-role policy to grant cloudformation:UpdateTerminationProtection #222.

v3.0.3

Fixes

  • Fix CodeCommit usage in pipelines.
  • Fix CodeBuild usage in pipelines with correct default values.

v3.0.2 [YANKED]

This release was yanked, as deploying it caused various issues with the default CodeBuild and CodeCommit pipeline resources. These issues are fixed in v3.0.3.


v3.0.1

Fixes

  • Fixed SCP and Tagging Policy files to use relative paths #212.

v3.0.0

This release is specifically focused two main topics: Security and Account provisioning.

Security

In this release we are limiting default IAM policies to ensure pipeline phases such as custom deployments or build phases cannot be used to elevate ones own permissions. To ensure strict separation of concerns and enforce high standards around IAM we have created two new IAM Role that lives on each AWS Account within the organization. These role are created in the global.yml (base stack) of each account and are used for the following purposes:

adf-automation-role:

When creating pipelines in ADF there are certain things that are required to be setup on multiple different accounts. For example, the source account requires a repository on it, and also a CloudWatch event. Previously the CodeBuild role would assume the adf-cloudformation-deployment-role in the target account and create the required CloudFormation stack. This pattern allowed the adf-codebuild-role to much power and thus we have removed this link.

This new role (adf-automation-role) is assumed by CodeBuild in the aws-deployment-framework-pipelines pipeline exclusively and cannot be assumed by the standard (other) deployment pipelines.

adf-readonly-automation-role:

When CodeBuild runs as part of a standard deployment pipeline (anything other than aws-deployment-framework-pipelines) it uses the role: adf-codebuild-role by default. The adf-codebuild-role has access to assume this new role (adf-readonly-automation-role) on each account within the organization. It assumes this role when running certain intrinsic functions such as import or resolve which allow values to be retrieved from other AWS Accounts within the organization. Previously, CodeBuild would assume the adf-cloudformation-deployment-role to retrieve these values which can have many actions allowed making it inappropriate to assume.

This change effectively lowers the amount of permissions the default adf-codebuild-role has. Prior to this release, using CodeBuild as a deployment stage would also default to the adf-codebuild-role which would allow the deployment stage more accesses than intended. From this release onward, CodeBuild stages will default to the adf-codebuild-role. However, since this role has very limited access, it will most likely require the user to define a custom role in order to assume and deploy resources into other accounts.

For example, if you wanted to deploy some resources with Terraform, or run "cdk deploy" you would need to provide an IAM role that has been created which has the required permissions to do so. For more information on how to create such as role, see the commented out adf-custom-deploy-role in the example-global-iam.yml.

Account Provisioning

Until this release ADF has not had a streamlined automated way to create and move AWS accounts into organizational units. With 3.0.0 we are introducing an account provisioner concept that handles the creation and OU location of AWS Accounts in a declarative format. As part of the bootstrap repository we have created a new root folder titled adf-accounts, this folder contains definition files (yaml) that describe AWS accounts along with an assortment of properties. The bootstrap pipeline automation component (in CodeBuild) will parse the files and create or move the accounts into their defined state. This allows for end to end creation, bootstrapping and pipeline generation of an AWS account (all from code!). For more information on this process and a breakdown of the file properties and syntax itself see the admin guide (also see readme.md in the adf-accounts folder).

Inter OU Moving of AWS Accounts

Moving accounts between two OU's will now trigger the previous base stack to be removed and the new base stack aligned with that Organizational Unit to be applied.

Tagging Policies

With this release, ADF enables streamlined automation and management of Tagging Policies via AWS Organizations. Tagging Policies can now be applied to OU's in the same manner as Service Control Policies could be in prior versions. Using a tagging-policy.json file in a specific folder of the bootstrap repository that matches to your organization structure enables the tagging policy for the specific OU. Read more about how tagging policies work here and see the example-tagging-policy.json in the bootstrap repo for a simple reference.

Separation of adf-cloudformation-deployment-role IAM Policy

Moving forward we have decided to move the adf-cloudformation-deployment-role policy out of the global.yml and into a new file called global-iam.yml, this change hopes to simplify and create a separation between the global.yml which contains resources related to ADF in general as opposed to the new file (global-iam.yml) which relates to what can and cannot be deployed into the account that applies that specific base stack. The new global-iam.yml file is searched for recursively in the same fashion other global.yml or regional.yml files.

Other changes

  • Resolved #196 - Support for custom CodeBuild images (You can now use custom build images in your build or deploy actions with CodeBuild. See user-guide for more information and examples.)
  • Resolved #198 - Parameter Store is no longer used for the state of the pipeline definition, this has been moved to S3.
  • Resolved #191 - Simple check to determine region is correct when deploying from SAR.
  • Resolved #189 - Enable flag for build stage bug fixed, now works as intended.
  • Resolved #180 - error handling has been fixed to correct this.
  • Resolved #178 - ADF Account provisioning is here!
  • Resolved #177 - Upgrades will not touch the global-iam.yml file which holds the cloudformation-deployment-role-policy.
  • Resolved #188 - Removed hard-coded branch name from source account CloudWatch event.
  • Resolved #148 - Base stack (iam and bootstrap) are removed and re-added based on inter OU account moves.
  • cdk version bumped to 1.2.0
  • removed hard coding of master branch on PR event action on source accounts.

Upgrading from 2.x to 3.x

With the change to 3.0 we have decided to move the bootstrap content (templates/scps) in the bootstrap repository into its own folder (adf-bootstrap). Since the bootstrap folder path is changing from the root of the repository into the adf-bootstrap folder, you will need to move your existing folder structure (.yml/scp files) into the new format. When deploying ADF 3.x from the SAR a Pull Request will get made against the bootstrap repository as per normal upgrade process. The 3.0 PR will move the ADF specific content including the deployment folder into the new structure, if you have significantly altered the global/regional.yml for the deployment account be sure to adjust this as intended prior to merging it to the main branch.

If you require to make alterations to the structure of the folders/templates simply pull the 3.0 branch down and add in your existing folder/OU structure as desired with the adf-bootstrap folder as the new root and push back into the branch.

With the 3.0 change there is also an example-global-iam.yml file that is included in the root of the adf-bootstrap folder. This file should be renamed to global-iam.yml and distributed into the folders/OUs that you intend to have CloudFormation deploy resources into. This is required in order to define what actions the role on the target accounts will have access to when deploying CloudFormation resources via CodePipeline.

Steps to perform for the upgrade process:

  • Deploy ADF.
  • Once deployed, navigate to CodeCommit, pull down the branch for 3.0. In your editor, update your folder organizational structure (if you have one) into the adf-bootstrap folder. (this folder is the new "root" for bootstrapping). Ensure you are getting the new content from the deployment folder.
  • Ensure you are bringing in the new content from the global.yml file in 3.0 release, the two roles and their associated policies (adf-automation-role, adf-readonly-automation-role).
  • Rename the example-global-iam.yml to global-iam.yml and ensure its policy suits your needs and that it is in the correct folder structure that suits your organization security requirements. (this file now holds the policy for what CFN can do on target accounts)
  • Push the updated content back to the branch and merge if all looks to be correct.