backstage-soundcheck/config.d.ts at main · ZeroPathAI/backstage-soundcheck · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
import { HumanDuration } from '@backstage/types';
import { EntityFilter } from '@spotify/backstage-plugin-soundcheck-common';

export interface Config {
  soundcheck?: {
    collectors?: {
      zeropath?: {
        /**
         * Base URL for the Zeropath API, e.g. https://zeropath.com or https://customer.zeropath.com.
         *
         * @visibility backend
         */
        baseUrl: string;
        /**
         * Zeropath organization identifier used when listing repositories and fetching posture data.
         *
         * @visibility backend
         */
        organizationId: string;
        /**
         * Zeropath API token identifier.
         *
         * @visibility secret
         */
        tokenId: string;
        /**
         * Zeropath API token secret.
         *
         * @visibility secret
         */
        tokenSecret: string;
        /**
         * Annotation key that contains the repository slug on catalog entities.
         *
         * @default "github.com/project-slug"
         * @visibility backend
         */
        repositorySlugAnnotation?: string;
        /**
         * Optional namespace that should be prefixed to repository names returned by the Zeropath API
         * when they are missing an organization/user qualifier.
         *
         * @visibility backend
         */
        repositorySlugPrefix?: string;
        frequency?:
          | {
              cron: string;
            }
          | HumanDuration;
        initialDelay?: HumanDuration;
        batchSize?: number;
        filter?: EntityFilter;
        exclude?: EntityFilter;
        cache?:
          | {
              duration: HumanDuration;
            }
          | boolean;
        collects?: {
          frequency?:
            | {
                cron: string;
              }
            | HumanDuration;
          initialDelay?: HumanDuration;
          batchSize?: number;
          filter?: EntityFilter;
          exclude?: EntityFilter;
          cache?:
            | {
                duration: HumanDuration;
              }
            | boolean;
        }[];
      };
    };
  };
}