From 9f9a1182c7a55df689444f46129116f2734de34c Mon Sep 17 00:00:00 2001 From: alisdairbr Date: Mon, 12 Jun 2023 15:47:29 +0200 Subject: [PATCH 1/4] Add Koyeb deployment doc Signed-off-by: alisdairbr --- docs/deployment/koyeb.md | 48 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 docs/deployment/koyeb.md diff --git a/docs/deployment/koyeb.md b/docs/deployment/koyeb.md new file mode 100644 index 0000000000..e656dde267 --- /dev/null +++ b/docs/deployment/koyeb.md @@ -0,0 +1,48 @@ +--- +id: koyeb +title: Deploying with Koyeb +sidebar_label: Koyeb +description: How to deploy Backstage to Koyeb +--- + +This guide explains how to deploy Backstage to [Koyeb](https://www.koyeb.com/), a serverless platform that provides the fastest way to deploy applications globally. Koyeb supports git-driven and container-based deployments. + +Before you begin, make sure you have a [Koyeb account](https://app.koyeb.com/) to follow this guide. + +## Configuring the CLI + +First, install the +[Koyeb CLI](https://www.koyeb.com/docs/quickstart/koyeb-cli) and follow the instructions in the [quickstart guide](https://www.koyeb.com/docs/quickstart/koyeb-cli) to login. + +Then, configure your `app-config.yaml` with your `baseURL`: + +```yaml +app: + # Should be the same as backend.baseUrl when using the `app-backend` plugin + baseUrl: https://.koyeb.app + +backend: + baseUrl: https://.koyeb.app + listen: + port: + $env: PORT + # The $PORT environment variable is a feature of Koyeb + # https://www.koyeb.com/docs/apps/services +``` + +## Push and deploy Backstage to Koyeb + +Push your Backstage application with its [Dockerfile](docker.md) to Koyeb using the following command: + +```bash +koyeb app init example-backstage \ + --git github.com// \ + --git-branch main \ + --ports 8000:http \ + --routes /:8000 \ + --env PORT=8000 +``` + +Your application will be built and deployed to Koyeb. Once the build has finished, you will be able to access your application running on Koyeb by clicking the URL ending with `.koyeb.app`. + +Congratulations! Now you should have Backstage up and running! ๐ŸŽ‰ From ac166f0c03bc05dc5b7bcf97974d75a75d9df0c4 Mon Sep 17 00:00:00 2001 From: alisdairbr Date: Mon, 12 Jun 2023 17:42:50 +0200 Subject: [PATCH 2/4] Add signoff Signed-off-by: alisdairbr --- docs/deployment/koyeb.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/deployment/koyeb.md b/docs/deployment/koyeb.md index e656dde267..91e0be1d8f 100644 --- a/docs/deployment/koyeb.md +++ b/docs/deployment/koyeb.md @@ -46,3 +46,5 @@ koyeb app init example-backstage \ Your application will be built and deployed to Koyeb. Once the build has finished, you will be able to access your application running on Koyeb by clicking the URL ending with `.koyeb.app`. Congratulations! Now you should have Backstage up and running! ๐ŸŽ‰ + + From 3af9c83c13087a33b6f2ba32011e2f2006f678e5 Mon Sep 17 00:00:00 2001 From: alisdairbr Date: Tue, 13 Jun 2023 20:46:48 +0200 Subject: [PATCH 3/4] Incorporate freben feedback Signed-off-by: alisdairbr --- .../.github/vale/Vocab/Backstage/accept.txt | 1 + docs/deployment/koyeb.md | 5 +-- microsite/sidebars.json | 41 ++++++++++++++----- mkdocs.yml | 1 + 4 files changed, 35 insertions(+), 13 deletions(-) create mode 100644 docs/deployment/.github/vale/Vocab/Backstage/accept.txt diff --git a/docs/deployment/.github/vale/Vocab/Backstage/accept.txt b/docs/deployment/.github/vale/Vocab/Backstage/accept.txt new file mode 100644 index 0000000000..f67e55fd94 --- /dev/null +++ b/docs/deployment/.github/vale/Vocab/Backstage/accept.txt @@ -0,0 +1 @@ +Koyeb diff --git a/docs/deployment/koyeb.md b/docs/deployment/koyeb.md index 91e0be1d8f..2d5bd7b375 100644 --- a/docs/deployment/koyeb.md +++ b/docs/deployment/koyeb.md @@ -14,7 +14,7 @@ Before you begin, make sure you have a [Koyeb account](https://app.koyeb.com/) t First, install the [Koyeb CLI](https://www.koyeb.com/docs/quickstart/koyeb-cli) and follow the instructions in the [quickstart guide](https://www.koyeb.com/docs/quickstart/koyeb-cli) to login. -Then, configure your `app-config.yaml` with your `baseURL`: +Then, configure your `app-config.yaml` with your `baseUrl`: ```yaml app: @@ -24,8 +24,7 @@ app: backend: baseUrl: https://.koyeb.app listen: - port: - $env: PORT + port: ${PORT] # The $PORT environment variable is a feature of Koyeb # https://www.koyeb.com/docs/apps/services ``` diff --git a/microsite/sidebars.json b/microsite/sidebars.json index ec0f443ed5..5f55e19836 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -185,7 +185,9 @@ { "type": "category", "label": "Datadog", - "items": ["integrations/datadog-rum/installation"] + "items": [ + "integrations/datadog-rum/installation" + ] }, { "type": "category", @@ -217,17 +219,23 @@ { "type": "category", "label": "Gitea", - "items": ["integrations/gitea/locations"] + "items": [ + "integrations/gitea/locations" + ] }, { "type": "category", "label": "Google GCS", - "items": ["integrations/google-cloud-storage/locations"] + "items": [ + "integrations/google-cloud-storage/locations" + ] }, { "type": "category", "label": "LDAP", - "items": ["integrations/ldap/org"] + "items": [ + "integrations/ldap/org" + ] } ], "Plugins": [ @@ -255,7 +263,9 @@ { "type": "category", "label": "Testing", - "items": ["plugins/testing"] + "items": [ + "plugins/testing" + ] }, { "type": "category", @@ -328,6 +338,7 @@ "deployment/docker", "deployment/k8s", "deployment/heroku", + "deployment/koyeb", { "type": "category", "label": "Using Backstage Deploy (alpha)", @@ -344,12 +355,16 @@ { "type": "category", "label": "Guides", - "items": ["api/utility-apis"] + "items": [ + "api/utility-apis" + ] }, { "type": "category", "label": "API Reference", - "items": ["reference/index"] + "items": [ + "reference/index" + ] }, "api/deprecations" ], @@ -380,7 +395,9 @@ "architecture-decisions/adrs-adr012", "architecture-decisions/adrs-adr013" ], - "FAQ": ["FAQ"], + "FAQ": [ + "FAQ" + ], "Experimental Backend System": [ "backend-system/index", { @@ -415,9 +432,13 @@ { "type": "category", "label": "Core Services", - "items": ["backend-system/core-services/index"] + "items": [ + "backend-system/core-services/index" + ] } ], - "Accessibility": ["accessibility/index"] + "Accessibility": [ + "accessibility/index" + ] } } diff --git a/mkdocs.yml b/mkdocs.yml index 5544053263..23d519f66e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -175,6 +175,7 @@ nav: - Docker: 'deployment/docker.md' - Kubernetes: 'deployment/k8s.md' - Heroku: 'deployment/heroku.md' + - Koyeb: 'deployment/koyeb.md' - Designing for Backstage: - Design: 'dls/design.md' - Component Design Guidelines: 'dls/component-design-guidelines.md' From eee075360675fd9f7ad0748c1cd03c817cc063e3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Thu, 15 Jun 2023 13:26:55 +0200 Subject: [PATCH 4/4] fixup MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelรถw --- .github/vale/Vocab/Backstage/accept.txt | 1 + .../.github/vale/Vocab/Backstage/accept.txt | 1 - docs/deployment/koyeb.md | 8 ++-- microsite/sidebars.json | 40 +++++-------------- 4 files changed, 14 insertions(+), 36 deletions(-) delete mode 100644 docs/deployment/.github/vale/Vocab/Backstage/accept.txt diff --git a/.github/vale/Vocab/Backstage/accept.txt b/.github/vale/Vocab/Backstage/accept.txt index 2c50b55219..554c464259 100644 --- a/.github/vale/Vocab/Backstage/accept.txt +++ b/.github/vale/Vocab/Backstage/accept.txt @@ -178,6 +178,7 @@ Kaewkasi Kaswell Keyv Knex +Koyeb KPIs Kuang kubectl diff --git a/docs/deployment/.github/vale/Vocab/Backstage/accept.txt b/docs/deployment/.github/vale/Vocab/Backstage/accept.txt deleted file mode 100644 index f67e55fd94..0000000000 --- a/docs/deployment/.github/vale/Vocab/Backstage/accept.txt +++ /dev/null @@ -1 +0,0 @@ -Koyeb diff --git a/docs/deployment/koyeb.md b/docs/deployment/koyeb.md index 2d5bd7b375..9ff87350be 100644 --- a/docs/deployment/koyeb.md +++ b/docs/deployment/koyeb.md @@ -24,9 +24,9 @@ app: backend: baseUrl: https://.koyeb.app listen: + # The $PORT environment variable is a feature of Koyeb + # https://www.koyeb.com/docs/apps/services port: ${PORT] - # The $PORT environment variable is a feature of Koyeb - # https://www.koyeb.com/docs/apps/services ``` ## Push and deploy Backstage to Koyeb @@ -42,8 +42,6 @@ koyeb app init example-backstage \ --env PORT=8000 ``` -Your application will be built and deployed to Koyeb. Once the build has finished, you will be able to access your application running on Koyeb by clicking the URL ending with `.koyeb.app`. +Your application will be built and deployed to Koyeb. Once the build has finished, you will be able to access your application running on Koyeb by clicking the URL ending with `.koyeb.app`. Congratulations! Now you should have Backstage up and running! ๐ŸŽ‰ - - diff --git a/microsite/sidebars.json b/microsite/sidebars.json index 5f55e19836..ab7036e97d 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -185,9 +185,7 @@ { "type": "category", "label": "Datadog", - "items": [ - "integrations/datadog-rum/installation" - ] + "items": ["integrations/datadog-rum/installation"] }, { "type": "category", @@ -219,23 +217,17 @@ { "type": "category", "label": "Gitea", - "items": [ - "integrations/gitea/locations" - ] + "items": ["integrations/gitea/locations"] }, { "type": "category", "label": "Google GCS", - "items": [ - "integrations/google-cloud-storage/locations" - ] + "items": ["integrations/google-cloud-storage/locations"] }, { "type": "category", "label": "LDAP", - "items": [ - "integrations/ldap/org" - ] + "items": ["integrations/ldap/org"] } ], "Plugins": [ @@ -263,9 +255,7 @@ { "type": "category", "label": "Testing", - "items": [ - "plugins/testing" - ] + "items": ["plugins/testing"] }, { "type": "category", @@ -355,16 +345,12 @@ { "type": "category", "label": "Guides", - "items": [ - "api/utility-apis" - ] + "items": ["api/utility-apis"] }, { "type": "category", "label": "API Reference", - "items": [ - "reference/index" - ] + "items": ["reference/index"] }, "api/deprecations" ], @@ -395,9 +381,7 @@ "architecture-decisions/adrs-adr012", "architecture-decisions/adrs-adr013" ], - "FAQ": [ - "FAQ" - ], + "FAQ": ["FAQ"], "Experimental Backend System": [ "backend-system/index", { @@ -432,13 +416,9 @@ { "type": "category", "label": "Core Services", - "items": [ - "backend-system/core-services/index" - ] + "items": ["backend-system/core-services/index"] } ], - "Accessibility": [ - "accessibility/index" - ] + "Accessibility": ["accessibility/index"] } }