backstage-plugins/plugins/vcf-automation-backend/config.d.ts at main · TeraSky-OSS/backstage-plugins · 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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/**
 * Configuration schema for the VCF Automation backend plugin.
 *
 * This plugin provides API endpoints for managing VCF Automation resources.
 */
export interface Config {
  /**
   * VCF Automation configuration
   */
  vcfAutomation?: {
    /**
     * Enable or disable the plugin
     * @visibility frontend
     */
    enabled?: boolean;
    /**
     * VCF Automation base URL (legacy single instance)
     */
    baseUrl?: string;
    /**
     * Instance name (legacy single instance)
     */
    name?: string;
    /**
     * VCF Automation major version (8 or 9)
     */
    majorVersion?: number;
    /**
     * Organization name
     */
    orgName?: string;
    /**
     * Organization type (vm-apps or all-apps)
     */
    organizationType?: 'vm-apps' | 'all-apps';
    /**
     * Authentication configuration (legacy single instance)
     */
    authentication?: {
      /**
       * Username for API access
       */
      username: string;
      /**
       * Password for API access
       * @visibility secret
       */
      password: string;
      /**
       * Domain for authentication
       */
      domain: string;
    };
    /**
     * Multiple VCF Automation instances configuration
     */
    instances?: Array<{
      /**
       * VCF Automation base URL
       */
      baseUrl: string;
      /**
       * Instance name for identification
       */
      name?: string;
      /**
       * VCF Automation major version (8 or 9)
       */
      majorVersion?: number;
      /**
       * Organization name
       */
      orgName?: string;
      /**
       * Organization type (vm-apps or all-apps)
       */
      organizationType?: 'vm-apps' | 'all-apps';
      /**
       * Authentication configuration
       */
      authentication: {
        /**
         * Username for API access
         */
        username: string;
        /**
         * Password for API access
         * @visibility secret
         */
        password: string;
        /**
         * Domain for authentication
         */
        domain?: string;
      };
    }>;
  };
}