UPD: setup techdocs and monitoring (#80)

* ADD: prod configurations

* ADD: migrate scaffolder plugin for github

* UPD: update database config

* UPD: techdocs config

* UPD: techdocs config

* UPD: fix errors

* UPD: fix errors

Author: NewerKey

.github/workflows/cd-workflow.yaml

@@ -99,6 +99,7 @@ jobs:
         with: 
           project_id: ${{ secrets.GCP_PROJECT_ID }}
 
+
       - name: Deploy to Cloud Run
         id: deploy
         uses: google-github-actions/deploy-cloudrun@v1
@@ -110,3 +111,8 @@ jobs:
           flags: >
             --allow-unauthenticated
             --port=7007
+            --add-cloudsql-instances=${{ secrets.GCP_SQL_CONNECTION_NAME }}
+          env_vars: |
+            POSTGRES_HOST=${{ secrets.POSTGRES_HOST }}
+            POSTGRES_PORT=5432
+            BASE_URL=https://backstage.foundations-software-engineering.com

.github/workflows/techdocs-gcs.yml

@@ -0,0 +1,58 @@
+name: Build and Publish TechDocs to GCS
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+
+jobs:
+  publish-techdocs-site:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: ['20.x']
+    
+    env: 
+        TECHDOCS_BUCKET_NAME: ${{ secrets.TECHDOCS_BUCKET_NAME }}
+        TECHDOCS_GCS_CREDENTIALS: ${{ secrets.TECHDOCS_GCS_CREDENTIALS }}
+        ENTITY_NAMESPACE: 'default'
+        ENTITY_KIND: 'Component'
+        ENTITY_NAME: 'code-idp-docs'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Set Yarn Version
+        run: corepack prepare [email protected] --activate
+      
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'yarn'
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+           python-version: '3.9'
+
+      - name: Install techdocs-cli
+        run: yarn global add @techdocs/cli
+
+      - name: Install mkdocs and mkdocs-plugin
+        run: python3 -m pip install mkdocs-techdocs-core==1.*
+    
+      - name: Generate docs site
+        run: techdocs-cli generate --no-docker --verbose
+
+      - name: Publish docs site
+        run: techdocs-cli publish --publisher-type googleGcs --storage-name $TECHDOCS_BUCKET_NAME --entity $ENTITY_NAMESPACE/$ENTITY_KIND/$ENTITY_NAME

app-config.production.yaml

@@ -1,10 +1,10 @@
 app:
-  baseUrl: https://backstage-deployment-1006240973223.europe-west10.run.app
+  baseUrl: https://backstage.foundations-software-engineering.com
 
 backend:
-  baseUrl: https://backstage-deployment-1006240973223.europe-west10.run.app
+  baseUrl: https://backstage.foundations-software-engineering.com
   cors:
-    origin: https://backstage-deployment-1006240973223.europe-west10.run.app
+    origin: https://backstage.foundations-software-engineering.com
     methods: [GET, HEAD, PATCH, POST, PUT, DELETE]
     credentials: true
 

app-config.yaml

@@ -15,6 +15,7 @@ backend:
     origin: http://localhost:3000
     methods: [GET, HEAD, PATCH, POST, PUT, DELETE]
     credentials: true
+
   database:
     client: pg
     connection:
@@ -34,8 +35,11 @@ integrations:
     - host: gitlab.com
       token: ${GITLAB_TOKEN}
 
+
 techdocs:
-  builder: 'external' 
+  builder: 'external'
+  generator:
+    runIn: 'local'
   publisher:
     type: 'googleGcs'
     googleGcs:

docs/CHANGELOG.md

@@ -8,6 +8,7 @@ nav:
     - Register Your Software Component: 'how-to-register-a-component.md'
   - Technical Documentation: 
     - Publish Your Docs: 'how-to-publish-documentation.md'
+  - CHANGELOG: 'CHANGELOG.md'
 
 plugins: 
   - techdocs-core

mkdocs.yml

@@ -36,6 +36,8 @@
     "@backstage/plugin-permission-node": "^0.8.5",
     "@backstage/plugin-proxy-backend": "^0.5.8",
     "@backstage/plugin-scaffolder-backend": "^1.27.2",
+    "@backstage/plugin-scaffolder-backend-module-github": "^0.5.5",
+    "@backstage/plugin-scaffolder-backend-module-gitlab": "^0.7.1",
     "@backstage/plugin-search-backend": "^1.7.0",
     "@backstage/plugin-search-backend-module-catalog": "^0.2.5",
     "@backstage/plugin-search-backend-module-pg": "^0.5.38",
@@ -47,7 +49,7 @@
     "express": "^4.17.1",
     "express-promise-router": "^4.1.0",
     "node-gyp": "^9.0.0",
-    "pg": "^8.11.3"
+    "pg": "^8.13.1"
   },
   "devDependencies": {
     "@backstage/cli": "^0.29.0",

packages/backend/package.json

@@ -11,7 +11,6 @@ const backend = createBackend();
 
 backend.add(import('@backstage/plugin-app-backend'));
 backend.add(import('@backstage/plugin-proxy-backend'))
-backend.add(import('@backstage/plugin-scaffolder-backend'));
 backend.add(import('@backstage/plugin-techdocs-backend'));
 
 // Add the auth backend
@@ -117,6 +116,11 @@ backend.add(import('@backstage/plugin-catalog-backend'));
 backend.add(import('@backstage/plugin-catalog-backend-module-scaffolder-entity-model'),
 );
 
+// scaffolder plugin
+backend.add(import('@backstage/plugin-scaffolder-backend'));
+backend.add(import('@backstage/plugin-scaffolder-backend-module-github'));
+backend.add(import('@backstage/plugin-scaffolder-backend-module-gitlab'));
+
 backend.add(import('@backstage/plugin-permission-backend'));
 backend.add(
     import('@backstage/plugin-permission-backend-module-allow-all-policy'),

packages/backend/src/index.ts

@@ -15420,6 +15420,8 @@ __metadata:
     "@backstage/plugin-permission-node": "npm:^0.8.5"
     "@backstage/plugin-proxy-backend": "npm:^0.5.8"
     "@backstage/plugin-scaffolder-backend": "npm:^1.27.2"
+    "@backstage/plugin-scaffolder-backend-module-github": "npm:^0.5.5"
+    "@backstage/plugin-scaffolder-backend-module-gitlab": "npm:^0.7.1"
     "@backstage/plugin-search-backend": "npm:^1.7.0"
     "@backstage/plugin-search-backend-module-catalog": "npm:^0.2.5"
     "@backstage/plugin-search-backend-module-pg": "npm:^0.5.38"
@@ -15436,7 +15438,7 @@ __metadata:
     express: "npm:^4.17.1"
     express-promise-router: "npm:^4.1.0"
     node-gyp: "npm:^9.0.0"
-    pg: "npm:^8.11.3"
+    pg: "npm:^8.13.1"
   languageName: unknown
   linkType: soft
 
@@ -28602,7 +28604,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"pg@npm:^8.11.3":
+"pg@npm:^8.11.3, pg@npm:^8.13.1":
   version: 8.13.1
   resolution: "pg@npm:8.13.1"
   dependencies: