backstage

1
{
2
  "$schema": "https://backstage.io/schema/config-v1",
3
  "title": "Application Configuration Schema",
4
  "type": "object",
5
  "required": ["app", "backend", "costInsights", "sentry", "techdocs"],
6
  "properties": {
7
    "app": {
8
      "type": "object",
9
      "required": ["baseUrl"],
10
      "description": "Generic frontend configuration.",
11
      "properties": {
12
        "baseUrl": {
13
          "type": "string",
14
          "visibility": "frontend",
15
          "description": "The public absolute root URL that the frontend."
16
        },
17
        "title": {
18
          "type": "string",
19
          "visibility": "frontend",
20
          "description": "The title of the app."
21
        },
22
        "listen": {
23
          "type": "object",
24
          "description": "Listening configuration for local development",
25
          "properties": {
26
            "host": {
27
              "type": "string",
28
              "visibility": "frontend",
29
              "description": "The host that the frontend should be bound to. Only used for local development."
30
            },
31
            "port": {
32
              "type": "number",
33
              "visibility": "frontend",
34
              "description": "The port that the frontend should be bound to. Only used for local development."
35
            }
36
          }
37
        },
38
        "support": {
39
          "description": "Information about support of this Backstage instance and how to contact the integrator team.",
40
          "type": "object",
41
          "required": ["items", "url"],
42
          "properties": {
43
            "url": {
44
              "description": "The primary support url.",
45
              "visibility": "frontend",
46
              "type": "string"
47
            },
48
            "items": {
49
              "description": "A list of categorized support item groupings.",
50
              "type": "array",
51
              "items": {
52
                "type": "object",
53
                "required": ["links", "title"],
54
                "properties": {
55
                  "title": {
56
                    "description": "The title of the support item grouping.",
57
                    "visibility": "frontend",
58
                    "type": "string"
59
                  },
60
                  "icon": {
61
                    "description": "An optional icon for the support item grouping.",
62
                    "visibility": "frontend",
63
                    "type": "string"
64
                  },
65
                  "links": {
66
                    "description": "A list of support links for the Backstage instance.",
67
                    "type": "array",
68
                    "items": {
69
                      "type": "object",
70
                      "required": ["url"],
71
                      "properties": {
72
                        "url": {
73
                          "visibility": "frontend",
74
                          "type": "string"
75
                        },
76
                        "title": {
77
                          "visibility": "frontend",
78
                          "type": "string"
79
                        }
80
                      }
81
                    }
82
                  }
83
                }
84
              }
85
            }
86
          }
87
        }
88
      }
89
    },
90
    "lighthouse": {
91
      "type": "object",
92
      "properties": {
93
        "baseUrl": {
94
          "type": "string",
95
          "visibility": "frontend"
96
        }
97
      }
98
    },
99
    "auth": {
100
      "type": "object",
101
      "description": "Configuration that provides information on available authentication providers configured for app",
102
      "properties": {
103
        "providers": {
104
          "type": "object",
105
          "description": "The available auth-provider options and attributes",
106
          "additionalProperties": {
107
            "type": "object",
108
            "visibility": "frontend"
109
          },
110
          "properties": {
111
            "google": {
112
              "type": "object",
113
              "additionalProperties": {
114
                "type": "object",
115
                "additionalProperties": {
116
                  "type": "string"
117
                }
118
              }
119
            },
120
            "github": {
121
              "type": "object",
122
              "additionalProperties": {
123
                "type": "object",
124
                "additionalProperties": {
125
                  "type": "string"
126
                }
127
              }
128
            },
129
            "gitlab": {
130
              "type": "object",
131
              "additionalProperties": {
132
                "type": "object",
133
                "additionalProperties": {
134
                  "type": "string"
135
                }
136
              }
137
            },
138
            "saml": {
139
              "type": "object",
140
              "required": ["entryPoint", "issuer"],
141
              "properties": {
142
                "entryPoint": {
143
                  "type": "string"
144
                },
145
                "logoutUrl": {
146
                  "type": "string"
147
                },
148
                "issuer": {
149
                  "type": "string"
150
                },
151
                "cert": {
152
                  "type": "string"
153
                },
154
                "privateKey": {
155
                  "type": "string"
156
                },
157
                "decryptionPvk": {
158
                  "type": "string"
159
                },
160
                "signatureAlgorithm": {
161
                  "enum": ["sha256", "sha512"],
162
                  "type": "string"
163
                },
164
                "digestAlgorithm": {
165
                  "type": "string"
166
                }
167
              }
168
            },
169
            "okta": {
170
              "type": "object",
171
              "additionalProperties": {
172
                "type": "object",
173
                "additionalProperties": {
174
                  "type": "string"
175
                }
176
              }
177
            },
178
            "oauth2": {
179
              "type": "object",
180
              "additionalProperties": {
181
                "type": "object",
182
                "required": [
183
                  "authorizationUrl",
184
                  "clientId",
185
                  "clientSecret",
186
                  "tokenUrl"
187
                ],
188
                "properties": {
189
                  "clientId": {
190
                    "type": "string"
191
                  },
192
                  "clientSecret": {
193
                    "type": "string"
194
                  },
195
                  "authorizationUrl": {
196
                    "type": "string"
197
                  },
198
                  "tokenUrl": {
199
                    "type": "string"
200
                  },
201
                  "scope": {
202
                    "type": "string"
203
                  }
204
                }
205
              }
206
            },
207
            "oidc": {
208
              "type": "object",
209
              "additionalProperties": {
210
                "type": "object",
211
                "additionalProperties": {
212
                  "type": "string"
213
                }
214
              }
215
            },
216
            "auth0": {
217
              "type": "object",
218
              "additionalProperties": {
219
                "type": "object",
220
                "additionalProperties": {
221
                  "type": "string"
222
                }
223
              }
224
            },
225
            "microsoft": {
226
              "type": "object",
227
              "additionalProperties": {
228
                "type": "object",
229
                "additionalProperties": {
230
                  "type": "string"
231
                }
232
              }
233
            },
234
            "onelogin": {
235
              "type": "object",
236
              "additionalProperties": {
237
                "type": "object",
238
                "additionalProperties": {
239
                  "type": "string"
240
                }
241
              }
242
            },
243
            "awsalb": {
244
              "type": "object",
245
              "required": ["region"],
246
              "properties": {
247
                "issuer": {
248
                  "type": "string"
249
                },
250
                "region": {
251
                  "type": "string"
252
                }
253
              }
254
            }
255
          }
256
        },
257
        "environment": {
258
          "description": "The 'environment' attribute added as an optional parameter to have configurable environment value for `auth.providers`.\ndefault value: 'development'\noptional values: 'development' | 'production'",
259
          "visibility": "frontend",
260
          "type": "string"
261
        },
262
        "session": {
263
          "type": "object",
264
          "properties": {
265
            "secret": {
266
              "description": "The secret attribute of session object.",
267
              "visibility": "secret",
268
              "type": "string"
269
            }
270
          }
271
        }
272
      }
273
    },
274
    "backend": {
275
      "type": "object",
276
      "required": ["baseUrl", "database", "listen"],
277
      "description": "Generic backend configuration.",
278
      "properties": {
279
        "baseUrl": {
280
          "type": "string",
281
          "description": "The public absolute root URL that the backend is reachable at.",
282
          "visibility": "frontend"
283
        },
284
        "listen": {
285
          "description": "Address that the backend should listen to.",
286
          "anyOf": [
287
            {
288
              "type": "object",
289
              "properties": {
290
                "address": {
291
                  "description": "Address of the interface that the backend should bind to.",
292
                  "type": "string"
293
                },
294
                "port": {
295
                  "description": "Port that the backend should listen to.",
296
                  "type": ["string", "number"]
297
                }
298
              }
299
            },
300
            {
301
              "type": "string"
302
            }
303
          ]
304
        },
305
        "https": {
306
          "description": "HTTPS configuration for the backend. If omitted the backend will serve HTTP.\n\nSetting this to `true` will cause self-signed certificates to be generated, which\ncan be useful for local development or other non-production scenarios.",
307
          "anyOf": [
308
            {
309
              "type": "object",
310
              "properties": {
311
                "certificate": {
312
                  "description": "Certificate configuration",
313
                  "type": "object",
314
                  "required": ["cert", "key"],
315
                  "properties": {
316
                    "cert": {
317
                      "description": "PEM encoded certificate. Use $file to load in a file",
318
                      "type": "string"
319
                    },
320
                    "key": {
321
                      "description": "PEM encoded certificate key. Use $file to load in a file.",
322
                      "visibility": "secret",
323
                      "type": "string"
324
                    }
325
                  }
326
                }
327
              }
328
            },
329
            {
330
              "enum": [true],
331
              "type": "boolean"
332
            }
333
          ]
334
        },
335
        "database": {
336
          "description": "Database connection configuration, select database type using the `client` field",
337
          "anyOf": [
338
            {
339
              "type": "object",
340
              "properties": {
341
                "client": {
342
                  "type": "string",
343
                  "enum": ["sqlite3", "better-sqlite3"]
344
                },
345
                "connection": {
346
                  "type": "string"
347
                }
348
              },
349
              "required": ["client", "connection"]
350
            },
351
            {
352
              "type": "object",
353
              "properties": {
354
                "client": {
355
                  "type": "string",
356
                  "enum": ["pg"]
357
                },
358
                "connection": {
359
                  "description": "PostgreSQL connection string or knex configuration object.",
360
                  "anyOf": [
361
                    {
362
                      "type": "object",
363
                      "properties": {},
364
                      "additionalProperties": true
365
                    },
366
                    {
367
                      "type": "string"
368
                    }
369
                  ]
370
                }
371
              },
372
              "required": ["client", "connection"]
373
            }
374
          ]
375
        },
376
        "cors": {
377
          "type": "object",
378
          "properties": {
379
            "origin": {
380
              "anyOf": [
381
                {
382
                  "type": "array",
383
                  "items": {
384
                    "type": "string"
385
                  }
386
                },
387
                {
388
                  "type": "string"
389
                }
390
              ]
391
            },
392
            "methods": {
393
              "anyOf": [
394
                {
395
                  "type": "array",
396
                  "items": {
397
                    "type": "string"
398
                  }
399
                },
400
                {
401
                  "type": "string"
402
                }
403
              ]
404
            },
405
            "allowedHeaders": {
406
              "anyOf": [
407
                {
408
                  "type": "array",
409
                  "items": {
410
                    "type": "string"
411
                  }
412
                },
413
                {
414
                  "type": "string"
415
                }
416
              ]
417
            },
418
            "exposedHeaders": {
419
              "anyOf": [
420
                {
421
                  "type": "array",
422
                  "items": {
423
                    "type": "string"
424
                  }
425
                },
426
                {
427
                  "type": "string"
428
                }
429
              ]
430
            },
431
            "credentials": {
432
              "type": "boolean"
433
            },
434
            "maxAge": {
435
              "type": "number"
436
            },
437
            "preflightContinue": {
438
              "type": "boolean"
439
            },
440
            "optionsSuccessStatus": {
441
              "type": "number"
442
            }
443
          }
444
        },
445
        "reading": {
446
          "description": "Configuration related to URL reading, used for example for reading catalog info\nfiles, scaffolder templates, and techdocs content.",
447
          "type": "object",
448
          "properties": {
449
            "allow": {
450
              "description": "A list of targets to allow outgoing requests to. Users will be able to make\nrequests on behalf of the backend to the targets that are allowed by this list.",
451
              "type": "array",
452
              "items": {
453
                "type": "object",
454
                "required": ["host"],
455
                "properties": {
456
                  "host": {
457
                    "description": "A host to allow outgoing requests to, being either a full host or\na subdomain wildcard pattern with a leading `*`. For example `example.com`\nand `*.example.com` are valid values, `prod.*.example.com` is not.\nThe host may also contain a port, for example `example.com:8080`.",
458
                    "type": "string"
459
                  }
460
                }
461
              }
462
            }
463
          }
464
        },
465
        "csp": {
466
          "description": "Content Security Policy options.\n\nThe keys are the plain policy ID, e.g. \"upgrade-insecure-requests\". The\nvalues are on the format that the helmet library expects them, as an\narray of strings. There is also the special value false, which means to\nremove the default value that Backstage puts in place for that policy.",
467
          "type": "object",
468
          "additionalProperties": {
469
            "anyOf": [
470
              {
471
                "type": "array",
472
                "items": {
473
                  "type": "string"
474
                }
475
              },
476
              {
477
                "enum": [false],
478
                "type": "boolean"
479
              }
480
            ]
481
          }
482
        }
483
      }
484
    },
485
    "organization": {
486
      "description": "Configuration that provides information about the organization that the app is for.",
487
      "type": "object",
488
      "properties": {
489
        "name": {
490
          "description": "The name of the organization that the app belongs to.",
491
          "visibility": "frontend",
492
          "type": "string"
493
        }
494
      }
495
    },
496
    "integrations": {
497
      "description": "Configuration for integrations towards various external repository provider systems",
498
      "type": "object",
499
      "properties": {
500
        "azure": {
501
          "description": "Integration configuration for Azure",
502
          "type": "array",
503
          "items": {
504
            "type": "object",
505
            "required": ["host"],
506
            "properties": {
507
              "host": {
508
                "description": "The hostname of the given Azure instance",
509
                "visibility": "frontend",
510
                "type": "string"
511
              },
512
              "token": {
513
                "description": "Token used to authenticate requests.",
514
                "visibility": "secret",
515
                "type": "string"
516
              }
517
            }
518
          }
519
        },
520
        "bitbucket": {
521
          "description": "Integration configuration for Bitbucket",
522
          "type": "array",
523
          "items": {
524
            "type": "object",
525
            "required": ["host"],
526
            "properties": {
527
              "host": {
528
                "description": "The hostname of the given Bitbucket instance",
529
                "visibility": "frontend",
530
                "type": "string"
531
              },
532
              "token": {
533
                "description": "Token used to authenticate requests.",
534
                "visibility": "secret",
535
                "type": "string"
536
              },
537
              "apiBaseUrl": {
538
                "description": "The base url for the Bitbucket API, for example https://api.bitbucket.org/2.0",
539
                "visibility": "frontend",
540
                "type": "string"
541
              },
542
              "username": {
543
                "description": "The username to use for authenticated requests.",
544
                "visibility": "secret",
545
                "type": "string"
546
              },
547
              "appPassword": {
548
                "description": "Bitbucket app password used to authenticate requests.",
549
                "visibility": "secret",
550
                "type": "string"
551
              }
552
            }
553
          }
554
        },
555
        "github": {
556
          "description": "Integration configuration for GitHub",
557
          "type": "array",
558
          "items": {
559
            "type": "object",
560
            "required": ["host"],
561
            "properties": {
562
              "host": {
563
                "description": "The hostname of the given GitHub instance",
564
                "visibility": "frontend",
565
                "type": "string"
566
              },
567
              "token": {
568
                "description": "Token used to authenticate requests.",
569
                "visibility": "secret",
570
                "type": "string"
571
              },
572
              "apiBaseUrl": {
573
                "description": "The base url for the GitHub API, for example https://api.github.com",
574
                "visibility": "frontend",
575
                "type": "string"
576
              },
577
              "rawBaseUrl": {
578
                "description": "The base url for GitHub raw resources, for example https://raw.githubusercontent.com",
579
                "visibility": "frontend",
580
                "type": "string"
581
              },
582
              "apps": {
583
                "description": "GitHub Apps configuration",
584
                "visibility": "backend",
585
                "type": "array",
586
                "items": {
587
                  "type": "object",
588
                  "required": [
589
                    "appId",
590
                    "clientId",
591
                    "clientSecret",
592
                    "privateKey",
593
                    "webhookSecret"
594
                  ],
595
                  "properties": {
596
                    "appId": {
597
                      "description": "The numeric GitHub App ID",
598
                      "type": "number"
599
                    },
600
                    "privateKey": {
601
                      "description": "The private key to use for auth against the app",
602
                      "visibility": "secret",
603
                      "type": "string"
604
                    },
605
                    "webhookSecret": {
606
                      "description": "The secret used for webhooks",
607
                      "visibility": "secret",
608
                      "type": "string"
609
                    },
610
                    "clientId": {
611
                      "description": "The client ID to use",
612
                      "type": "string"
613
                    },
614
                    "clientSecret": {
615
                      "description": "The client secret to use",
616
                      "visibility": "secret",
617
                      "type": "string"
618
                    }
619
                  }
620
                }
621
              }
622
            }
623
          }
624
        },
625
        "gitlab": {
626
          "description": "Integration configuration for GitLab",
627
          "type": "array",
628
          "items": {
629
            "type": "object",
630
            "required": ["host"],
631
            "properties": {
632
              "host": {
633
                "description": "The host of the target that this matches on, e.g. \"gitlab.com\".",
634
                "visibility": "frontend",
635
                "type": "string"
636
              },
637
              "apiBaseUrl": {
638
                "description": "The base URL of the API of this provider, e.g.\n\"https://gitlab.com/api/v4\", with no trailing slash.\n\nMay be omitted specifically for public GitLab; then it will be deduced.",
639
                "visibility": "frontend",
640
                "type": "string"
641
              },
642
              "token": {
643
                "description": "The authorization token to use for requests to this provider.\n\nIf no token is specified, anonymous access is used.",
644
                "visibility": "secret",
645
                "type": "string"
646
              },
647
              "baseUrl": {
648
                "description": "The baseUrl of this provider, e.g. \"https://gitlab.com\", which is\npassed into the GitLab client.\n\nIf no baseUrl is provided, it will default to https://${host}.",
649
                "visibility": "frontend",
650
                "type": "string"
651
              }
652
            }
653
          }
654
        }
655
      }
656
    },
657
    "catalog": {
658
      "description": "Configuration options for the catalog plugin.",
659
      "type": "object",
660
      "properties": {
661
        "rules": {
662
          "description": "Rules to apply to all catalog entities, from any location.\n\nAn undefined list of matchers means match all, an empty list of\nmatchers means match none.\n\nThis is commonly used to put in what amounts to an allowlist of kinds\nthat regular users of Backstage are permitted to register locations\nfor. This can be used to stop them from registering yaml files\ndescribing for example a Group entity called \"admin\" that they make\nthemselves members of, or similar.",
663
          "type": "array",
664
          "items": {
665
            "type": "object",
666
            "required": ["allow"],
667
            "properties": {
668
              "allow": {
669
                "description": "Allow entities of these particular kinds.\n\nE.g. [\"Component\", \"API\", \"Template\", \"Location\"]",
670
                "type": "array",
671
                "items": {
672
                  "type": "string"
673
                }
674
              }
675
            }
676
          }
677
        },
678
        "readonly": {
679
          "description": "Readonly defines whether the catalog allows writes after startup.\n\nSetting 'readonly=false' allows users to register their own components.\nThis is the default value.\n\nSetting 'readonly=true' configures catalog to only allow reads. This can\nbe used in combination with static locations to only serve operator\nprovided locations. Effectively this removes the ability to register new\ncomponents to a running backstage instance.",
680
          "type": "boolean"
681
        },
682
        "locations": {
683
          "description": "A set of static locations that the catalog shall always keep itself\nup-to-date with. This is commonly used for large, permanent integrations\nthat are defined by the Backstage operators at an organization, rather\nthan individual things that users register dynamically.\n\nThese have (optional) rules of their own. These override what the global\nrules above specify. This way, you can prevent everybody from register\ne.g. User and Group entities, except for one or a few static locations\nthat have those two kinds explicitly allowed.\n\nFor example:\n\n```yaml\nrules:\n  - allow: [Component, API, Template, Location]\nlocations:\n  - type: url\n    target: https://github.com/org/repo/blob/master/users.yaml\n    rules:\n      - allow: [User, Group]\n  - type: url\n    target: https://github.com/org/repo/blob/master/systems.yaml\n    rules:\n      - allow: [System]\n```",
684
          "type": "array",
685
          "items": {
686
            "type": "object",
687
            "required": ["target", "type"],
688
            "properties": {
689
              "type": {
690
                "description": "The type of location, e.g. \"url\".",
691
                "type": "string"
692
              },
693
              "target": {
694
                "description": "The target URL of the location, e.g.\n\"https://github.com/org/repo/blob/master/users.yaml\".",
695
                "type": "string"
696
              },
697
              "rules": {
698
                "description": "Optional extra rules that apply to this particular location.\n\nThese override the global rules above.",
699
                "type": "array",
700
                "items": {
701
                  "type": "object",
702
                  "required": ["allow"],
703
                  "properties": {
704
                    "allow": {
705
                      "description": "Allow entities of these particular kinds.\n\nE.g. [\"Group\", \"User\"]",
706
                      "type": "array",
707
                      "items": {
708
                        "type": "string"
709
                      }
710
                    }
711
                  }
712
                }
713
              }
714
            }
715
          }
716
        },
717
        "processors": {
718
          "description": "List of processor-specific options and attributes",
719
          "type": "object",
720
          "properties": {
721
            "ldapOrg": {
722
              "description": "LdapOrgReaderProcessor configuration",
723
              "type": "object",
724
              "required": ["providers"],
725
              "properties": {
726
                "providers": {
727
                  "description": "The configuration parameters for each single LDAP provider.",
728
                  "type": "array",
729
                  "items": {
730
                    "type": "object",
731
                    "required": ["groups", "target", "users"],
732
                    "properties": {
733
                      "target": {
734
                        "description": "The prefix of the target that this matches on, e.g.\n\"ldaps://ds.example.net\", with no trailing slash.",
735
                        "type": "string"
736
                      },
737
                      "bind": {
738
                        "description": "The settings to use for the bind command. If none are specified,\nthe bind command is not issued.",
739
                        "type": "object",
740
                        "required": ["dn", "secret"],
741
                        "properties": {
742
                          "dn": {
743
                            "description": "The DN of the user to auth as.\n\nE.g. \"uid=ldap-robot,ou=robots,ou=example,dc=example,dc=net\"",
744
                            "type": "string"
745
                          },
746
                          "secret": {
747
                            "description": "The secret of the user to auth as (its password).",
748
                            "visibility": "secret",
749
                            "type": "string"
750
                          }
751
                        }
752
                      },
753
                      "users": {
754
                        "description": "The settings that govern the reading and interpretation of users.",
755
                        "type": "object",
756
                        "required": ["dn", "options"],
757
                        "properties": {
758
                          "dn": {
759
                            "description": "The DN under which users are stored.\n\nE.g. \"ou=people,ou=example,dc=example,dc=net\"",
760
                            "type": "string"
761
                          },
762
                          "options": {
763
                            "description": "The search options to use. The default is scope \"one\" and\nattributes \"*\" and \"+\".\n\nIt is common to want to specify a filter, to narrow down the set\nof matching items.",
764
                            "type": "object",
765
                            "properties": {
766
                              "scope": {
767
                                "enum": ["base", "one", "sub"],
768
                                "type": "string"
769
                              },
770
                              "filter": {
771
                                "type": "string"
772
                              },
773
                              "attributes": {
774
                                "anyOf": [
775
                                  {
776
                                    "type": "array",
777
                                    "items": {
778
                                      "type": "string"
779
                                    }
780
                                  },
781
                                  {
782
                                    "type": "string"
783
                                  }
784
                                ]
785
                              },
786
                              "paged": {
787
                                "anyOf": [
788
                                  {
789
                                    "type": "object",
790
                                    "properties": {
791
                                      "pageSize": {
792
                                        "type": "number"
793
                                      },
794
                                      "pagePause": {
795
                                        "type": "boolean"
796
                                      }
797
                                    }
798
                                  },
799
                                  {
800
                                    "type": "boolean"
801
                                  }
802
                                ]
803
                              }
804
                            }
805
                          },
806
                          "set": {
807
                            "description": "JSON paths (on a.b.c form) and hard coded values to set on those\npaths.\n\nThis can be useful for example if you want to hard code a\nnamespace or similar on the generated entities.",
808
                            "type": "object"
809
                          },
810
                          "map": {
811
                            "description": "Mappings from well known entity fields, to LDAP attribute names",
812
                            "type": "object",
813
                            "properties": {
814
                              "rdn": {
815
                                "description": "The name of the attribute that holds the relative\ndistinguished name of each entry. Defaults to \"uid\".",
816
                                "type": "string"
817
                              },
818
                              "name": {
819
                                "description": "The name of the attribute that shall be used for the value of\nthe metadata.name field of the entity. Defaults to \"uid\".",
820
                                "type": "string"
821
                              },
822
                              "description": {
823
                                "description": "The name of the attribute that shall be used for the value of\nthe metadata.description field of the entity.",
824
                                "type": "string"
825
                              },
826
                              "displayName": {
827
                                "description": "The name of the attribute that shall be used for the value of\nthe spec.profile.displayName field of the entity. Defaults to\n\"cn\".",
828
                                "type": "string"
829
                              },
830
                              "email": {
831
                                "description": "The name of the attribute that shall be used for the value of\nthe spec.profile.email field of the entity. Defaults to\n\"mail\".",
832
                                "type": "string"
833
                              },
834
                              "picture": {
835
                                "description": "The name of the attribute that shall be used for the value of\nthe spec.profile.picture field of the entity.",
836
                                "type": "string"
837
                              },
838
                              "memberOf": {
839
                                "description": "The name of the attribute that shall be used for the values of\nthe spec.memberOf field of the entity. Defaults to \"memberOf\".",
840
                                "type": "string"
841
                              }
842
                            }
843
                          }
844
                        }
845
                      },
846
                      "groups": {
847
                        "description": "The settings that govern the reading and interpretation of groups.",
848
                        "type": "object",
849
                        "required": ["dn", "options"],
850
                        "properties": {
851
                          "dn": {
852
                            "description": "The DN under which groups are stored.\n\nE.g. \"ou=people,ou=example,dc=example,dc=net\"",
853
                            "type": "string"
854
                          },
855
                          "options": {
856
                            "description": "The search options to use. The default is scope \"one\" and\nattributes \"*\" and \"+\".\n\nIt is common to want to specify a filter, to narrow down the set\nof matching items.",
857
                            "type": "object",
858
                            "properties": {
859
                              "scope": {
860
                                "enum": ["base", "one", "sub"],
861
                                "type": "string"
862
                              },
863
                              "filter": {
864
                                "type": "string"
865
                              },
866
                              "attributes": {
867
                                "anyOf": [
868
                                  {
869
                                    "type": "array",
870
                                    "items": {
871
                                      "type": "string"
872
                                    }
873
                                  },
874
                                  {
875
                                    "type": "string"
876
                                  }
877
                                ]
878
                              },
879
                              "paged": {
880
                                "anyOf": [
881
                                  {
882
                                    "type": "object",
883
                                    "properties": {
884
                                      "pageSize": {
885
                                        "type": "number"
886
                                      },
887
                                      "pagePause": {
888
                                        "type": "boolean"
889
                                      }
890
                                    }
891
                                  },
892
                                  {
893
                                    "type": "boolean"
894
                                  }
895
                                ]
896
                              }
897
                            }
898
                          },
899
                          "set": {
900
                            "description": "JSON paths (on a.b.c form) and hard coded values to set on those\npaths.\n\nThis can be useful for example if you want to hard code a\nnamespace or similar on the generated entities.",
901
                            "type": "object"
902
                          },
903
                          "map": {
904
                            "description": "Mappings from well known entity fields, to LDAP attribute names",
905
                            "type": "object",
906
                            "properties": {
907
                              "rdn": {
908
                                "description": "The name of the attribute that holds the relative\ndistinguished name of each entry. Defaults to \"cn\".",
909
                                "type": "string"
910
                              },
911
                              "name": {
912
                                "description": "The name of the attribute that shall be used for the value of\nthe metadata.name field of the entity. Defaults to \"cn\".",
913
                                "type": "string"
914
                              },
915
                              "description": {
916
                                "description": "The name of the attribute that shall be used for the value of\nthe metadata.description field of the entity. Defaults to\n\"description\".",
917
                                "type": "string"
918
                              },
919
                              "type": {
920
                                "description": "The name of the attribute that shall be used for the value of\nthe spec.type field of the entity. Defaults to \"groupType\".",
921
                                "type": "string"
922
                              },
923
                              "displayName": {
924
                                "description": "The name of the attribute that shall be used for the value of\nthe spec.profile.displayName field of the entity. Defaults to\n\"cn\".",
925
                                "type": "string"
926
                              },
927
                              "email": {
928
                                "description": "The name of the attribute that shall be used for the value of\nthe spec.profile.email field of the entity.",
929
                                "type": "string"
930
                              },
931
                              "picture": {
932
                                "description": "The name of the attribute that shall be used for the value of\nthe spec.profile.picture field of the entity.",
933
                                "type": "string"
934
                              },
935
                              "memberOf": {
936
                                "description": "The name of the attribute that shall be used for the values of\nthe spec.parent field of the entity. Defaults to \"memberOf\".",
937
                                "type": "string"
938
                              },
939
                              "members": {
940
                                "description": "The name of the attribute that shall be used for the values of\nthe spec.children field of the entity. Defaults to \"member\".",
941
                                "type": "string"
942
                              }
943
                            }
944
                          }
945
                        }
946
                      }
947
                    }
948
                  }
949
                }
950
              }
951
            },
952
            "awsOrganization": {
953
              "description": "AwsOrganizationCloudAccountProcessor configuration",
954
              "type": "object",
955
              "required": ["provider"],
956
              "properties": {
957
                "provider": {
958
                  "type": "object",
959
                  "properties": {
960
                    "roleArn": {
961
                      "description": "The role to be assumed by this processor",
962
                      "type": "string"
963
                    }
964
                  }
965
                }
966
              }
967
            },
968
            "microsoftGraphOrg": {
969
              "description": "MicrosoftGraphOrgReaderProcessor configuration",
970
              "type": "object",
971
              "required": ["providers"],
972
              "properties": {
973
                "providers": {
974
                  "description": "The configuration parameters for each single Microsoft Graph provider.",
975
                  "type": "array",
976
                  "items": {
977
                    "type": "object",
978
                    "required": [
979
                      "clientId",
980
                      "clientSecret",
981
                      "target",
982
                      "tenantId"
983
                    ],
984
                    "properties": {
985
                      "target": {
986
                        "description": "The prefix of the target that this matches on, e.g.\n\"https://graph.microsoft.com/v1.0\", with no trailing slash.",
987
                        "type": "string"
988
                      },
989
                      "authority": {
990
                        "description": "The auth authority used.\n\nDefault value \"https://login.microsoftonline.com\"",
991
                        "type": "string"
992
                      },
993
                      "tenantId": {
994
                        "description": "The tenant whose org data we are interested in.",
995
                        "type": "string"
996
                      },
997
                      "clientId": {
998
                        "description": "The OAuth client ID to use for authenticating requests.",
999
                        "type": "string"
1000
                      },
1001
                      "clientSecret": {
1002
                        "description": "The OAuth client secret to use for authenticating requests.",
1003
                        "visibility": "secret",
1004
                        "type": "string"
1005
                      },
1006
                      "userFilter": {
1007
                        "description": "The filter to apply to extract users.\n\nE.g. \"accountEnabled eq true and userType eq 'member'\"",
1008
                        "type": "string"
1009
                      },
1010
                      "groupFilter": {
1011
                        "description": "The filter to apply to extract groups.\n\nE.g. \"securityEnabled eq false and mailEnabled eq true\"",
1012
                        "type": "string"
1013
                      }
1014
                    }
1015
                  }
1016
                }
1017
              }
1018
            }
1019
          }
1020
        }
1021
      }
1022
    },
1023
    "costInsights": {
1024
      "type": "object",
1025
      "required": ["engineerCost", "products"],
1026
      "properties": {
1027
        "engineerCost": {
1028
          "visibility": "frontend",
1029
          "type": "number"
1030
        },
1031
        "products": {
1032
          "type": "object",
1033
          "additionalProperties": {
1034
            "type": "object",
1035
            "required": ["name"],
1036
            "properties": {
1037
              "name": {
1038
                "visibility": "frontend",
1039
                "type": "string"
1040
              },
1041
              "icon": {
1042
                "visibility": "frontend",
1043
                "enum": [
1044
                  "compute",
1045
                  "data",
1046
                  "database",
1047
                  "ml",
1048
                  "search",
1049
                  "storage"
1050
                ],
1051
                "type": "string"
1052
              }
1053
            }
1054
          }
1055
        },
1056
        "metrics": {
1057
          "type": "object",
1058
          "additionalProperties": {
1059
            "type": "object",
1060
            "required": ["name"],
1061
            "properties": {
1062
              "name": {
1063
                "visibility": "frontend",
1064
                "type": "string"
1065
              },
1066
              "default": {
1067
                "visibility": "frontend",
1068
                "type": "boolean"
1069
              }
1070
            }
1071
          }
1072
        }
1073
      }
1074
    },
1075
    "fossa": {
1076
      "type": "object",
1077
      "required": ["organizationId"],
1078
      "properties": {
1079
        "organizationId": {
1080
          "description": "The organization id in fossa.",
1081
          "visibility": "frontend",
1082
          "type": "string"
1083
        }
1084
      }
1085
    },
1086
    "kubernetes": {
1087
      "type": "object",
1088
      "required": ["clusterLocatorMethods", "serviceLocatorMethod"],
1089
      "properties": {
1090
        "serviceLocatorMethod": {
1091
          "type": "object",
1092
          "required": ["type"],
1093
          "visibility": "frontend",
1094
          "properties": {
1095
            "type": {
1096
              "type": "string",
1097
              "enum": ["multiTenant"],
1098
              "visibility": "frontend"
1099
            }
1100
          }
1101
        },
1102
        "clusterLocatorMethods": {
1103
          "type": "array",
1104
          "visibility": "frontend"
1105
        },
1106
        "customResources": {
1107
          "type": "array",
1108
          "visibility": "frontend"
1109
        }
1110
      }
1111
    },
1112
    "kafka": {
1113
      "type": "object",
1114
      "required": ["clientId", "clusters"],
1115
      "properties": {
1116
        "clientId": {
1117
          "description": "Client ID used to Backstage uses to identify when connecting to the Kafka cluster.",
1118
          "type": "string"
1119
        },
1120
        "clusters": {
1121
          "type": "array",
1122
          "items": {
1123
            "type": "object",
1124
            "required": ["brokers", "name"],
1125
            "properties": {
1126
              "name": {
1127
                "type": "string"
1128
              },
1129
              "brokers": {
1130
                "description": "List of brokers in the Kafka cluster to connect to.",
1131
                "type": "array",
1132
                "items": {
1133
                  "type": "string"
1134
                }
1135
              },
1136
              "ssl": {
1137
                "description": "Optional SSL connection parameters to connect to the cluster. Passed directly to Node tls.connect.\nSee https://nodejs.org/dist/latest-v8.x/docs/api/tls.html#tls_tls_createsecurecontext_options",
1138
                "anyOf": [
1139
                  {
1140
                    "type": "object",
1141
                    "properties": {
1142
                      "ca": {
1143
                        "type": "array",
1144
                        "items": {
1145
                          "type": "string"
1146
                        }
1147
                      },
1148
                      "key": {
1149
                        "visibility": "secret",
1150
                        "type": "string"
1151
                      },
1152
                      "cert": {
1153
                        "type": "string"
1154
                      }
1155
                    },
1156
                    "required": ["ca", "cert", "key"]
1157
                  },
1158
                  {
1159
                    "type": "boolean"
1160
                  }
1161
                ]
1162
              },
1163
              "sasl": {
1164
                "description": "Optional SASL connection parameters.",
1165
                "type": "object",
1166
                "required": ["mechanism", "password", "username"],
1167
                "properties": {
1168
                  "mechanism": {
1169
                    "enum": ["plain", "scram-sha-256", "scram-sha-512"],
1170
                    "type": "string"
1171
                  },
1172
                  "username": {
1173
                    "type": "string"
1174
                  },
1175
                  "password": {
1176
                    "visibility": "secret",
1177
                    "type": "string"
1178
                  }
1179
                }
1180
              }
1181
            }
1182
          }
1183
        }
1184
      }
1185
    },
1186
    "rollbar": {
1187
      "description": "Configuration options for the rollbar-backend plugin",
1188
      "type": "object",
1189
      "required": ["accountToken"],
1190
      "properties": {
1191
        "accountToken": {
1192
          "description": "The authentication token for accessing the Rollbar API",
1193
          "type": "string"
1194
        },
1195
        "organization": {
1196
          "description": "The Rollbar organization name. This can be omitted by using the `rollbar.com/project-slug` annotation.",
1197
          "visibility": "frontend",
1198
          "type": "string"
1199
        }
1200
      }
1201
    },
1202
    "proxy": {
1203
      "description": "A list of forwarding-proxies. Each key is a route to match,\nbelow the prefix that the proxy plugin is mounted on. It must\nstart with a '/'.",
1204
      "type": "object",
1205
      "additionalProperties": {
1206
        "anyOf": [
1207
          {
1208
            "type": "object",
1209
            "properties": {
1210
              "target": {
1211
                "description": "Target of the proxy. Url string to be parsed with the url module.",
1212
                "type": "string"
1213
              },
1214
              "headers": {
1215
                "description": "Object with extra headers to be added to target requests.",
1216
                "type": "object",
1217
                "additionalProperties": {
1218
                  "type": "string"
1219
                }
1220
              },
1221
              "changeOrigin": {
1222
                "description": "Changes the origin of the host header to the target URL. Default: true.",
1223
                "type": "boolean"
1224
              },
1225
              "pathRewrite": {
1226
                "description": "Rewrite target's url path. Object-keys will be used as RegExp to match paths.\nIf pathRewrite is not specified, it is set to a single rewrite that removes the entire prefix and route.",
1227
                "type": "object",
1228
                "additionalProperties": {
1229
                  "type": "string"
1230
                }
1231
              },
1232
              "allowedMethods": {
1233
                "description": "Limit the forwarded HTTP methods, for example allowedMethods: ['GET'] to enforce read-only access.",
1234
                "type": "array",
1235
                "items": {
1236
                  "type": "string"
1237
                }
1238
              },
1239
              "allowedHeaders": {
1240
                "description": "Limit the forwarded HTTP methods. By default, only the headers that are considered safe for CORS\nand headers that are set by the proxy will be forwarded.",
1241
                "type": "array",
1242
                "items": {
1243
                  "type": "string"
1244
                }
1245
              }
1246
            },
1247
            "required": ["target"]
1248
          },
1249
          {
1250
            "type": "string"
1251
          }
1252
        ]
1253
      }
1254
    },
1255
    "scaffolder": {
1256
      "description": "Configuration options for the scaffolder plugin",
1257
      "type": "object",
1258
      "properties": {
1259
        "github": {
1260
          "type": "object",
1261
          "additionalProperties": {
1262
            "type": "string"
1263
          },
1264
          "properties": {
1265
            "visibility": {
1266
              "description": "The visibility to set on created repositories.",
1267
              "enum": ["internal", "private", "public"],
1268
              "type": "string"
1269
            }
1270
          }
1271
        },
1272
        "gitlab": {
1273
          "type": "object",
1274
          "required": ["api"],
1275
          "properties": {
1276
            "api": {
1277
              "type": "object",
1278
              "additionalProperties": {
1279
                "type": "string"
1280
              }
1281
            },
1282
            "visibility": {
1283
              "description": "The visibility to set on created repositories.",
1284
              "enum": ["internal", "private", "public"],
1285
              "type": "string"
1286
            }
1287
          }
1288
        },
1289
        "azure": {
1290
          "type": "object",
1291
          "required": ["api", "baseUrl"],
1292
          "properties": {
1293
            "baseUrl": {
1294
              "type": "string"
1295
            },
1296
            "api": {
1297
              "type": "object",
1298
              "additionalProperties": {
1299
                "type": "string"
1300
              }
1301
            }
1302
          }
1303
        },
1304
        "bitbucket": {
1305
          "type": "object",
1306
          "required": ["api"],
1307
          "properties": {
1308
            "api": {
1309
              "type": "object",
1310
              "additionalProperties": {
1311
                "type": "string"
1312
              }
1313
            },
1314
            "visibility": {
1315
              "description": "The visibility to set on created repositories.",
1316
              "enum": ["private", "public"],
1317
              "type": "string"
1318
            }
1319
          }
1320
        }
1321
      }
1322
    },
1323
    "sonarQube": {
1324
      "description": "Optional configurations for the SonarQube plugin",
1325
      "type": "object",
1326
      "required": ["baseUrl"],
1327
      "properties": {
1328
        "baseUrl": {
1329
          "description": "The base url of the sonarqube installation. Defaults to https://sonarcloud.io.",
1330
          "visibility": "frontend",
1331
          "type": "string"
1332
        }
1333
      }
1334
    },
1335
    "sentry": {
1336
      "description": "Configuration options for the sentry plugin",
1337
      "type": "object",
1338
      "required": ["organization"],
1339
      "properties": {
1340
        "organization": {
1341
          "description": "The 'organization' attribute",
1342
          "visibility": "frontend",
1343
          "type": "string"
1344
        }
1345
      }
1346
    },
1347
    "techdocs": {
1348
      "description": "Configuration options for the techdocs-backend plugin",
1349
      "type": "object",
1350
      "required": ["builder"],
1351
      "properties": {
1352
        "builder": {
1353
          "description": "Documentation building process depends on the builder attr",
1354
          "visibility": "frontend",
1355
          "enum": ["external", "local"],
1356
          "type": "string"
1357
        },
1358
        "generators": {
1359
          "description": "Techdocs generator information",
1360
          "type": "object",
1361
          "required": ["techdocs"],
1362
          "properties": {
1363
            "techdocs": {
1364
              "enum": ["docker", "local"],
1365
              "type": "string"
1366
            }
1367
          }
1368
        },
1369
        "publisher": {
1370
          "description": "Techdocs publisher information",
1371
          "anyOf": [
1372
            {
1373
              "type": "object",
1374
              "properties": {
1375
                "type": {
1376
                  "type": "string",
1377
                  "enum": ["local"]
1378
                }
1379
              },
1380
              "required": ["type"]
1381
            },
1382
            {
1383
              "type": "object",
1384
              "properties": {
1385
                "type": {
1386
                  "type": "string",
1387
                  "enum": ["awsS3"]
1388
                },
1389
                "awsS3": {
1390
                  "description": "Required when 'type' is set to awsS3",
1391
                  "type": "object",
1392
                  "required": ["bucketName"],
1393
                  "properties": {
1394
                    "credentials": {
1395
                      "description": "(Optional) Credentials used to access a storage bucket.\nIf not set, environment variables or aws config file will be used to authenticate.",
1396
                      "visibility": "secret",
1397
                      "type": "object",
1398
                      "required": ["accessKeyId", "secretAccessKey"],
1399
                      "properties": {
1400
                        "accessKeyId": {
1401
                          "description": "User access key id",
1402
                          "visibility": "secret",
1403
                          "type": "string"
1404
                        },
1405
                        "secretAccessKey": {
1406
                          "description": "User secret access key",
1407
                          "visibility": "secret",
1408
                          "type": "string"
1409
                        },
1410
                        "roleArn": {
1411
                          "description": "ARN of role to be assumed",
1412
                          "visibility": "backend",
1413
                          "type": "string"
1414
                        }
1415
                      }
1416
                    },
1417
                    "bucketName": {
1418
                      "description": "(Required) Cloud Storage Bucket Name",
1419
                      "visibility": "backend",
1420
                      "type": "string"
1421
                    },
1422
                    "region": {
1423
                      "description": "(Optional) AWS Region.\nIf not set, AWS_REGION environment variable or aws config file will be used.",
1424
                      "visibility": "secret",
1425
                      "type": "string"
1426
                    },
1427
                    "endpoint": {
1428
                      "description": "(Optional) AWS Endpoint.\nThe endpoint URI to send requests to. The default endpoint is built from the configured region.",
1429
                      "visibility": "secret",
1430
                      "type": "string"
1431
                    }
1432
                  }
1433
                }
1434
              },
1435
              "required": ["type"]
1436
            },
1437
            {
1438
              "type": "object",
1439
              "properties": {
1440
                "type": {
1441
                  "type": "string",
1442
                  "enum": ["openStackSwift"]
1443
                },
1444
                "openStackSwift": {
1445
                  "description": "Required when 'type' is set to openStackSwift",
1446
                  "type": "object",
1447
                  "required": [
1448
                    "authUrl",
1449
                    "containerName",
1450
                    "credentials",
1451
                    "domainId",
1452
                    "domainName",
1453
                    "keystoneAuthVersion",
1454
                    "region"
1455
                  ],
1456
                  "properties": {
1457
                    "credentials": {
1458
                      "description": "(Required) Credentials used to access a storage bucket.",
1459
                      "visibility": "secret",
1460
                      "type": "object",
1461
                      "required": ["password", "username"],
1462
                      "properties": {
1463
                        "username": {
1464
                          "description": "(Required) Root user name",
1465
                          "visibility": "secret",
1466
                          "type": "string"
1467
                        },
1468
                        "password": {
1469
                          "description": "(Required) Root user password",
1470
                          "visibility": "secret",
1471
                          "type": "string"
1472
                        }
1473
                      }
1474
                    },
1475
                    "containerName": {
1476
                      "description": "(Required) Cloud Storage Container Name",
1477
                      "visibility": "backend",
1478
                      "type": "string"
1479
                    },
1480
                    "authUrl": {
1481
                      "description": "(Required) Auth url sometimes OpenStack uses different port check your OpenStack apis.",
1482
                      "visibility": "backend",
1483
                      "type": "string"
1484
                    },
1485
                    "keystoneAuthVersion": {
1486
                      "description": "(Optional) Auth version\nIf not set, 'v2.0' will be used.",
1487
                      "visibility": "backend",
1488
                      "type": "string"
1489
                    },
1490
                    "domainId": {
1491
                      "description": "(Required) Domain Id",
1492
                      "visibility": "backend",
1493
                      "type": "string"
1494
                    },
1495
                    "domainName": {
1496
                      "description": "(Required) Domain Name",
1497
                      "visibility": "backend",
1498
                      "type": "string"
1499
                    },
1500
                    "region": {
1501
                      "description": "(Required) Region",
1502
                      "visibility": "backend",
1503
                      "type": "string"
1504
                    }
1505
                  }
1506
                }
1507
              },
1508
              "required": ["type"]
1509
            },
1510
            {
1511
              "type": "object",
1512
              "properties": {
1513
                "type": {
1514
                  "type": "string",
1515
                  "enum": ["azureBlobStorage"]
1516
                },
1517
                "azureBlobStorage": {
1518
                  "description": "Required when 'type' is set to azureBlobStorage",
1519
                  "type": "object",
1520
                  "required": ["containerName", "credentials"],
1521
                  "properties": {
1522
                    "credentials": {
1523
                      "description": "(Required) Credentials used to access a storage container.",
1524
                      "visibility": "secret",
1525
                      "type": "object",
1526
                      "required": ["accountName"],
1527
                      "properties": {
1528
                        "accountName": {
1529
                          "description": "Account access name",
1530
                          "visibility": "secret",
1531
                          "type": "string"
1532
                        },
1533
                        "accountKey": {
1534
                          "description": "(Optional) Account secret primary key\nIf not set, environment variables will be used to authenticate.",
1535
                          "visibility": "secret",
1536
                          "type": "string"
1537
                        }
1538
                      }
1539
                    },
1540
                    "containerName": {
1541
                      "description": "(Required) Cloud Storage Container Name",
1542
                      "visibility": "backend",
1543
                      "type": "string"
1544
                    }
1545
                  }
1546
                }
1547
              },
1548
              "required": ["type"]
1549
            },
1550
            {
1551
              "type": "object",
1552
              "properties": {
1553
                "type": {
1554
                  "type": "string",
1555
                  "enum": ["googleGcs"]
1556
                },
1557
                "googleGcs": {
1558
                  "description": "Required when 'type' is set to googleGcs",
1559
                  "type": "object",
1560
                  "required": ["bucketName"],
1561
                  "properties": {
1562
                    "bucketName": {
1563
                      "description": "(Required) Cloud Storage Bucket Name",
1564
                      "visibility": "backend",
1565
                      "type": "string"
1566
                    },
1567
                    "credentials": {
1568
                      "description": "(Optional) API key used to write to a storage bucket.\nIf not set, environment variables will be used to authenticate.",
1569
                      "visibility": "secret",
1570
                      "type": "string"
1571
                    }
1572
                  }
1573
                }
1574
              },
1575
              "required": ["type"]
1576
            }
1577
          ]
1578
        },
1579
        "requestUrl": {
1580
          "visibility": "frontend",
1581
          "type": "string"
1582
        },
1583
        "storageUrl": {
1584
          "type": "string"
1585
        }
1586
      }
1587
    },
1588
    "travisci": {
1589
      "description": "Configuration options for the travisci plugin",
1590
      "type": "object",
1591
      "properties": {
1592
        "baseUrl": {
1593
          "description": "The 'baseUrl' attribute. It should point to the address of the travis portal.\nIf not provided, frontend plugin will use 'https://travis-ci.com/'",
1594
          "visibility": "frontend",
1595
          "type": "string"
1596
        }
1597
      }
1598
    }
1599
  },
1600
  "description": "This is the schema describing the structure of the app-config.yaml configuration file."
1601
}
1602