From 4792df9e789dd28ba0d45cae1833565e06753b3b Mon Sep 17 00:00:00 2001 From: Rian Bogle Date: Sat, 20 Feb 2021 09:58:51 -0700 Subject: [PATCH 1/2] AWS Fargate and Aurora MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- .github/styles/vocab.txt | 1 + docs/deployment/fargate.md | 21 +++++++++++++++++++++ docs/deployment/helm.md | 4 +--- microsite/sidebars.json | 3 ++- 4 files changed, 25 insertions(+), 4 deletions(-) create mode 100644 docs/deployment/fargate.md diff --git a/.github/styles/vocab.txt b/.github/styles/vocab.txt index 7d0f36d858..4f3377de92 100644 --- a/.github/styles/vocab.txt +++ b/.github/styles/vocab.txt @@ -21,6 +21,7 @@ Dockerize Docusaurus Env Expedia +Fargate Figma Firekube Fiverr diff --git a/docs/deployment/fargate.md b/docs/deployment/fargate.md new file mode 100644 index 0000000000..eff8a7d570 --- /dev/null +++ b/docs/deployment/fargate.md @@ -0,0 +1,21 @@ +--- +id: fargate +title: Deploying with AWS Fargate and Aurora +sidebar_label: AWS +description: How to deploy Backstage on AWS Fargate and Aurora +--- + +There are any number of ways to deploy backstage containers on AWS. One of the +simplest from a management and ops perspective is to leverage AWS Fargate and +Aurora PostgreSQL, where both the container orchestration and database clusters +are AWS managed services. + +However, to use them properly there are a large number of supporting resources +(VPCs, Security Groups, Load Balancers, Certificate, etc) required. One approach +is to use [AWS Cloud Development Kit (CDK)](https://aws.amazon.com/cdk/) to +simplify and automate the creation of the entire infrastructure stack along with +automating the build and deploy of the container. + +Check out the [Backstage On AWS](https://github.com/rbogle/backstage-on-aws) +repository, for a ready to use CDK application for deploying your custom +Backstage app onto AWS ECS Fargate and Aurora. diff --git a/docs/deployment/helm.md b/docs/deployment/helm.md index fd36aeb81f..cbfcb1bc57 100644 --- a/docs/deployment/helm.md +++ b/docs/deployment/helm.md @@ -1,12 +1,10 @@ --- id: helm -title: Deploying Backstage with Helm +title: Deploying with Helm description: How to deploy Backstage with Helm and Kubernetes sidebar_label: Helm --- -# Helm charts - An example Backstage app can be deployed in Kubernetes using the [Backstage Helm charts](https://github.com/backstage/backstage/tree/master/contrib/chart/backstage). diff --git a/microsite/sidebars.json b/microsite/sidebars.json index 1ab242ba2d..ab7e530479 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -206,7 +206,8 @@ "deployment/docker", "deployment/k8s", "deployment/helm", - "deployment/heroku" + "deployment/heroku", + "deployment/fargate" ], "Designing for Backstage": [ "dls/design", From 68f3e891b8947f91b5f3d101d60a915fad8691df Mon Sep 17 00:00:00 2001 From: Tim Hansen Date: Tue, 20 Apr 2021 14:36:19 -0600 Subject: [PATCH 2/2] Move Fargate doc to contrib Signed-off-by: Tim Hansen --- .../docs/tutorials/aws-fargate-deployment.md | 7 +------ docs/deployment/index.md | 4 +++- microsite/sidebars.json | 3 +-- 3 files changed, 5 insertions(+), 9 deletions(-) rename docs/deployment/fargate.md => contrib/docs/tutorials/aws-fargate-deployment.md (84%) diff --git a/docs/deployment/fargate.md b/contrib/docs/tutorials/aws-fargate-deployment.md similarity index 84% rename from docs/deployment/fargate.md rename to contrib/docs/tutorials/aws-fargate-deployment.md index eff8a7d570..bc530441c6 100644 --- a/docs/deployment/fargate.md +++ b/contrib/docs/tutorials/aws-fargate-deployment.md @@ -1,9 +1,4 @@ ---- -id: fargate -title: Deploying with AWS Fargate and Aurora -sidebar_label: AWS -description: How to deploy Backstage on AWS Fargate and Aurora ---- +# Deploying Backstage with AWS Fargate and Aurora There are any number of ways to deploy backstage containers on AWS. One of the simplest from a management and ops perspective is to leverage AWS Fargate and diff --git a/docs/deployment/index.md b/docs/deployment/index.md index db4ceca6f1..86ad03d1ae 100644 --- a/docs/deployment/index.md +++ b/docs/deployment/index.md @@ -30,7 +30,9 @@ There is also an example of deploying on [Heroku](heroku.md), which only requires the first two steps. An example of deploying Backstage with a [Helm chart](helm.md), a common pattern -in AWS, is also available. +in AWS, is also available. There is also a contrib guide to deploying Backstage +with +[AWS Fargate and Aurora PostgreSQL](https://github.com/backstage/backstage/blob/master/contrib/docs/tutorials/aws-fargate-deployment.md) Please consider contributing other deployment guides if you get Backstage set up on common infrastructure, it would be a great benefit to the community. diff --git a/microsite/sidebars.json b/microsite/sidebars.json index ab7e530479..1ab242ba2d 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -206,8 +206,7 @@ "deployment/docker", "deployment/k8s", "deployment/helm", - "deployment/heroku", - "deployment/fargate" + "deployment/heroku" ], "Designing for Backstage": [ "dls/design",