backstage

1
/*
2
 * Copyright 2024 The Backstage Authors
3
 *
4
 * Licensed under the Apache License, Version 2.0 (the "License");
5
 * you may not use this file except in compliance with the License.
6
 * You may obtain a copy of the License at
7
 *
8
 *     http://www.apache.org/licenses/LICENSE-2.0
9
 *
10
 * Unless required by applicable law or agreed to in writing, software
11
 * distributed under the License is distributed on an "AS IS" BASIS,
12
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
 * See the License for the specific language governing permissions and
14
 * limitations under the License.
15
 */
16

17
import { HumanDuration } from '@backstage/types';
18

19
export interface Config {
20
  /** Configuration options for the tech-insights plugin */
21
  techInsights?: {
22
    /** Configuration options for fact retrievers */
23
    factRetrievers?: {
24
      /** Configuration for a fact retriever and its registration identified by its name. */
25
      [name: string]: {
26
        /** A cron expression to indicate when the fact retriever should be triggered. */
27
        cadence: string;
28
        /** Optional duration of the initial delay. */
29
        initialDelay?: HumanDuration;
30
        /** Optional lifecycle definition indicating the cleanup logic of facts when this retriever is run. */
31
        lifecycle?: { timeToLive: HumanDuration } | { maxItems: number };
32
        /** Optional duration to determine how long the fact retriever should be allowed to run, defaults to 5 minutes. */
33
        timeout?: HumanDuration;
34
      };
35
    };
36
  };
37
}
38