Merge branch 'master' into multi-cluster

2021-01-20 10:10:09 +02:00
parent 5c0fb3b844 5edf0ad930
commit c431aaeb99
8 changed files with 36 additions and 18349 deletions
@@ -15,12 +15,23 @@
 */
 export interface Config {
  kafka?: {
+    /**
+     * Client ID used to Backstage uses to identify when connecting to the Kafka cluster.
+     */
    clientId: string;
    clusters: {
      name: string;
+      /**
+       * List of brokers in the Kafka cluster to connect to.
+       */
      brokers: string[];
+      /**
+       * Optional SSL connection parameters to connect to the cluster. Passed directly to Node tls.connect.
+       * See https://nodejs.org/dist/latest-v8.x/docs/api/tls.html#tls_tls_createsecurecontext_options
+       */
      ssl?: {
        ca: string[];
+        /** @visibility secret */
        key: string;
        cert: string;
      };