AWS solutions documentation change
Summary
Removed detailed CloudFormation deployment instructions including GitHub token handling and stack launch process. Reorganized section ordering.
Security assessment
The changes remove documentation about GitHub personal access token storage in Secrets Manager, but there's no evidence this was done to address a specific security vulnerability. This appears to be a content reorganization rather than a security fix. While credential handling is security-related, the removal doesn't explicitly indicate a resolved vulnerability.
Diff
diff --git a/solutions/latest/modern-data-architecture-accelerator/deploy-the-solution.md b/solutions/latest/modern-data-architecture-accelerator/deploy-the-solution.md index 9d9168046..d985647df 100644 --- a//solutions/latest/modern-data-architecture-accelerator/deploy-the-solution.md +++ b//solutions/latest/modern-data-architecture-accelerator/deploy-the-solution.md @@ -5 +5 @@ -Deployment using installer CloudFormation templateTerminologyPrerequisites for CDK DeploymentDeployment +TerminologyPrerequisites for CDK DeploymentDeployment @@ -13,91 +12,0 @@ Before you deploy, review the [cost](./cost.html), [architecture](./architecture -## Deployment using installer CloudFormation template - -This solution uses AWS CloudFormation templates and stacks to automate its deployment. The CloudFormation template specifies the AWS resources included in this solution and their properties. The CloudFormation stack provisions the resources described in the template. - -**Time to deploy:** Approximately five minutes for the installer CloudFormation stack and up to 45 minutes for the sample configuration you choose to deploy with. - -### Source of the Solution Code - -The CloudFormation stack will deploy a CodePipeline pipeline. That pipeline needs to know where the solution source code is. Customers can have the source in a zipped file uploaded to S3 or point the stack to a GitHub repository. For GitHub repository, which is the default, follow these steps. - -#### Create a GitHub personal access token and store in Secrets Manager - -The CloudFormation installer stack requires a GitHub access token to access the Modern Data Architecture Accelerator code on AWS code repository. Instructions on how to create a personal access token are located on [GitHub Docs](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). - -###### Note - -The GitHub access token must have `public_repo` permissions. - -Store the personal access token in Secrets Manager as plain text in the same Region as your CloudFormation stack. Remember the name of your secret as you will be asked when launching the stack. - -With the AWS Management Console in the home Region: - - 1. Store a new secret, and select **Other type of secrets** , **Plaintext**. - - 2. Paste your secret with no formatting, leading, or trailing spaces (completely remove the example text). - - 3. Select an encryption key. - - 4. Set the secret name to something you can use later, for example, `/aws/mdaa/github-token` (case sensitive). - - 5. Select **Disable rotation**. - - - - -### Launch the installer stack - -This automated AWS CloudFormation template deploys the Modern Data Architecture Accelerator on AWS in the AWS Cloud. - - 1. Sign into [AWS Management Console](https://aws.amazon.com/console) and select the button to launch `ModernDataArchitectureAccelerator-InstallerStack` CloudFormation template. [  ](https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/new?&templateURL=https:%2F%2Fsolutions-reference.s3.amazonaws.com%2Fmodern-data-architecture-accelerator%2Fv1.0.0%2FMdaaInstallerStack.template&redirectId=SolutionWeb) - - 2. The template launches in the US East (N. Virginia) Region by default. To launch the solution in a different AWS Region, use the Region selector in the console navigation bar. - - 3. On the **Create stack** page, verify that the correct template URL is in the **Amazon S3 URL** text box and choose **Next**. - - 4. On the **Specify stack details** page, assign a name to your solution stack. This name should be unique to this deployment. Some customers may wish to deploy more than one sample and so the sample name should be in the stack name. For example, `mdaa-basicdatalake-<accountname>-<region>`. For information about naming character limitations, refer to [IAM and STS quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the _AWS Identity and Access Management User Guide_. - - 5. Under **Parameters** , review the parameters for this solution template and modify them as necessary. This solution uses the following default values. Note that some parameters are for the GitHub choice and some are for the S3 choice. - -Parameter | Default | Description ----|---|--- -**OrgName** | ` <requires input> ` | The organization name. It will be prefixed to all stacks and generated resources. -**Source** | `github` | Specify either github or S3 as the source of the solution code. -**Repository Owner** | `aws` | The owner of the git repository hosting the solution code. -**Repository Name** | `modern-data-architecture-accelerator` | The name of the git repository hosting the solution code. -**Branch Name** | `main` | The name of the git branch to use for installation. NOTE: The Branch Name parameter defaults to the latest release branch name. To determine the branch name, navigate to the Modern Data Architecture Accelerator on AWS GitHub branches page and choose the release branch you want to deploy. Release branch names align with the semantic versioning of our GitHub releases. New release branches will be available as the open-source project is updated with new features. -**Github Token SecretsManager Id** | ` <requires input> ` (only if you’re using github as the source) | This is the Secrets Manager Id you created in the pre-requisites step. -**Repository Bucket Name** | ` <requires input> ` (only if you’re using S3 as the source) | The name of the S3 bucket where the zip file of the source is found. -**Repository Bucket Object** | `release/latest.zip` (only if you’re using S3 as the source) | The key of the S3 bucket where the zip file of the source is found. -**Sample Name** | `basic datalake` | Sample configurations to run the solution with -**Subnet Id** | (optional) | Some resources such as RedShift would need a VPC and a Subnet -**VPC Id** | (optional) | Some resources such as RedShift would need a VPC and a Subnet - - 6. Choose **Next**. - - 7. On the **Configure stack options** page, choose **Next.** - - 8. On the **Review and create** page, review and confirm the settings. Select the box acknowledging that the template might create IAM resources. - - 9. Choose **Submit** to deploy the stack. - -You can view the status of the stack in the AWS CloudFormation console in the **Status** column. You should receive a `CREATE_COMPLETE` status in approximately five minutes. - - - - -### Await initial environment deployment - -Use the following procedure to ensure the Modern Data Architecture Accelerator deploys the configuration to your environment. - - 1. Sign in to the AWS Management Console and navigate to the **AWS CodePipeline** console. The pipeline with the name you designated should show a status of either `In Progress` or `Complete`. If `In Progress`, wait for the pipeline to complete. - - 2. Go to CloudFormation page again and you will see new Stacks corresponding to the modules of the solution starting to appear one after another. - - 3. The pipeline takes approximately 45 minutes to complete, though some sample configurations such as `basic datalake` will take less. - - 4. After all the stacks complete successfully, the installer pipeline will finish with a COMPLETE status. - - - - @@ -331 +240 @@ Quotas -Update the solution +Deployment using installer CloudFormation template