You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 19, 2025. It is now read-only.
-[Access the solution web UI](#access-the-solution-web-ui)
20
21
-[Uninstall the solution](#uninstall-the-solution)
@@ -25,7 +26,7 @@
25
26
26
27
## Application Pattern Orchestrator on AWS
27
28
28
-
Application Pattern Orchestrator (APO) is an AWS solution that helps customers in regulated industries such as Financial Service Industry (FSI), manufacturing, and healthcare to establish and manage an internal catalog of reusable, repeatable, well-architected, secure-by-design, and production-ready cloud infrastructure patterns for use by application development and engineering teams throughout their organizations.
29
+
Application Pattern Orchestrator (APO) is an AWS Solution that helps customers establish and manage an internal catalog of reusable, repeatable, well-architected, secure-by-design, and production-ready cloud infrastructure patterns for use by application development and engineering teams throughout their organizations.
29
30
30
31
## Licence
31
32
@@ -43,20 +44,20 @@ You can use this README file to find out how to build, deploy, use and test the
43
44
44
45
### Solution overview
45
46
46
-
Using this solution, application and technology teams can use a self-service web user interface (UI) to submit their application patterns as CloudFormation or CDK for automatic validation, manual review, approval and publishing to AWS Service Catalog as AWS Service Catalog products for CloudFormationbased patterns and to AWS CodeArtifact as software packages for CDKbased patterns.
47
+
Using this solution, application and technology teams can use a self-service web user interface (UI) to submit their application patterns as CloudFormation or CDK for automatic validation, manual review, approval and publishing to AWS Service Catalog as AWS Service Catalog products for CloudFormation-based patterns and to AWS CodeArtifact as software packages for CDK-based patterns.
47
48
48
49
This solution is intended for deployment in an enterprise by IT infrastructure and security architects, security administrators, developers, and DevSecOps professionals who have practical experience with the AWS Cloud.
49
50
50
51
### Benefits
51
52
53
+
1.**Self-service, low touch experience friendly to developers**
54
+
Facilitate contribution of application patterns from your distributed engineering teams in a decentralized manner. Automatic validation accelerates basic compliance checks allowing developers to continue to use familiar tools, such as Git, to publish, review, and iterate on pattern feedback in an asynchronous manner. Reduce reliance on central teams and improve overall productivity.
52
55
1.**Drive consistency and standardization of controls across your organizations**
53
-
Shift governance to the left by enabling the use of patterns, incorporating guardrails, for new applications, at scale. Automatically validate pattern security, architecture, and compliance, against organization specific policy-as-code. Embed attributes into patterns which are automatically inherited by new applications using the underlying patterns. Apply controls and governance consistently based on patter attributes.
54
-
1.**Self-service, low touch collaboration supported by automation**
55
-
Facilitate the contribution of application patterns from your distributed engineering teams in a decentralized manner. Automatic validation accelerates basic compliance checks, while developers continue to use familiar tools, such as Git, to review and iterate on feedback in an asynchronous manner. Reduce reliance on your central teams and increase overall productivity.
56
+
Shift governance to the left through the use of patterns incorporating guardrails, for new applications, at scale. Automatically validate pattern security, architecture, and compliance, against organization specific policy-as-code. Embed attributes to be automatically inherited by new applications using the underlying patterns. Apply controls and governance consistently based on such attributes.
56
57
1.**Centralized discovery of approved application patterns**
57
-
Allow your engineering teams to quickly browse and search for patterns via a centrally accessible, unified portal. Navigate a standalone user interface built for application developers, with ease. Automatically notify users of new patterns, and updates.
58
+
Allow your engineering teams to quickly browse and search for patterns via a centrally accessible, unified user interface built for application developers. Automatically notify users of the availability of new patterns, and updates to existing patterns.
58
59
1.**Integrated with AWS Service Catalog and Code Artifact**
59
-
Orchestrates the end-to-end publishing of approved patterns to customizable destination repositories, with out-of-the-box support for AWS Service Catalog for CloudFormation (Cfn) based patterns, and AWS CodeArtifact for Cloud Development Kit (CDK) based patterns.
60
+
Orchestrate the end-to-end publishing of approved patterns to customizable destination repositories, with out-of-the-box support for AWS Service Catalog for CloudFormation (Cfn) based patterns, and AWS CodeArtifact for Cloud Development Kit (CDK) based patterns.
60
61
61
62
---
62
63
@@ -66,7 +67,7 @@ This solution is intended for deployment in an enterprise by IT infrastructure a
66
67
67
68
The following diagram represents the solution's architecture design.
@@ -84,9 +85,9 @@ The solution deploys the following components that work together to provide patt
84
85
85
86
### AWS account
86
87
87
-
- A CDK bootstrapped AWS account: You must bootstrap your AWS CDK environment in the target region you want to deploy, using the AWS CDK toolkit's cdk bootstrap command. From the command line, authenticate into your AWS account, and run `cdk bootstrap aws://<YOUR ACCOUNT NUMBER>/<REGION>`. For more information, refer to the [AWS CDK's How to bootstrap](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html) page.
88
-
-Amazon SES should have production access: The solution utilises Amazon SES for sending email notifications to application pattern’s subscribers. In order to use this feature, please make sure Amazon SES in your account is not in sandbox environment. For more details, please refer to [Moving out of the Amazon SES sandbox page](https://docs.aws.amazon.com/ses/latest/dg/request-production-access.html).
89
-
-The AWS account should be part of an AWS Organization: This prerequisite is only applicable for application patterns that are of the CloudFormation type, and needs to be shared across accounts using AWS Service Catalog, as currently, the AWS Service Catalog AppRegistry attribute groups can only be [shared to AWS accounts within an organization](https://docs.aws.amazon.com/ram/latest/userguide/shareable.html#shareable-sc-appregistry). This prerequisite does not apply to CDKbased application patterns.
88
+
-**A CDK bootstrapped AWS account**: You must bootstrap your AWS CDK environment in the target region you want to deploy, using the AWS CDK toolkit's cdk bootstrap command. From the command line, authenticate into your AWS account, and run `cdk bootstrap aws://<YOUR ACCOUNT NUMBER>/<REGION>`. For more information, refer to the [AWS CDK's How to bootstrap](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html) page.
89
+
-**Production access for Amazon SES**: This solution uses Amazon SES for sending email notifications to application pattern’s subscribers. In order to use this feature, ensure that Amazon SES (in your account) is in a production environment, and not in the sandbox environment. For more information, refer to the [Moving out of the Amazon SES sandbox page](https://docs.aws.amazon.com/ses/latest/dg/request-production-access.html) page.
90
+
-**Your AWS account should be part of an AWS Organization**: This prerequisite is only applicable for application patterns that are of the CloudFormation type, and needs to be shared across accounts using AWS Service Catalog, as currently, the AWS Service Catalog AppRegistry attribute groups can only be [shared to AWS accounts within an organization](https://docs.aws.amazon.com/ram/latest/userguide/shareable.html#shareable-sc-appregistry). This prerequisite does not apply to CDK-based application patterns.
90
91
91
92
### Tools
92
93
@@ -99,7 +100,7 @@ The solution deploys the following components that work together to provide patt
99
100
100
101
### GitHub or GitHub Enterprise account
101
102
102
-
The solution assumes that the user is using GitHub to host their code repositories. The solution supports both GitHub Teams and GitHub Enterprise plans. Under GitHub Enterprise, the solution supports both Enterprise Cloud and Enterprise Server options.
103
+
The solution assumes the user is using GitHub to host their code repositories. The solution supports both GitHub Teams and GitHub Enterprise plans. Under GitHub Enterprise, the solution supports both Enterprise Cloud and Enterprise Server options.
103
104
104
105
A complete list of prerequisites related to GitHub/GitHub Enterprise are listed:
105
106
@@ -118,17 +119,18 @@ A complete list of prerequisites related to GitHub/GitHub Enterprise are listed:
118
119
- Create a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) from a GitHub account that is a member of the organization. This token is required by the solution to create pattern’s code repository in the organization and also to initialize it with an initial commit.
119
120
- Token permissions should have repo scope.
120
121
- Store the GitHub personal access token as a secret in plain text form in AWS Secrets Manager with the name `githubTokenSecretId`. It must NOT be encrypted using AWS KMS Customer Managed Key and should only be encrypted using the AWS managed key for Secrets Manager (`aws/secretsmanager`). User has the flexibility to provide a different name for the secret in AWS Secrets Manager, however, that would require setting `githubTokenSecretId` property in source/cdk.json. Please refer to the [Configuration section](#configuration) for details. Example AWS CLI command to create the secret:
Before you deploy the Reusable Application Pattern Manager on AWS solution, review the architecture and prerequisites sections in this guide. Follow the step-by-step instructions in this section to configure and deploy the solution into your account.
131
+
Before you deploy the Application Pattern Orchestrator on AWS solution, review the architecture and prerequisites sections in this guide. Follow the step-by-step instructions in this section to configure and deploy the solution into your account.
130
132
131
-
Time to deploy: Approximately 30 minutes
133
+
Time to deploy: Approximately 15 minutes
132
134
133
135
### Configuration
134
136
@@ -234,7 +236,7 @@ npm run deploy -- --parameters githubUrl=<GITHUB_ENTERPRISE_URL> --parameters gi
234
236
235
237
#### CDK deployment parameters
236
238
237
-
Below are all the parameters that can be passed to the `npm run deploy` command as specified in [Build and deploy section](#build-and-deploy)
239
+
You can pass the following parameters to the `npm run deploy` command as specified in [Build and deploy](#build-and-deploy) section.
@@ -272,8 +274,8 @@ Upon successfully cloning the repository into your local development environment
272
274
273
275
After the solution stack has been deployed and launched, you can sign in to the web interface.
274
276
275
-
1. Get the website URL from deployment output starting with `ApoStack.RapmFrontendCloudFrontURL` and open it in your browser. We recommend using Chrome. You will be redirected to the sign in page that requires username and password.
276
-
2. Sign in with the email address specified during deployment (`adminEmail`) and use the temporary password received via email after deployment. Note that the sender of the temporary password email is `[email protected]`.
277
+
1. Find the website URL from your deployment output starting with `ApoStack.RapmFrontendCloudFrontURL` and open it in your browser. We recommend using Chrome. You will be redirected to the sign in page that requires username and password.
278
+
2. Sign in with the email address specified during deployment (`adminEmail`) and use the temporary password received via email after deployment. You will receive a temporary password from `[email protected]`.
277
279
3. During the sign in, you are required to set a new password when signing in for the first time.
278
280
4. After signing in, you can view the solution's web UI.
279
281
@@ -285,23 +287,23 @@ You can unisntall the solution by deleting the stacks from the AWS CloudFormatio
285
287
286
288
- Go to the AWS CloudFormation console, find and delete the following stacks (in the specified order)
287
289
- All the stacks with the prefix `BlueprintInfrastructureStack`
288
-
- `ApoStack`
290
+
- The stack name you used to deploy the solution.
289
291
290
292
---
291
293
292
294
## Collection of operational metrics
293
295
294
-
This solution collects anonymous operational metrics to help AWS improve the quality and features of the solution. For more information, including how to disable this capability, please see the implementation guide.
296
+
This solution collects anonymous operational metrics to help AWS improve the quality and features of the solution. For more information, including how to disable this capability, refer to the [implementation guide](https://docs.aws.amazon.com/solutions/latest/application-pattern-orchestrator-on-aws/collection-of-operational-metrics.html).
Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
306
+
Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
305
307
306
308
Licensed under the Apache License Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at
0 commit comments