@openshift-assisted/types 2.50.0 → 2.51.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -111,6 +111,7 @@ export interface Cluster {
111
111
  /**
112
112
  * Indicates the type of this object. Will be 'Cluster' if this is a complete object,
113
113
  * 'AddHostsCluster' for cluster that add hosts to existing OCP cluster,
114
+ * 'DisconnectedCluster' for clusters with embedded ignition for offline installation,
114
115
  *
115
116
  */
116
117
  kind: 'Cluster' | 'AddHostsCluster' | 'DisconnectedCluster';
@@ -215,7 +216,8 @@ export interface Cluster {
215
216
  | 'installed'
216
217
  | 'adding-hosts'
217
218
  | 'cancelled'
218
- | 'installing-pending-user-action';
219
+ | 'installing-pending-user-action'
220
+ | 'unmonitored';
219
221
  /**
220
222
  * Additional information pertaining to the status of the OpenShift cluster.
221
223
  */
@@ -357,8 +359,15 @@ export interface Cluster {
357
359
  featureUsage?: string;
358
360
  /**
359
361
  * The desired network type used.
362
+ * - OVNKubernetes: Default CNI for OpenShift (recommended)
363
+ * - OpenShiftSDN: Legacy SDN (deprecated in newer versions)
364
+ * - CiscoACI: Cisco ACI CNI (requires custom manifests)
365
+ * - Cilium: Isovalent Cilium CNI (requires custom manifests)
366
+ * - Calico: Tigera Calico CNI (requires custom manifests)
367
+ * - None: No CNI - user must provide custom CNI manifests
368
+ *
360
369
  */
361
- networkType?: 'OpenShiftSDN' | 'OVNKubernetes';
370
+ networkType?: 'OpenShiftSDN' | 'OVNKubernetes' | 'CiscoACI' | 'Cilium' | 'Calico' | 'None';
362
371
  /**
363
372
  * Cluster networks that are associated with this cluster.
364
373
  */
@@ -505,8 +514,17 @@ export interface ClusterCreateParams {
505
514
  | 'all';
506
515
  /**
507
516
  * The desired network type used.
517
+ * - OVNKubernetes: Default CNI for OpenShift (recommended)
518
+ * - OpenShiftSDN: Legacy SDN (deprecated in newer versions)
519
+ * - CiscoACI: Cisco ACI CNI (requires custom manifests)
520
+ * - Cilium: Isovalent Cilium CNI (requires custom manifests)
521
+ * - Calico: Tigera Calico CNI (requires custom manifests)
522
+ * - None: No CNI - user must provide custom CNI manifests
523
+ * Note: Third-party CNIs (CiscoACI, Cilium, Calico, None) require uploading
524
+ * CNI manifests via the custom manifests API before installation.
525
+ *
508
526
  */
509
- networkType?: 'OpenShiftSDN' | 'OVNKubernetes';
527
+ networkType?: 'OpenShiftSDN' | 'OVNKubernetes' | 'CiscoACI' | 'Cilium' | 'Calico' | 'None';
510
528
  /**
511
529
  * Schedule workloads on masters
512
530
  */
@@ -666,6 +684,7 @@ export type ClusterValidationId =
666
684
  | 'mtv-requirements-satisfied'
667
685
  | 'osc-requirements-satisfied'
668
686
  | 'network-type-valid'
687
+ | 'custom-manifests-requirements-satisfied'
669
688
  | 'platform-requirements-satisfied'
670
689
  | 'node-feature-discovery-requirements-satisfied'
671
690
  | 'nvidia-gpu-requirements-satisfied'
@@ -823,6 +842,16 @@ export interface DhcpAllocationResponse {
823
842
  */
824
843
  ingressVipLease?: string;
825
844
  }
845
+ export interface DisconnectedClusterCreateParams {
846
+ /**
847
+ * Name of the OpenShift cluster.
848
+ */
849
+ name: string;
850
+ /**
851
+ * Version of the OpenShift cluster.
852
+ */
853
+ openshiftVersion: string;
854
+ }
826
855
  export interface Disk {
827
856
  /**
828
857
  * Determine the disk's unique identifier which is the by-id field if it exists and fallback to the by-path field otherwise
@@ -1053,9 +1082,16 @@ export interface Event {
1053
1082
  props?: string;
1054
1083
  }
1055
1084
  export type EventList = Event[];
1085
+ export interface Feature {
1086
+ 'feature-support-level-id': FeatureSupportLevelId;
1087
+ supportLevel: SupportLevel;
1088
+ reason?: IncompatibilityReason;
1089
+ incompatibilities: FeatureSupportLevelId[];
1090
+ }
1056
1091
  export type FeatureSupportLevelId =
1057
1092
  | 'SNO'
1058
1093
  | 'TNA'
1094
+ | 'TNF'
1059
1095
  | 'VIP_AUTO_ALLOC'
1060
1096
  | 'CUSTOM_MANIFEST'
1061
1097
  | 'SINGLE_NODE_EXPANSION'
@@ -1081,6 +1117,10 @@ export type FeatureSupportLevelId =
1081
1117
  | 'EXTERNAL_PLATFORM'
1082
1118
  | 'OVN_NETWORK_TYPE'
1083
1119
  | 'SDN_NETWORK_TYPE'
1120
+ | 'CILIUM_NETWORK_TYPE'
1121
+ | 'CALICO_NETWORK_TYPE'
1122
+ | 'CISCO_ACI_NETWORK_TYPE'
1123
+ | 'NONE_NETWORK_TYPE'
1084
1124
  | 'NODE_FEATURE_DISCOVERY'
1085
1125
  | 'NVIDIA_GPU'
1086
1126
  | 'PIPELINES'
@@ -1102,8 +1142,27 @@ export type FeatureSupportLevelId =
1102
1142
  | 'NUMA_RESOURCES'
1103
1143
  | 'OADP'
1104
1144
  | 'METALLB'
1145
+ | 'DUAL_STACK_PRIMARY_IPV6'
1105
1146
  | 'LOKI'
1106
1147
  | 'OPENSHIFT_LOGGING';
1148
+ export interface FencingCredentialsParams {
1149
+ /**
1150
+ * The URL of the host's BMC, for example https://bmc1.example.com.
1151
+ */
1152
+ address: string;
1153
+ /**
1154
+ * The username to connect to the host's BMC.
1155
+ */
1156
+ username: string;
1157
+ /**
1158
+ * The password to connect to the host's BMC.
1159
+ */
1160
+ password: string;
1161
+ /**
1162
+ * Whether to enable or disable certificate verification when connecting to the host's BMC.
1163
+ */
1164
+ certificateVerification?: 'Enabled' | 'Disabled';
1165
+ }
1107
1166
  /**
1108
1167
  * Cluster finalizing stage managed by controller
1109
1168
  */
@@ -1318,6 +1377,10 @@ export interface Host {
1318
1377
  * formatting.
1319
1378
  */
1320
1379
  skipFormattingDisks?: string;
1380
+ /**
1381
+ * The host's BMC credentials that will be used in TNF.
1382
+ */
1383
+ fencingCredentials?: string;
1321
1384
  }
1322
1385
  export interface HostCreateParams {
1323
1386
  hostId: string; // uuid
@@ -1525,6 +1588,10 @@ export interface HostRegistrationResponse {
1525
1588
  * formatting.
1526
1589
  */
1527
1590
  skipFormattingDisks?: string;
1591
+ /**
1592
+ * The host's BMC credentials that will be used in TNF.
1593
+ */
1594
+ fencingCredentials?: string;
1528
1595
  /**
1529
1596
  * Command for starting the next step runner
1530
1597
  */
@@ -1546,6 +1613,7 @@ export type HostStage =
1546
1613
  | 'Waiting for controller'
1547
1614
  | 'Installing'
1548
1615
  | 'Writing image to disk'
1616
+ | 'Copying registry data to disk'
1549
1617
  | 'Rebooting'
1550
1618
  | 'Waiting for ignition'
1551
1619
  | 'Configuring'
@@ -1603,6 +1671,10 @@ export interface HostUpdateParams {
1603
1671
  * Labels to be added to the corresponding node.
1604
1672
  */
1605
1673
  nodeLabels?: NodeLabelParams[];
1674
+ /**
1675
+ * The host's BMC credentials that will be used in TNF.
1676
+ */
1677
+ fencingCredentials?: FencingCredentialsParams;
1606
1678
  }
1607
1679
  export type HostValidationId =
1608
1680
  | 'connected'
@@ -1753,6 +1825,11 @@ export interface ImportClusterParams {
1753
1825
  */
1754
1826
  openshiftClusterId: string; // uuid
1755
1827
  }
1828
+ export type IncompatibilityReason =
1829
+ | 'cpuArchitecture'
1830
+ | 'platform'
1831
+ | 'openshiftVersion'
1832
+ | 'ociExternalIntegrationDisabled';
1756
1833
  export interface InfraEnv {
1757
1834
  /**
1758
1835
  * Indicates the type of this object.
@@ -1794,6 +1871,12 @@ export interface InfraEnv {
1794
1871
  * static network configuration string in the format expected by discovery ignition generation.
1795
1872
  */
1796
1873
  staticNetworkConfig?: string;
1874
+ /**
1875
+ * The IP address of the host that will act as the rendezvous (bootstrap) node for agent-based installations.
1876
+ * This is optional for disconnected-iso image type and specifies which host will run the assisted service
1877
+ * during the bootstrap phase. All other hosts will connect to this IP to coordinate the installation.
1878
+ */
1879
+ rendezvousIp?: string; // ^(?:$|(?:(?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])|(?:([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(:[0-9a-fA-F]{1,4}){1,6}|:(:[0-9a-fA-F]{1,4}){1,7}|:|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1?[0-9])?[0-9])\.){3}(25[0-5]|(2[0-4]|1?[0-9])?[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1?[0-9])?[0-9])\.){3}(25[0-5]|(2[0-4]|1?[0-9])?[0-9]))))$
1797
1880
  type: ImageType;
1798
1881
  /**
1799
1882
  * Json formatted string containing the user overrides for the initial ignition config.
@@ -1831,13 +1914,9 @@ export interface InfraEnv {
1831
1914
  */
1832
1915
  additionalTrustBundle?: string;
1833
1916
  /**
1834
- * The IP address that hosts will use to communicate with the bootstrap node during installation.
1835
- */
1836
- rendezvousIp?: string;
1837
- /**
1838
- * The type of network configuration for hosts: 'dhcp' for DHCP only, 'static' for static IP configuration.
1917
+ * The pull secret obtained from Red Hat OpenShift Cluster Manager at console.redhat.com/openshift/install/pull-secret.
1839
1918
  */
1840
- hostsNetworkConfigurationType?: 'dhcp' | 'static';
1919
+ pullSecret?: string;
1841
1920
  }
1842
1921
  export interface InfraEnvCreateParams {
1843
1922
  /**
@@ -1858,6 +1937,12 @@ export interface InfraEnvCreateParams {
1858
1937
  */
1859
1938
  pullSecret: string;
1860
1939
  staticNetworkConfig?: HostStaticNetworkConfig[];
1940
+ /**
1941
+ * The IP address of the host that will act as the rendezvous (bootstrap) node for agent-based installations.
1942
+ * This is optional for disconnected-iso image type and specifies which host will run the assisted service
1943
+ * during the bootstrap phase. All other hosts will connect to this IP to coordinate the installation.
1944
+ */
1945
+ rendezvousIp?: string; // ^(?:$|(?:(?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])|(?:([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(:[0-9a-fA-F]{1,4}){1,6}|:(:[0-9a-fA-F]{1,4}){1,7}|:|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1?[0-9])?[0-9])\.){3}(25[0-5]|(2[0-4]|1?[0-9])?[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1?[0-9])?[0-9])\.){3}(25[0-5]|(2[0-4]|1?[0-9])?[0-9]))))$
1861
1946
  imageType?: ImageType;
1862
1947
  /**
1863
1948
  * JSON formatted string containing the user overrides for the initial ignition config.
@@ -1883,14 +1968,6 @@ export interface InfraEnvCreateParams {
1883
1968
  * certificates in this bundle.
1884
1969
  */
1885
1970
  additionalTrustBundle?: string;
1886
- /**
1887
- * The IP address that hosts will use to communicate with the bootstrap node during installation.
1888
- */
1889
- rendezvousIp?: string;
1890
- /**
1891
- * The type of network configuration for hosts: 'dhcp' for DHCP only, 'static' for static IP configuration.
1892
- */
1893
- hostsNetworkConfigurationType?: 'dhcp' | 'static';
1894
1971
  }
1895
1972
  export type InfraEnvList = InfraEnv[];
1896
1973
  export interface InfraEnvUpdateParams {
@@ -1908,6 +1985,12 @@ export interface InfraEnvUpdateParams {
1908
1985
  */
1909
1986
  pullSecret?: string;
1910
1987
  staticNetworkConfig?: HostStaticNetworkConfig[];
1988
+ /**
1989
+ * The IP address of the host that will act as the rendezvous (bootstrap) node for agent-based installations.
1990
+ * This is optional for disconnected-iso image type and specifies which host will run the assisted service
1991
+ * during the bootstrap phase. All other hosts will connect to this IP to coordinate the installation.
1992
+ */
1993
+ rendezvousIp?: string; // ^(?:$|(?:(?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])|(?:([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(:[0-9a-fA-F]{1,4}){1,6}|:(:[0-9a-fA-F]{1,4}){1,7}|:|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1?[0-9])?[0-9])\.){3}(25[0-5]|(2[0-4]|1?[0-9])?[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1?[0-9])?[0-9])\.){3}(25[0-5]|(2[0-4]|1?[0-9])?[0-9]))))$
1911
1994
  imageType?: ImageType;
1912
1995
  /**
1913
1996
  * JSON formatted string containing the user overrides for the initial ignition config.
@@ -1922,14 +2005,6 @@ export interface InfraEnvUpdateParams {
1922
2005
  * Version of the OS image
1923
2006
  */
1924
2007
  openshiftVersion?: string;
1925
- /**
1926
- * The IP address that hosts will use to communicate with the bootstrap node during installation.
1927
- */
1928
- rendezvousIp?: string;
1929
- /**
1930
- * The type of network configuration for hosts: 'dhcp' for DHCP only, 'static' for static IP configuration.
1931
- */
1932
- hostsNetworkConfigurationType?: 'dhcp' | 'static';
1933
2008
  }
1934
2009
  export interface InfraError {
1935
2010
  /**
@@ -2200,7 +2275,7 @@ export type MacInterfaceMap = {
2200
2275
  /**
2201
2276
  * mac address present on the host
2202
2277
  */
2203
- macAddress?: string; // ^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$
2278
+ macAddress: string; // ^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$
2204
2279
  /**
2205
2280
  * nic name used in the yaml, which relates 1:1 to the mac address
2206
2281
  */
@@ -2364,6 +2439,17 @@ export interface OpenshiftVersion {
2364
2439
  export interface OpenshiftVersions {
2365
2440
  [name: string]: OpenshiftVersion;
2366
2441
  }
2442
+ export interface Operator {
2443
+ 'feature-support-level-id': FeatureSupportLevelId;
2444
+ supportLevel: SupportLevel;
2445
+ reason?: IncompatibilityReason;
2446
+ incompatibilities: FeatureSupportLevelId[];
2447
+ /**
2448
+ * Name of the operator
2449
+ */
2450
+ name: string;
2451
+ dependencies: FeatureSupportLevelId[];
2452
+ }
2367
2453
  export interface OperatorCreateParams {
2368
2454
  name?: string;
2369
2455
  /**
@@ -2871,8 +2957,17 @@ export interface V2ClusterUpdateParams {
2871
2957
  | 'all';
2872
2958
  /**
2873
2959
  * The desired network type used.
2960
+ * - OVNKubernetes: Default CNI for OpenShift (recommended)
2961
+ * - OpenShiftSDN: Legacy SDN (deprecated in newer versions)
2962
+ * - CiscoACI: Cisco ACI CNI (requires custom manifests)
2963
+ * - Cilium: Isovalent Cilium CNI (requires custom manifests)
2964
+ * - Calico: Tigera Calico CNI (requires custom manifests)
2965
+ * - None: No CNI - user must provide custom CNI manifests
2966
+ * Note: Third-party CNIs (CiscoACI, Cilium, Calico, None) require uploading
2967
+ * CNI manifests via the custom manifests API before installation.
2968
+ *
2874
2969
  */
2875
- networkType?: 'OpenShiftSDN' | 'OVNKubernetes';
2970
+ networkType?: 'OpenShiftSDN' | 'OVNKubernetes' | 'CiscoACI' | 'Cilium' | 'Calico' | 'None';
2876
2971
  /**
2877
2972
  * Schedule workloads on masters
2878
2973
  */
@@ -2929,6 +3024,13 @@ export interface V2OpenshiftVersions {
2929
3024
  version?: string;
2930
3025
  onlyLatest?: boolean;
2931
3026
  }
3027
+ export interface V2OperatorsBundles {
3028
+ openshiftVersion?: string;
3029
+ cpuArchitecture?: 'x86_64' | 'aarch64' | 'arm64' | 'ppc64le' | 's390x' | 'multi';
3030
+ platformType?: 'baremetal' | 'none' | 'nutanix' | 'vsphere' | 'external';
3031
+ externalPlatformName?: string;
3032
+ featureIds?: 'SNO'[];
3033
+ }
2932
3034
  export interface V2SupportLevelsArchitectures {
2933
3035
  openshiftVersion: string;
2934
3036
  }
@@ -2938,6 +3040,12 @@ export interface V2SupportLevelsFeatures {
2938
3040
  platformType?: 'baremetal' | 'none' | 'nutanix' | 'vsphere' | 'external';
2939
3041
  externalPlatformName?: string;
2940
3042
  }
3043
+ export interface V2SupportLevelsFeaturesDetailed {
3044
+ openshiftVersion: string;
3045
+ cpuArchitecture?: 'x86_64' | 'arm64' | 'ppc64le' | 's390x' | 'multi';
3046
+ platformType?: 'baremetal' | 'none' | 'nutanix' | 'vsphere' | 'external';
3047
+ externalPlatformName?: string;
3048
+ }
2941
3049
  /**
2942
3050
  * Single VIP verification result.
2943
3051
  */
package/package.json CHANGED
@@ -47,5 +47,5 @@
47
47
  "js-yaml": "^4.1.1",
48
48
  "sw2dts": "^2.6.3"
49
49
  },
50
- "version": "2.50.0"
50
+ "version": "2.51.0"
51
51
  }