backstage

1
/*
2
 * Copyright 2020 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
export interface Config {
17
  kafka?: {
18
    /**
19
     * Client ID used to Backstage uses to identify when connecting to the Kafka cluster.
20
     */
21
    clientId: string;
22
    clusters: Array<{
23
      name: string;
24
      /**
25
       * List of brokers in the Kafka cluster to connect to.
26
       */
27
      brokers: string[];
28
      /**
29
       * Optional SSL connection parameters to connect to the cluster. Passed directly to Node tls.connect.
30
       * See https://nodejs.org/dist/latest-v8.x/docs/api/tls.html#tls_tls_createsecurecontext_options
31
       */
32
      ssl?:
33
        | {
34
            ca?: string[];
35
            /** @visibility secret */
36
            key?: string;
37
            cert?: string;
38
            rejectUnauthorized?: boolean;
39
          }
40
        | boolean;
41
      /**
42
       * Optional SASL connection parameters.
43
       */
44
      sasl?: {
45
        mechanism: 'plain' | 'scram-sha-256' | 'scram-sha-512';
46
        username: string;
47
        /** @visibility secret */
48
        password: string;
49
      };
50
    }>;
51
  };
52
}
53