config.d.ts

/*
 * Copyright Red Hat, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

export interface Config {
  /**
   * Configuration for the Orchestrator plugin.
   */
  orchestrator?: {
    /**
     * Set the content length limit for the requests.
     * Defaults to 102400 bytes (100kb)
     */
    contentLengthLimit?: string;
    sonataFlowService: {
      /**
       * Base URL of the Sonata Flow service.
       * Default: http://localhost
       */
      baseUrl?: string;
      /**
       * Port of the Sonata Flow service.
       * Default: no port
       */
      port?: string;
      /**
       * Whether to start the Sonata Flow service automatically.
       * If set to `false`, the plugin assumes that the SonataFlow service is already running on `baseUrl`:`port` (or just `baseUrl` if `port` is not set).
       * Default: false
       */
      autoStart?: boolean;
      /**
       * Workflows definitions source configurations
       */
      workflowsSource?:
        | {
            /**
             * Remote git repository where workflows definitions are stored
             */
            gitRepositoryUrl: string;
            /**
             * Path to map workflow resources to SonataFlow service.
             * Example: /home/orchestrator/workflows
             */
            localPath: string;
          }
        | {
            localPath: string;
          };

      /**
       * Container image name of the Sonata Flow service.
       * Default: quay.io/kiegroup/kogito-swf-devmode-nightly:main-2024-02-19
       */
      container?: string;
      /**
       * Persistance configuration of the Sonata Flow service.
       */
      persistance?: {
        /**
         * Path in the container image to store persistance data.
         * Default: /home/kogito/persistence
         */
        path?: string;
      };
    };
    dataIndexService: {
      /**
       * URL of the Data Index service.
       * Example: http://localhost:8099
       */
      url: string;
    };
    /**
     * Kafka configuration for event-triggered workflows (KafkaJS-style).
     * When present, the UI can show actions such as "Run as Event".
     * @visibility frontend
     */
    kafka?: {
      /**
       * Logical identifier of the Kafka client application.
       * @see https://kafka.js.org/docs/configuration#client-id
       * @visibility frontend
       */
      clientId: string;
      /**
       * Kafka broker addresses (`host:port`).
       * @visibility frontend
       */
      brokers: string[];
      /**
       * Log level for orchestrator Kafka services. Defaults to INFO (4); e.g. use 5 for DEBUG.
       * @see https://kafka.js.org/docs/configuration#logging
       * @visibility frontend
       */
      logLevel?: number;
    };
    /**
     * Configuration for the workflow log provider.
     * If configured, the "View Logs" button will be shown in the workflow instance results.
     * @visibility frontend
     */
    workflowLogProvider?: {
      /**
       * Loki log provider configuration.
       * @visibility frontend
       */
      loki?: {
        /**
         * Base URL of the Loki service.
         * Example: http://localhost:3100
         */
        baseUrl: string;
      };
      /**
       * Custom log stream selectors.
       */
      logStreamSelectors?: Array<{
        label: string;
        value: string;
      }>;
    };
    /**
     * UI configuration for the workflow instance page.
     * @visibility frontend
     */
    workflowInstancePage?: {
      /**
       * Controls card height behavior on the workflow instance page.
       * "fixed" keeps the current fixed-height cards with internal scrolling.
       * "content" lets cards expand to fit their content.
       * Default: fixed
       * @visibility frontend
       */
      cardHeightMode?: 'fixed' | 'content';
    };
  };
}