From 1c250188c79c0ce8023b8ba7882b90d7f37196ed Mon Sep 17 00:00:00 2001 From: Darshan Simha Date: Fri, 26 Jan 2024 14:51:04 -0500 Subject: [PATCH 1/6] fix: Updates the imports in frontend docs Signed-off-by: Darshan Simha --- .../software-templates/writing-custom-step-layouts.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/features/software-templates/writing-custom-step-layouts.md b/docs/features/software-templates/writing-custom-step-layouts.md index b965f60f6b..d3c7c8fe82 100644 --- a/docs/features/software-templates/writing-custom-step-layouts.md +++ b/docs/features/software-templates/writing-custom-step-layouts.md @@ -20,11 +20,11 @@ The [createScaffolderLayout](https://backstage.io/docs/reference/plugin-scaffold ```ts import React from 'react'; +import { scaffolderPlugin } from '@backstage/plugin-scaffolder'; import { createScaffolderLayout, LayoutTemplate, - scaffolderPlugin, -} from '@backstage/plugin-scaffolder'; +} from '@backstage/plugin-scaffolder-react'; import { Grid } from '@material-ui/core'; const TwoColumn: LayoutTemplate = ({ properties, description, title }) => { From 41c4fc9d415af4c95e3a88f6a4dcd3a1a7cd342b Mon Sep 17 00:00:00 2001 From: Darshan Simha Date: Fri, 2 Feb 2024 09:08:10 -0500 Subject: [PATCH 2/6] fix: critical fix to documentation for fixing the issue with k8's deployments Signed-off-by: Darshan Simha --- docs/deployment/k8s.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/deployment/k8s.md b/docs/deployment/k8s.md index b0218c8657..dee972f84d 100644 --- a/docs/deployment/k8s.md +++ b/docs/deployment/k8s.md @@ -397,6 +397,19 @@ backend: password: ${POSTGRES_PASSWORD} ``` +Please also change the host and port environment variables in the `app-config.production.yaml` to the following: + +```yaml +backend: + database: + client: pg + connection: + host: ${POSTGRES_SERVICE_HOST} + port: ${POSTGRES_SERVICE_PORT} + user: ${POSTGRES_USER} + password: ${POSTGRES_PASSWORD} +``` + Make sure to rebuild the Docker image after applying `app-config.yaml` changes. Apply this Deployment to the Kubernetes cluster: From 1e52ba229ef4df694a0f77df5b8882f3a7873452 Mon Sep 17 00:00:00 2001 From: Darshan Simha Date: Fri, 2 Feb 2024 09:17:47 -0500 Subject: [PATCH 3/6] fix: removed changes from another branch Signed-off-by: Darshan Simha --- .../software-templates/writing-custom-step-layouts.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/features/software-templates/writing-custom-step-layouts.md b/docs/features/software-templates/writing-custom-step-layouts.md index d3c7c8fe82..b965f60f6b 100644 --- a/docs/features/software-templates/writing-custom-step-layouts.md +++ b/docs/features/software-templates/writing-custom-step-layouts.md @@ -20,11 +20,11 @@ The [createScaffolderLayout](https://backstage.io/docs/reference/plugin-scaffold ```ts import React from 'react'; -import { scaffolderPlugin } from '@backstage/plugin-scaffolder'; import { createScaffolderLayout, LayoutTemplate, -} from '@backstage/plugin-scaffolder-react'; + scaffolderPlugin, +} from '@backstage/plugin-scaffolder'; import { Grid } from '@material-ui/core'; const TwoColumn: LayoutTemplate = ({ properties, description, title }) => { From 662fd66dd8878ba2c1f5abe8609ff7ee7a6c08f4 Mon Sep 17 00:00:00 2001 From: Darshan Simha Date: Sun, 4 Feb 2024 20:21:46 -0500 Subject: [PATCH 4/6] fix: updated the message based on comments Signed-off-by: Darshan Simha --- docs/deployment/k8s.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deployment/k8s.md b/docs/deployment/k8s.md index dee972f84d..e7fd025026 100644 --- a/docs/deployment/k8s.md +++ b/docs/deployment/k8s.md @@ -384,7 +384,7 @@ $ yarn build-image --tag backstage:1.0.0 There is no special wiring needed to access the PostgreSQL service. Since it's running on the same cluster, Kubernetes will inject `POSTGRES_SERVICE_HOST` and `POSTGRES_SERVICE_PORT` environment variables into our Backstage container. -These can be used in the Backstage `app-config.yaml` along with the secrets: +These can be used in the Backstage `app-config.yaml` along with the secrets. Apply this to app-config.production.yaml as well if you have one: ```yaml backend: From 45996b83451b6134d73a19ee64a0444ef67bfbdc Mon Sep 17 00:00:00 2001 From: Darshan Simha Date: Thu, 8 Feb 2024 13:02:30 -0500 Subject: [PATCH 5/6] fix: updated based on review comment Signed-off-by: Darshan Simha --- docs/deployment/k8s.md | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/docs/deployment/k8s.md b/docs/deployment/k8s.md index e7fd025026..4596608caf 100644 --- a/docs/deployment/k8s.md +++ b/docs/deployment/k8s.md @@ -399,17 +399,6 @@ backend: Please also change the host and port environment variables in the `app-config.production.yaml` to the following: -```yaml -backend: - database: - client: pg - connection: - host: ${POSTGRES_SERVICE_HOST} - port: ${POSTGRES_SERVICE_PORT} - user: ${POSTGRES_USER} - password: ${POSTGRES_PASSWORD} -``` - Make sure to rebuild the Docker image after applying `app-config.yaml` changes. Apply this Deployment to the Kubernetes cluster: From 12b1d5eacc7ee55379e58d4b2435491dbc84900a Mon Sep 17 00:00:00 2001 From: Darshan Simha Date: Thu, 8 Feb 2024 14:14:54 -0500 Subject: [PATCH 6/6] fix: pr comments Signed-off-by: Darshan Simha --- docs/deployment/k8s.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/deployment/k8s.md b/docs/deployment/k8s.md index 4596608caf..3dd2b8227e 100644 --- a/docs/deployment/k8s.md +++ b/docs/deployment/k8s.md @@ -397,8 +397,6 @@ backend: password: ${POSTGRES_PASSWORD} ``` -Please also change the host and port environment variables in the `app-config.production.yaml` to the following: - Make sure to rebuild the Docker image after applying `app-config.yaml` changes. Apply this Deployment to the Kubernetes cluster: