From bce96a79cac66ecc4cca6990822a041b4d3fb749 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Thu, 9 Jun 2022 11:34:02 +0200 Subject: [PATCH 1/3] docs: Remove helm from microsite Signed-off-by: Johan Haals --- microsite/sidebars.json | 1 - mkdocs.yml | 1 - 2 files changed, 2 deletions(-) diff --git a/microsite/sidebars.json b/microsite/sidebars.json index 6f3359f708..6cbe079def 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -288,7 +288,6 @@ "deployment/index", "deployment/docker", "deployment/k8s", - "deployment/helm", "deployment/heroku" ], "Designing for Backstage": [ diff --git a/mkdocs.yml b/mkdocs.yml index 7200471326..3bd83832f7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -167,7 +167,6 @@ nav: - Deploying Backstage: 'deployment/index.md' - Docker: 'deployment/docker.md' - Kubernetes: 'deployment/k8s.md' - - Helm: 'deployment/helm.md' - Heroku: 'deployment/heroku.md' - Designing for Backstage: - Design: 'dls/design.md' From 0d834f259e64732efb0cb40bf66f0b089b6b0980 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Thu, 9 Jun 2022 11:34:18 +0200 Subject: [PATCH 2/3] Remove helm docs Signed-off-by: Johan Haals --- docs/deployment/helm.md | 62 ----------------------------------------- 1 file changed, 62 deletions(-) delete mode 100644 docs/deployment/helm.md diff --git a/docs/deployment/helm.md b/docs/deployment/helm.md deleted file mode 100644 index cbfcb1bc57..0000000000 --- a/docs/deployment/helm.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: helm -title: Deploying with Helm -description: How to deploy Backstage with Helm and Kubernetes -sidebar_label: Helm ---- - -An example Backstage app can be deployed in Kubernetes using the -[Backstage Helm charts](https://github.com/backstage/backstage/tree/master/contrib/chart/backstage). - -First, choose a DNS name where Backstage will be hosted, and create a YAML file -for your custom configuration. - -```yaml -appConfig: - app: - baseUrl: https://backstage.mydomain.com - title: Backstage - backend: - baseUrl: https://backstage.mydomain.com - cors: - origin: https://backstage.mydomain.com - lighthouse: - baseUrl: https://backstage.mydomain.com/lighthouse-api - techdocs: - storageUrl: https://backstage.mydomain.com/api/techdocs/static/docs - requestUrl: https://backstage.mydomain.com/api/techdocs -``` - -Then use it to run: - -```bash -git clone https://github.com/backstage/backstage.git -cd backstage/contrib/chart/backstage -helm dependency update -helm install -f backstage-mydomain.yaml backstage . -``` - -This command will deploy the following pieces: - -- Backstage frontend -- Backstage backend with scaffolder and auth plugins -- (optional) a PostgreSQL instance -- lighthouse plugin -- ingress - -After a few minutes Backstage should be up and running in your cluster under the -DNS specified earlier. - -Make sure to create the appropriate DNS entry in your infrastructure. To find -the public IP address run: - -```bash -$ kubectl get ingress -NAME HOSTS ADDRESS PORTS AGE -backstage-ingress * 123.1.2.3 80 17m -``` - -> **NOTE**: this is not a production ready deployment. - -For more information on how to customize the deployment check the -[README](https://github.com/backstage/backstage/tree/master/contrib/chart/backstage/README.md). From 3ae9c3efb03168c3ef5ebf48910f0cc64d3e1c16 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Thu, 9 Jun 2022 11:36:58 +0200 Subject: [PATCH 3/3] remove helm from deployment index Signed-off-by: Johan Haals --- docs/deployment/index.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/deployment/index.md b/docs/deployment/index.md index 621870ea6f..da2c29ba23 100644 --- a/docs/deployment/index.md +++ b/docs/deployment/index.md @@ -29,9 +29,7 @@ This method is covered in [Building a Docker image](docker.md) and 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. There is also a contrib guide to deploying Backstage -with +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