App Development for Backstage.io on AWS provides a new developer experience to simplify the use and consumption of AWS services while minimizing required expertise in cloud infrastructure technologies. Built on the Backstage open platform, this solution makes the AWS cloud more accessible to Application Developers allowing them to focus on building application logic and delivering business value.
The solution is composed of two parts:
- AWS Infrastructure to provide the build, deployment, and security requirements in the AWS cloud
- Backstage plugins to support AWS application development and management.
This solution leverages the flexibility and extensibility of the Backstage platform to provide customizable software templates, scaffolder actions, and boilerplate deployment configurations. While this provides a lot of freedom in implementation, it can be overwhelming to get started. To help users get started, a reference repository is also provided with samples to show how to use the solution.
🎬 Demonstrations and Tutorials
For more information about the solution and its functionality,
check out the demonstration and tutorial videos on our YouTube playlist.
- Architecture overview
- Installation instructions
- FAQs
See ARCHITECTURE.md for details about the solution architecture
The installation instructions documented here were tested using the following versions:
- Backstage v1.10.1
- node v18.12
- npm 8.19
- cdk v2.59
After cloning this repository, change directory to the repository location and perform the following steps to deploy the complete solution:
- Install and configure Backstage and plugins
- Deploy Infrastructure
- Deploy and configure infrastructure prerequisites
- Build and deploy the Backstage image
- Deploy and configure the infrastructure solution
A makefile target will automatically install the Backstage application and plugins used in the solution. The target will also copy over modifications to the base Backstage files to simplify the configuration for each of the plugins.
make backstage-installNote: Later releases of Backstage may modify the base versions of these files and the overwrite action may wipe out intended Backstage changes. If you would prefer to perform manual customization of Backstage to understand the modifications to the Backstage application, you can follow the manual instructions in the PLUGIN_INSTALL.md file.
See the Infrastructure README.md for details about deploying the infrastructure stacks, building and deploying the Backstage image, and configuring the infrastructure solution.
Q. I don't use Okta. Can i change the identity provider to another one?
A. Yes, Backstage supports many IDPs, once you configure backstage to your chosen IDP make sure backstage catalog is synced with the users and groups from your IDP. don't forget to update the security role mapping to match the groups in your IDP to the AWS environment roles.
Q. I want to use another source control that is not GitLabs. how can i do it?
A. Backstage support different source control which can be integrated through backstage config. we use Gitlab for several usage which will need to migrate to another source control provider:
- Storing application source code
- Storing template source code
- Storing catalog information - AWS Environment and AWS Environment providers
- Executing pipelines that are responsible to build the application when new code is pushed and push the updated image to ECR.
Q. I'm using Terraform, can i use this solution with terraform to provision application resources?
A. Yes, the step function which is responsible to provision resource for a given Environment can also execute terraform modules. Since it's using AWS CodeBuild behind the scene you can introduce your own software for provisioning resources but also enjoy some of the built-in implementation like passing Environment variables in and out of the step function.
See CONTRIBUTING for more information.
This project is licensed under the Apache-2.0 License.