Merge pull request #16259 from mozilla/feat/backstage-metadata-setup-1

feat(backstage): setup initial backstage metadata
2024-01-24 14:10:57 -08:00 · 2024-01-24 14:10:57 -08:00 · 19f9442474
--- a/backstage/firestore.resources.yaml
+++ b/backstage/firestore.resources.yaml
@ -0,0 +1,24 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Resource
+metadata:
+  name: fxa-eventbroker-database
+  description: Stores oauth relying parties a customer has logged into.
+  tags:
+    - firestore
+spec:
+  type: database
+  owner: fxa-team
+  system: mozilla-accounts
+---
+apiVersion: backstage.io/v1alpha1
+kind: Resource
+metadata:
+  name: fxa-stripe-database
+  description: Stores customer, subscription, and invoice data from Stripe.
+  tags:
+    - firestore
+spec:
+  type: database
+  owner: fxa-team
+  system: mozilla-accounts
--- a/backstage/memcached.resources.yaml
+++ b/backstage/memcached.resources.yaml
@ -0,0 +1,10 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Resource
+metadata:
+  name: fxa-customs-cache
+  description: Caches rate limits and IP reuptation scores.
+spec:
+  type: database
+  owner: fxa-team
+  system: mozilla-accounts
--- a/backstage/mozilla-accounts.system.yaml
+++ b/backstage/mozilla-accounts.system.yaml
@ -0,0 +1,9 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: System
+metadata:
+  name: mozilla-accounts
+  description: Mozilla Accounts
+spec:
+  owner: fxa-team
+  domain: accounts
--- a/backstage/mysql.resources.yaml
+++ b/backstage/mysql.resources.yaml
@ -0,0 +1,48 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Resource
+metadata:
+  name: fxa-auth-database
+  description: Stores account, device, session, and key data.
+  tags:
+    - mysql
+spec:
+  type: database
+  owner: fxa-team
+  system: mozilla-accounts
+---
+apiVersion: backstage.io/v1alpha1
+kind: Resource
+metadata:
+  name: fxa-oauth-database
+  description: Stores OAuth client data and tokens.
+  tags:
+    - mysql
+spec:
+  type: database
+  owner: fxa-team
+  system: mozilla-accounts
+---
+apiVersion: backstage.io/v1alpha1
+kind: Resource
+metadata:
+  name: fxa-profile-database
+  description: Stores customer profile data (display name, photo  reference).
+  tags:
+    - mysql
+spec:
+  type: database
+  owner: fxa-team
+  system: mozilla-accounts
+---
+apiVersion: backstage.io/v1alpha1
+kind: Resource
+metadata:
+  name: fxa-pushbox-database
+  description: Stores device command data for customers.
+  tags:
+    - mysql
+spec:
+  type: database
+  owner: fxa-team
+  system: mozilla-accounts
--- a/backstage/redis.resources.yaml
+++ b/backstage/redis.resources.yaml
@ -0,0 +1,20 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Resource
+metadata:
+  name: fxa-profile-cache
+  description: Stores aggregated profile data.
+spec:
+  type: database
+  owner: fxa-team
+  system: mozilla-accounts
+---
+apiVersion: backstage.io/v1alpha1
+kind: Resource
+metadata:
+  name: fxa-auth-cache
+  description: Stores OAuth access and session token info, and email reminders.
+spec:
+  type: database
+  owner: fxa-team
+  system: mozilla-accounts
--- a/catalog-info.yaml
+++ b/catalog-info.yaml
@ -0,0 +1,25 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Location
+metadata:
+  name: fxa-monorepo
+spec:
+  type: url
+  targets:
+    - ./backstage/firestore.resources.yaml
+    - ./backstage/mozilla-accounts.system.yaml
+    - ./backstage/mysql.resources.yaml
+    - ./backstage/redis.resources.yaml
+    - ./backstage/memcached.resources.yaml
+    - ./packages/123done/backstage.yaml
+    - ./packages/browserid-verifier/backstage.yaml
+    - ./packages/fxa-admin-panel/backstage.yaml
+    - ./packages/fxa-admin-server/backstage.yaml
+    - ./packages/fxa-auth-server/backstage.yaml
+    - ./packages/fxa-content-server/backstage.yaml
+    - ./packages/fxa-customs-server/backstage.yaml
+    - ./packages/fxa-event-broker/backstage.yaml
+    - ./packages/fxa-graphql-api/backstage.yaml
+    - ./packages/fxa-payments-server/backstage.yaml
+    - ./packages/fxa-profile-server/backstage.yaml
+    - ./packages/fxa-settings/backstage.yaml
--- a/packages/123done/backstage.yaml
+++ b/packages/123done/backstage.yaml
@ -0,0 +1,21 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: fxa-123done
+  description: Demo app for Mozilla Accounts
+  tags:
+    - javascript
+    - node
+  links:
+    - url: https://production-123done.herokuapp.com/
+      title: Production 123done Demo App for Mozilla Accounts
+      type: website
+    - url: https://stage-123done.herokuapp.com/
+      title: Stage 123done Demo App for Mozilla Accounts
+      type: website
+spec:
+  type: website
+  lifecycle: production
+  owner: fxa-team
+  system: mozilla-accounts
--- a/packages/browserid-verifier/backstage.yaml
+++ b/packages/browserid-verifier/backstage.yaml
@ -0,0 +1,19 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: fxa-browserid-verifier
+  description: Verifies BrowserID assertions.
+  tags:
+    - typescript
+    - javascript
+    - node
+    - hapi
+  annotations:
+    sentry.io/project-slug: mozilla/fxa-browserid-verify
+    circleci.com/project-slug: github/mozilla/fxa
+spec:
+  type: service
+  lifecycle: production
+  owner: fxa-team
+  system: mozilla-accounts
--- a/packages/fxa-admin-panel/backstage.yaml
+++ b/packages/fxa-admin-panel/backstage.yaml
@ -0,0 +1,30 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: fxa-admin-panel
+  description: Admin Panel front-end for Mozilla Accounts
+  tags:
+    - typescript
+    - node
+    - react
+    - CRA
+  annotations:
+    sentry.io/project-slug: mozilla/fxa-admin-panel
+    circleci.com/project-slug: github/mozilla/fxa
+  links:
+    - url: https://fxa-admin-panel.prod.mozaws.net/
+      title: Production Admin Dashboard for Mozilla Accounts
+      icon: dashboard
+      type: admin-dashboard
+    - url: https://fxa-admin-panel.stage.mozaws.net/
+      title: Stage Admin Dashboard for Mozilla Accounts
+      icon: dashboard
+      type: admin-dashboard
+spec:
+  type: website
+  lifecycle: production
+  owner: fxa-team
+  system: mozilla-accounts
+  consumesApi:
+    - api:fxa-admin
--- a/packages/fxa-admin-server/backstage.yaml
+++ b/packages/fxa-admin-server/backstage.yaml
@ -0,0 +1,39 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: fxa-admin-server
+  description: Admin Server back-end for Mozilla Accounts
+  tags:
+    - typescript
+    - node
+    - nestjs
+    - graphql
+  annotations:
+    sentry.io/project-slug: mozilla/fxa-admin-panel
+    circleci.com/project-slug: github/mozilla/fxa
+spec:
+  type: service
+  lifecycle: production
+  owner: fxa-team
+  system: mozilla-accounts
+  providesApis:
+    - api:fxa-admin
+  dependsOn:
+    - resource:fxa-auth-database
+    - resource:fxa-oauth-database
+    - resource:fxa-stripe-database
+    - resource:fxa-auth-cache
+---
+apiVersion: backstage.io/v1alpha1
+kind: API
+metadata:
+  name: fxa-admin
+  description: Mozilla Accounts Admin API
+spec:
+  type: graphql
+  lifecycle: production
+  owner: fxa-team
+  system: mozilla-accounts
+  definition:
+    $text: ./src/schema.graphql
--- a/packages/fxa-auth-server/backstage.yaml
+++ b/packages/fxa-auth-server/backstage.yaml
@ -0,0 +1,42 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: fxa-auth-server
+  description: Auth Server back-end for Mozilla Accounts
+  tags:
+    - typescript
+    - javascript
+    - node
+    - hapi
+  annotations:
+    sentry.io/project-slug: mozilla/fxa-auth-server
+    circleci.com/project-slug: github/mozilla/fxa
+spec:
+  type: service
+  lifecycle: production
+  owner: fxa-team
+  system: mozilla-accounts
+  providesApis:
+    - api:fxa-auth
+  dependsOn:
+    - fxa-browserid-verifier
+    - fxa-customs-server
+    - resource:fxa-auth-database
+    - resource:fxa-oauth-database
+    - resource:fxa-pushbox-database
+    - resource:fxa-stripe-database
+    - resource:fxa-auth-cache
+---
+apiVersion: backstage.io/v1alpha1
+kind: API
+metadata:
+  name: fxa-auth
+  description: Some description of the api-name interface
+spec:
+  type: openapi
+  lifecycle: production
+  owner: group:group-name
+  system: system-name
+  definition:
+    $text: https://api.accounts.firefox.com/swagger.json
--- a/packages/fxa-content-server/backstage.yaml
+++ b/packages/fxa-content-server/backstage.yaml
@ -0,0 +1,29 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: fxa-content-server
+  description: Front-end for Mozilla Accounts
+  tags:
+    - javascript
+    - typescript
+    - node
+    - backbone
+    - react
+  annotations:
+    sentry.io/project-slug: mozilla/fxa-content-server
+    circleci.com/project-slug: github/mozilla/fxa
+  links:
+    - url: https://accounts.firefox.com/
+      title: Production Mozilla Accounts
+      type: website
+    - url: https://accounts.stage.mozaws.net/
+      title: Stage Mozilla Accounts
+      type: website
+spec:
+  type: website
+  lifecycle: production
+  owner: fxa-team
+  system: mozilla-accounts
+  consumesApis:
+    - api:fxa-auth
--- a/packages/fxa-customs-server/backstage.yaml
+++ b/packages/fxa-customs-server/backstage.yaml
@ -0,0 +1,20 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: fxa-customs-server
+  description: Customs Server back-end for Mozilla Accounts that handles fraud and abuse.
+  annotations:
+    sentry.io/project-slug: mozilla/fxa-customs
+    circleci.com/project-slug: github/mozilla/fxa
+  tags:
+    - javascript
+    - node
+    - express
+spec:
+  type: service
+  lifecycle: production
+  owner: fxa-team
+  system: mozilla-accounts
+  dependsOn:
+    - resource:fxa-customs-cache
--- a/packages/fxa-event-broker/backstage.yaml
+++ b/packages/fxa-event-broker/backstage.yaml
@ -0,0 +1,18 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: fxa-event-broker
+  description: Event distribution service using webhooks for Mozilla Accounts
+  annotations:
+    sentry.io/project-slug: mozilla/fxa-event-broker
+    circleci.com/project-slug: github/mozilla/fxa
+  tags:
+    - typescript
+    - node
+    - nestjs
+spec:
+  type: service
+  lifecycle: production
+  owner: fxa-team
+  system: mozilla-accounts
--- a/packages/fxa-graphql-api/backstage.yaml
+++ b/packages/fxa-graphql-api/backstage.yaml
@ -0,0 +1,34 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: fxa-graphql-api
+  description: Provides customer settings and account management.
+  annotations:
+    sentry.io/project-slug: mozilla/fxa-graphql-api
+    circleci.com/project-slug: github/mozilla/fxa
+  tags:
+    - typescript
+    - node
+    - nestjs
+    - graphql
+spec:
+  type: service
+  lifecycle: production
+  owner: fxa-team
+  system: mozilla-accounts
+  providesApis:
+    - api:fxa-graphql
+---
+apiVersion: backstage.io/v1alpha1
+kind: API
+metadata:
+  name: fxa-graphql
+  description: Mozilla Accounts GraphQL API
+spec:
+  type: graphql
+  lifecycle: production
+  owner: fxa-team
+  system: mozilla-accounts
+  definition:
+    $text: ./src/schema.gql
--- a/packages/fxa-payments-server/backstage.yaml
+++ b/packages/fxa-payments-server/backstage.yaml
@ -0,0 +1,27 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: fxa-payments-server
+  description: Subscription Platform front-end.
+  annotations:
+    sentry.io/project-slug: mozilla/fxa-payments
+    circleci.com/project-slug: github/mozilla/fxa
+  tags:
+    - typescript
+    - node
+    - react
+  links:
+    - url: https://subscriptions.firefox.com/
+      title: Production Subscription Platform
+      type: website
+    - url: https://payments-stage.fxa.nonprod.cloudops.mozgcp.net/
+      title: Stage Subscription Platform
+      type: website
+  consumesApis:
+    - api:fxa-auth
+spec:
+  type: website
+  lifecycle: production
+  owner: fxa-team
+  system: mozilla-accounts
--- a/packages/fxa-profile-server/backstage.yaml
+++ b/packages/fxa-profile-server/backstage.yaml
@ -0,0 +1,22 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: fxa-profile-server
+  description: Profile Server back-end for Mozilla Accounts that handles user profile data.
+  annotations:
+    sentry.io/project-slug: mozilla/fxa-profile
+    circleci.com/project-slug: github/mozilla/fxa
+  tags:
+    - javascript
+    - node
+    - hapi
+spec:
+  type: service
+  lifecycle: production
+  owner: fxa-team
+  system: mozilla-accounts
+  dependsOn:
+    - fxa-auth-server
+    - resource:fxa-profile-database
+    - resource:fxa-profile-cache
--- a/packages/fxa-settings/backstage.yaml
+++ b/packages/fxa-settings/backstage.yaml
@ -0,0 +1,30 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: fxa-settings
+  description: React Settings and Account front-end for Mozilla Accounts.
+  annotations:
+    sentry.io/project-slug: mozilla/fxa-content
+    circleci.com/project-slug: github/mozilla/fxa
+  tags:
+    - typescript
+    - node
+    - react
+  links:
+    - url: https://accounts.firefox.com/settings
+      title: Production Settings Page for Mozilla Accounts
+      type: website
+    - url: https://accounts.stage.mozaws.net/settings
+      title: Stage Settings Page for Mozilla Accounts
+      type: website
+spec:
+  type: website
+  lifecycle: production
+  owner: fxa-team
+  system: mozilla-accounts
+  consumesApis:
+    - api:fxa-graphql
+    - api:fxa-auth
+  dependsOn:
+    - fxa-profile-server