Merge pull request #15357 from backstage/blam/mock-data-plz

build uffizzi preview with `example-backend` and `example-frontend`
2022-12-22 16:16:11 +01:00
parent 60d6ea3947 71a0dee0b8
commit f95ed2db91
4 changed files with 272 additions and 21 deletions
@@ -8,11 +8,11 @@ x-uffizzi:
 services:
  backstage:
    image: '${BACKSTAGE_IMAGE}'
+
    environment:
-      POSTGRES_HOST: localhost
+      POSTGRES_HOST: db
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: example
-      GITHUB_TOKEN: abc
      NODE_ENV: production
    deploy:
      resources:
@@ -21,7 +21,7 @@ services:
    entrypoint: '/bin/sh'
    command:
      - '-c'
-      - "APP_CONFIG_app_baseUrl=$$UFFIZZI_URL APP_CONFIG_backend_baseUrl=$$UFFIZZI_URL APP_CONFIG_auth_environment='production' node packages/backend --config app-config.yaml --config app-config.production.yaml"
+      - "APP_CONFIG_app_baseUrl=$$UFFIZZI_URL APP_CONFIG_backend_baseUrl=$$UFFIZZI_URL APP_CONFIG_auth_environment='production' node packages/backend --config app-config.yaml"

  db:
    image: postgres
@@ -2,9 +2,258 @@ app:
  title: Backstage Uffizzi Environment
  baseUrl: ${UFFIZZI_URL}

+organization:
+  name: My Company
+
 backend:
  baseUrl: ${UFFIZZI_URL}
+  auth:
+    keys:
+      # random mock key for uffizi deployments
+      - secret: 5TXvdjVZFxF7qf9K5RAYRDoGrLzJooqa
+  listen:
+    port: 7007
+  database:
+    client: better-sqlite3
+    connection: ':memory:'
+  cache:
+    store: memory
  cors:
    origin: ${UFFIZZI_URL}
-    methods: [GET, POST, PUT, DELETE]
+    methods: [GET, HEAD, PATCH, POST, PUT, DELETE]
    credentials: true
+  csp:
+    connect-src: ["'self'", 'http:', 'https:']
+    # Content-Security-Policy directives follow the Helmet format: https://helmetjs.github.io/#reference
+    # Default Helmet Content-Security-Policy values can be removed by setting the key to false
+
+auth:
+  environment: production
+  providers: {}
+
+catalog:
+  locations:
+    - type: url
+      target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all.yaml
+
+proxy:
+  '/circleci/api':
+    target: https://circleci.com/api/v1.1
+    headers:
+      Circle-Token: ${CIRCLECI_AUTH_TOKEN}
+
+  '/jenkins/api':
+    target: http://localhost:8080
+    headers:
+      Authorization: ${JENKINS_BASIC_AUTH_HEADER}
+
+  '/travisci/api':
+    target: https://api.travis-ci.com
+    changeOrigin: true
+    headers:
+      Authorization: ${TRAVISCI_AUTH_TOKEN}
+      travis-api-version: '3'
+
+  '/newrelic/apm/api':
+    target: https://api.newrelic.com/v2
+    headers:
+      X-Api-Key: ${NEW_RELIC_REST_API_KEY}
+
+  '/newrelic/api':
+    target: https://api.newrelic.com
+    headers:
+      X-Api-Key: ${NEW_RELIC_USER_KEY}
+
+  '/pagerduty':
+    target: https://api.pagerduty.com
+    headers:
+      Authorization: Token token=${PAGERDUTY_TOKEN}
+
+  '/buildkite/api':
+    target: https://api.buildkite.com/v2/
+    headers:
+      Authorization: ${BUILDKITE_TOKEN}
+
+  '/sentry/api':
+    target: https://sentry.io/api/
+    allowedMethods: ['GET']
+    headers:
+      Authorization: ${SENTRY_TOKEN}
+
+  '/ilert':
+    target: https://api.ilert.com
+    allowedMethods: ['GET', 'POST', 'PUT']
+    allowedHeaders: ['Authorization']
+    headers:
+      Authorization: ${ILERT_AUTH_HEADER}
+
+  '/airflow':
+    target: https://your.airflow.instance.com/api/v1
+    headers:
+      Authorization: ${AIRFLOW_BASIC_AUTH_HEADER}
+
+  '/gocd':
+    target: https://your.gocd.instance.com/go/api
+    allowedMethods: ['GET']
+    allowedHeaders: ['Authorization']
+    headers:
+      Authorization: Basic ${GOCD_AUTH_CREDENTIALS}
+
+  '/dynatrace':
+    target: https://your.dynatrace.instance.com/api/v2
+    headers:
+      Authorization: 'Api-Token ${DYNATRACE_ACCESS_TOKEN}'
+
+techdocs:
+  builder: 'local' # Alternatives - 'external'
+  generator:
+    runIn: 'docker'
+    # dockerImage: my-org/techdocs # use a custom docker image
+    # pullImage: true # or false to disable automatic pulling of image (e.g. if custom docker login is required)
+  publisher:
+    type: 'local' # Alternatives - 'googleGcs' or 'awsS3' or 'azureBlobStorage' or 'openStackSwift'. Read documentation for using alternatives.
+
+dynatrace:
+  baseUrl: https://your.dynatrace.instance.com
+
+# Score-cards sample configuration.
+scorecards:
+  jsonDataUrl: https://raw.githubusercontent.com/Oriflame/backstage-plugins/main/plugins/score-card/sample-data/
+  wikiLinkTemplate: https://link-to-wiki/{id}
+
+sentry:
+  organization: my-company
+
+rollbar:
+  organization: my-company
+  # NOTE: The rollbar-backend & accountToken key may be deprecated in the future (replaced by a proxy config)
+  accountToken: my-rollbar-account-token
+
+lighthouse:
+  baseUrl: http://localhost:3003
+
+kubernetes:
+  serviceLocatorMethod:
+    type: 'multiTenant'
+  clusterLocatorMethods:
+    - type: 'config'
+      clusters: []
+
+kafka:
+  clientId: backstage
+  clusters:
+    - name: cluster
+      dashboardUrl: https://akhq.io/
+      brokers:
+        - localhost:9092
+
+allure:
+  baseUrl: http://localhost:5050/allure-docker-service
+
+integrations:
+  github:
+    - host: github.com
+      token: ${GITHUB_TOKEN}
+  ### Example for how to add your GitHub Enterprise instance using the API:
+  # - host: ghe.example.net
+  #   apiBaseUrl: https://ghe.example.net/api/v3
+  #   token: ${GHE_TOKEN}
+  ### Example for how to add your GitHub Enterprise instance using raw HTTP fetches (token is optional):
+  # - host: ghe.example.net
+  #   rawBaseUrl: https://ghe.example.net/raw
+  #   token: ${GHE_TOKEN}
+  gitlab:
+    - host: gitlab.com
+      token: ${GITLAB_TOKEN}
+  ### Example for how to add a bitbucket cloud integration
+  # bitbucketCloud:
+  #   - username: ${BITBUCKET_USERNAME}
+  #     appPassword: ${BITBUCKET_APP_PASSWORD}
+  ### Example for how to add your bitbucket server instance using the API:
+  # - host: server.bitbucket.com
+  #   apiBaseUrl: server.bitbucket.com
+  #   username: ${BITBUCKET_SERVER_USERNAME}
+  #   appPassword: ${BITBUCKET_SERVER_APP_PASSWORD}
+  azure:
+    - host: dev.azure.com
+      token: ${AZURE_TOKEN}
+  #  googleGcs:
+  #    clientEmail: 'example@example.com'
+  #    privateKey: ${GCS_PRIVATE_KEY}
+  awsS3:
+    - host: amazonaws.com
+      accessKeyId: ${AWS_ACCESS_KEY_ID}
+      secretAccessKey: ${AWS_SECRET_ACCESS_KEY}
+
+costInsights:
+  engineerCost: 200000
+  engineerThreshold: 0.5
+  products:
+    computeEngine:
+      name: Compute Engine
+      icon: compute
+    cloudDataflow:
+      name: Cloud Dataflow
+      icon: data
+    cloudStorage:
+      name: Cloud Storage
+      icon: storage
+    bigQuery:
+      name: BigQuery
+      icon: search
+    events:
+      name: Events
+      icon: data
+  metrics:
+    DAU:
+      name: Daily Active Users
+      default: true
+    MSC:
+      name: Monthly Subscribers
+  currencies:
+    engineers:
+      label: 'Engineers 🛠'
+      unit: 'engineer'
+    usd:
+      label: 'US Dollars 💵'
+      kind: 'USD'
+      unit: 'dollar'
+      prefix: '$'
+      rate: 1
+    carbonOffsetTons:
+      label: 'Carbon Offset Tons ♻️⚖️s'
+      kind: 'CARBON_OFFSET_TONS'
+      unit: 'carbon offset ton'
+      rate: 3.5
+    beers:
+      label: 'Beers 🍺'
+      kind: 'BEERS'
+      unit: 'beer'
+      rate: 4.5
+    pintsIceCream:
+      label: 'Pints of Ice Cream 🍦'
+      kind: 'PINTS_OF_ICE_CREAM'
+      unit: 'ice cream pint'
+      rate: 5.5
+pagerduty:
+  eventsBaseUrl: 'https://events.pagerduty.com/v2'
+jenkins:
+  instances:
+    - name: default
+      baseUrl: https://jenkins.example.com
+      username: backstage-bot
+      apiKey: 123456789abcdef0123456789abcedf012
+
+azureDevOps:
+  host: dev.azure.com
+  token: my-token
+  organization: my-company
+
+apacheAirflow:
+  baseUrl: https://your.airflow.instance.com
+
+gocd:
+  baseUrl: https://your.gocd.instance.com
+
+permission:
+  enabled: true
@@ -8,6 +8,9 @@ on:

 jobs:
  build-backstage:
+    env:
+      NODE_OPTIONS: --max-old-space-size=4096
+      UFFIZZI_URL: https://uffizzi.com
    name: Build PR image
    runs-on: ubuntu-latest
    if: ${{ github.event_name != 'pull_request' || github.event.action != 'closed' }}
@@ -16,8 +19,6 @@ jobs:
    steps:
      - name: checkout
        uses: actions/checkout@v3
-        with:
-          path: backstage

      - name: setup-node
        uses: actions/setup-node@v3
@@ -25,21 +26,22 @@ jobs:
          node-version: 16.x
          registry-url: https://registry.npmjs.org/

-      - name: backstage create-app | delete if already exists
-        run: |
-          rm -rf ./example-app
-          npx @backstage/create-app
-        env:
-          BACKSTAGE_APP_NAME: example-app
-
-      - name: yarn build
-        run: |
-          yarn build:all
-        working-directory: ./example-app
+      - name: yarn install
+        uses: backstage/actions/yarn-install@v0.5.12
+        with:
+          cache-prefix: linux-v16

      - name: Use Uffizzi's backstage app config
        run: |
-          cp ./backstage/.github/uffizzi/uffizzi.production.app-config.yaml ./example-app/app-config.production.yaml;
+          cp -f ./.github/uffizzi/uffizzi.production.app-config.yaml ./app-config.yaml
+
+      - name: typescript build
+        run: |
+          yarn tsc
+
+      - name: backstage build
+        run: |
+          yarn workspace example-backend build

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v2
@@ -58,8 +60,8 @@ jobs:
      - name: Build Image
        uses: docker/build-push-action@v2
        with:
-          context: example-app
-          file: example-app/packages/backend/Dockerfile
+          context: .
+          file: packages/backend/Dockerfile
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}
          push: true
@@ -34,7 +34,7 @@
    "techdocs-cli": "node scripts/techdocs-cli.js",
    "techdocs-cli:dev": "cross-env TECHDOCS_CLI_DEV_MODE=true node scripts/techdocs-cli.js",
    "prepare": "husky install",
-    "postinstall": "husky install"
+    "postinstall": "husky install || true"
  },
  "workspaces": {
    "packages": [