Merge pull request #54 from mozilla-services/MZCLD-182

MZCLD-182

Author: ahoneiser

README.md

@@ -4,12 +4,14 @@
 
 ### Dependencies
 
-Install and run Postgres from docker:
+Run postgres & redis backends with docker-compose:
 
 ```sh
-docker run -e POSTGRES_PASSWORD=secret -p 5432:5432 postgres:15
+docker compose up
 ```
 
+> `docker-compose.yaml` defines volumes for postgres & redis to persist data for as long as the compose stack isn't destroyed.
+
 Set environment variables for postgres (or use `.env` file):
 
 ```sh

app-config.production.yaml

@@ -1,50 +1,43 @@
 app:
-  title: Moz Backstage App
+  title: moz backstage app
   baseUrl: http://localhost:3000
   analytics:
-    glean: 
+    glean:
       appId: moz_backstage
-      enabled: true
-      debug: 
+      debug:
         logging: false
         tag: backstage-dev
+
+      enabled: true
       environment: development
 
 organization:
-  name: Mozilla
+  name: mozilla
 
 backend:
-  # Used for enabling authentication, secret is shared by all backend plugins
-  # See https://backstage.io/docs/auth/service-to-service-auth for
-  # information on the format
-  # auth:
-  #   keys:
-  #     - secret: ${BACKEND_SECRET}
   baseUrl: http://localhost:7007
   listen:
     port: 7007
-    # Uncomment the following host directive to bind to specific interfaces
-    # host: 127.0.0.1
+
   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
+
   cors:
     origin: http://localhost:3000
     methods: [GET, HEAD, PATCH, POST, PUT, DELETE]
     credentials: true
-  # This is for local development only, it is not recommended to use this in production
-  # The production database configuration is stored in app-config.production.yaml
+
   database:
-    # client: better-sqlite3
-    # connection: ':memory:'
     client: pg
     connection:
       host: ${POSTGRES_HOST}
       port: ${POSTGRES_PORT}
       user: ${POSTGRES_USER}
       password: ${POSTGRES_PASSWORD}
-  # workingDirectory: /tmp # Use this to configure a working directory for the scaffolder, defaults to the OS temp-dir
+
+  cache:
+    store: redis
+    connection: redis://127.0.0.1:6379
 
 integrations:
   github:
@@ -78,7 +71,7 @@ techdocs:
 
 auth:
   # see https://backstage.io/docs/auth/ to learn about auth providers
-  environment: 'development'
+  environment: dev
   providers:
     # See https://backstage.io/docs/auth/guest/provider
     guest: {}
@@ -87,57 +80,22 @@ scaffolder:
   # see https://backstage.io/docs/features/software-templates/configuration for software template options
 
 catalog:
-  providers:
-    githubOrg:
-      id: mozilla
-      githubUrl: https://github.com
-      orgs: ['mozilla', 'mozilla-services']
-      schedule:
-        frequency: { hours: 1 }
-        timeout: { minutes: 50 }
   import:
     entityFilename: catalog-info.yaml
     pullRequestBranchName: backstage-integration
+
   rules:
     - allow: [Component, System, API, Resource, Location]
-  locations:
-    # Local example data, file locations are relative to the backend process, typically `packages/backend`
-    - type: file
-      target: ../../examples/entities.yaml
-
-    # Templates
-    - type: file
-      target: ../../examples/template/template.yaml
-      rules:
-        - allow: [Template]
 
+  locations:
     - type: file
-      target: ../../scaffolder-templates/*/template.yaml
+      target: /app/scaffolder-templates/*/template.yaml
       rules:
-        - allow: [Template]
+        - allow:
+            - Template
 
-    # Local example organizational data
-    - type: file
-      target: ../../examples/org.yaml
-      rules:
-        - allow: [User, Group]
-
-    ## Uncomment these lines to add more example data
-    # - type: url
-    #   target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all.yaml
-
-    ## Uncomment these lines to add an example org
-    # - type: url
-    #   target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/acme-corp.yaml
-    #   rules:
-    #     - allow: [User, Group]
-  # Experimental: Always use the search method in UrlReaderProcessor.
-  # New adopters are encouraged to enable it as this behavior will be the default in a future release.
   useUrlReadersSearch: true
 
-kubernetes:
-  # see https://backstage.io/docs/features/kubernetes/configuration for kubernetes configuration options
-
 # see https://backstage.io/docs/permissions/getting-started for more on the permission framework
 permission:
   # setting this to `false` will disable permissions

app-config.yaml

@@ -0,0 +1,25 @@
+services:
+  postgres:
+    image: postgres:15
+    environment:
+      POSTGRES_PASSWORD: secret
+      PGDATA: /var/lib/postgresql/data/pgdata
+
+    volumes:
+      - pgdata:/var/lib/postgresql/data
+
+    ports:
+      - 5432:5432
+
+  redis:
+    image: redis:7.2
+    command: redis-server --save 60 1 --loglevel warning
+    volumes:
+      - redisdata:/data
+
+    ports:
+      - 6379:6379
+
+volumes:
+  pgdata: {}
+  redisdata: {}