Skip to content

Commit 27fc5d9

Browse files
authored
Merge pull request #66679 from jab-rh/apis-414-final
Add latest OpenShift 4.14 APIs
2 parents 9aeeade + 534a398 commit 27fc5d9

File tree

37 files changed

+6944
-1879
lines changed

37 files changed

+6944
-1879
lines changed

rest_api/config_apis/dns-config-openshift-io-v1.adoc

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ Type::
7272
For example, given the base domain `openshift.example.com`, an API server DNS record may be created for `cluster-api.openshift.example.com`.
7373
Once set, this field cannot be changed.
7474

75+
| `platform`
76+
| `object`
77+
| platform holds configuration specific to the underlying infrastructure provider for DNS. When omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time.
78+
7579
| `privateZone`
7680
| `object`
7781
| privateZone is the location where all the DNS records that are only available internally to the cluster exist.
@@ -84,6 +88,57 @@ Type::
8488
If this field is nil, no public records should be created.
8589
Once set, this field cannot be changed.
8690

91+
|===
92+
=== .spec.platform
93+
Description::
94+
+
95+
--
96+
platform holds configuration specific to the underlying infrastructure provider for DNS. When omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time.
97+
--
98+
99+
Type::
100+
`object`
101+
102+
Required::
103+
- `type`
104+
105+
106+
107+
[cols="1,1,1",options="header"]
108+
|===
109+
| Property | Type | Description
110+
111+
| `aws`
112+
| `object`
113+
| aws contains DNS configuration specific to the Amazon Web Services cloud provider.
114+
115+
| `type`
116+
| `string`
117+
| type is the underlying infrastructure provider for the cluster. Allowed values: "", "AWS".
118+
Individual components may not support all platforms, and must handle unrecognized platforms with best-effort defaults.
119+
120+
|===
121+
=== .spec.platform.aws
122+
Description::
123+
+
124+
--
125+
aws contains DNS configuration specific to the Amazon Web Services cloud provider.
126+
--
127+
128+
Type::
129+
`object`
130+
131+
132+
133+
134+
[cols="1,1,1",options="header"]
135+
|===
136+
| Property | Type | Description
137+
138+
| `privateZoneIAMRole`
139+
| `string`
140+
| privateZoneIAMRole contains the ARN of an IAM role that should be assumed when performing operations on the cluster's private hosted zone specified in the cluster DNS config. When left empty, no role should be assumed.
141+
87142
|===
88143
=== .spec.privateZone
89144
Description::

rest_api/config_apis/infrastructure-config-openshift-io-v1.adoc

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -889,6 +889,10 @@ Type::
889889
| `string`
890890
| controlPlaneTopology expresses the expectations for operands that normally run on control nodes. The default is 'HighlyAvailable', which represents the behavior operators have in a "normal" cluster. The 'SingleReplica' mode will be used in single-node deployments and the operators should not configure the operand for highly-available operation The 'External' mode indicates that the control plane is hosted externally to the cluster and that its components are not visible within the cluster.
891891

892+
| `cpuPartitioning`
893+
| `string`
894+
| cpuPartitioning expresses if CPU partitioning is a currently enabled feature in the cluster. CPU Partitioning means that this cluster can support partitioning workloads to specific CPU Sets. Valid values are "None" and "AllNodes". When omitted, the default value is "None". The default value of "None" indicates that no nodes will be setup with CPU partitioning. The "AllNodes" value indicates that all nodes have been setup with CPU partitioning, and can then be further configured via the PerformanceProfile API.
895+
892896
| `etcdDiscoveryDomain`
893897
| `string`
894898
| etcdDiscoveryDomain is the domain used to fetch the SRV records for discovering etcd servers and clients. For more info: https://github.com/etcd-io/etcd/blob/329be66e8b3f9e2e6af83c123ff89297e49ebd15/Documentation/op-guide/clustering.md#dns-discovery deprecated: as of 4.7, this field is no longer set or honored. It will be removed in a future release.
@@ -1350,6 +1354,38 @@ Type::
13501354

13511355

13521356

1357+
[cols="1,1,1",options="header"]
1358+
|===
1359+
| Property | Type | Description
1360+
1361+
| `cloudControllerManager`
1362+
| `object`
1363+
| cloudControllerManager contains settings specific to the external Cloud Controller Manager (a.k.a. CCM or CPI). When omitted, new nodes will be not tainted and no extra initialization from the cloud controller manager is expected.
1364+
1365+
|===
1366+
=== .status.platformStatus.external.cloudControllerManager
1367+
Description::
1368+
+
1369+
--
1370+
cloudControllerManager contains settings specific to the external Cloud Controller Manager (a.k.a. CCM or CPI). When omitted, new nodes will be not tainted and no extra initialization from the cloud controller manager is expected.
1371+
--
1372+
1373+
Type::
1374+
`object`
1375+
1376+
1377+
1378+
1379+
[cols="1,1,1",options="header"]
1380+
|===
1381+
| Property | Type | Description
1382+
1383+
| `state`
1384+
| `string`
1385+
| state determines whether or not an external Cloud Controller Manager is expected to be installed within the cluster. https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/#running-cloud-controller-manager
1386+
Valid values are "External", "None" and omitted. When set to "External", new nodes will be tainted as uninitialized when created, preventing them from running workloads until they are initialized by the cloud controller manager. When omitted or set to "None", new nodes will be not tainted and no extra initialization from the cloud controller manager is expected.
1387+
1388+
|===
13531389
=== .status.platformStatus.gcp
13541390
Description::
13551391
+

rest_api/machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,22 @@ Required::
108108
| `string`
109109
| etcdDiscoveryDomain is deprecated, use Infra.Status.EtcdDiscoveryDomain instead
110110

111+
| `imageRegistryBundleData`
112+
| `array`
113+
| imageRegistryBundleData is Image Registry Data provided by the openshift-config-managed/image-registry-ca configmap.
114+
115+
| `imageRegistryBundleData[]`
116+
| `object`
117+
| ImageRegistryBundle contains the file and data for each CA
118+
119+
| `imageRegistryBundleUserData`
120+
| `array`
121+
| imageRegistryBundleUserData is Image Registry Data provided by the user. This is pulled from image.config.openshift.io/cluster which contains an additionalCA field.
122+
123+
| `imageRegistryBundleUserData[]`
124+
| `object`
125+
| ImageRegistryBundle contains the file and data for each CA
126+
111127
| `images`
112128
| `object (string)`
113129
| images is map of images that are used by the controller to render templates under ./templates/
@@ -116,6 +132,10 @@ Required::
116132
| `object`
117133
| infra holds the infrastructure details
118134

135+
| `internalRegistryPullSecret`
136+
| ``
137+
| internalRegistryPullSecret is the pull secret for the internal registry.
138+
119139
| `ipFamilies`
120140
| `string`
121141
| ipFamilies indicates the IP families in use by the cluster network
@@ -190,6 +210,84 @@ Required::
190210
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`]
191211
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
192212

213+
|===
214+
=== .spec.imageRegistryBundleData
215+
Description::
216+
+
217+
--
218+
imageRegistryBundleData is Image Registry Data provided by the openshift-config-managed/image-registry-ca configmap.
219+
--
220+
221+
Type::
222+
`array`
223+
224+
225+
226+
227+
=== .spec.imageRegistryBundleData[]
228+
Description::
229+
+
230+
--
231+
ImageRegistryBundle contains the file and data for each CA
232+
--
233+
234+
Type::
235+
`object`
236+
237+
238+
239+
240+
[cols="1,1,1",options="header"]
241+
|===
242+
| Property | Type | Description
243+
244+
| `data`
245+
| `string`
246+
| data of the CA
247+
248+
| `file`
249+
| `string`
250+
| file of the CA
251+
252+
|===
253+
=== .spec.imageRegistryBundleUserData
254+
Description::
255+
+
256+
--
257+
imageRegistryBundleUserData is Image Registry Data provided by the user. This is pulled from image.config.openshift.io/cluster which contains an additionalCA field.
258+
--
259+
260+
Type::
261+
`array`
262+
263+
264+
265+
266+
=== .spec.imageRegistryBundleUserData[]
267+
Description::
268+
+
269+
--
270+
ImageRegistryBundle contains the file and data for each CA
271+
--
272+
273+
Type::
274+
`object`
275+
276+
277+
278+
279+
[cols="1,1,1",options="header"]
280+
|===
281+
| Property | Type | Description
282+
283+
| `data`
284+
| `string`
285+
| data of the CA
286+
287+
| `file`
288+
| `string`
289+
| file of the CA
290+
193291
|===
194292
=== .spec.infra
195293
Description::
@@ -296,6 +394,14 @@ Type::
296394
| `object`
297395
| ControllerConfigStatusCondition contains condition information for ControllerConfigStatus
298396

397+
| `controllerCertificates`
398+
| `array`
399+
| controllerCertificates holds the information about the MCCs certificates.
400+
401+
| `controllerCertificates[]`
402+
| `object`
403+
| ControllerCertificate contains certificate information for ControllerConfigStatus
404+
299405
| `observedGeneration`
300406
| `integer`
301407
| observedGeneration represents the generation observed by the controller.
@@ -354,6 +460,49 @@ Required::
354460
| `string`
355461
| type specifies the state of the operator's reconciliation functionality.
356462

463+
|===
464+
=== .status.controllerCertificates
465+
Description::
466+
+
467+
--
468+
controllerCertificates holds the information about the MCCs certificates.
469+
--
470+
471+
Type::
472+
`array`
473+
474+
475+
476+
477+
=== .status.controllerCertificates[]
478+
Description::
479+
+
480+
--
481+
ControllerCertificate contains certificate information for ControllerConfigStatus
482+
--
483+
484+
Type::
485+
`object`
486+
487+
488+
489+
490+
[cols="1,1,1",options="header"]
491+
|===
492+
| Property | Type | Description
493+
494+
| `bundleFile`
495+
| `string`
496+
| the name of the bundle serving this cert.
497+
498+
| `signer`
499+
| `string`
500+
| signer contains the issuer of the cert
501+
502+
| `subject`
503+
| ``
504+
| the subject of the cert.
505+
357506
|===
358507

359508
== API endpoints

rest_api/machine_apis/controlplanemachineset-machine-openshift-io-v1.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -570,6 +570,8 @@ rootVolume contains settings that will be used by the OpenStack machine provider
570570
Type::
571571
`object`
572572

573+
Required::
574+
- `volumeType`
573575

574576

575577

@@ -583,7 +585,7 @@ Type::
583585

584586
| `volumeType`
585587
| `string`
586-
| volumeType specifies the type of the root volume that will be provisioned. If not specifified, the root volume will be created as the type in the machine template. The maximum length of a volume type name is 255 characters, as per the OpenStack limit.
588+
| volumeType specifies the type of the root volume that will be provisioned. The maximum length of a volume type name is 255 characters, as per the OpenStack limit.
587589

588590
|===
589591
=== .spec.template.machines_v1beta1_machine_openshift_io.metadata

rest_api/machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -366,6 +366,14 @@ Type::
366366
|===
367367
| Property | Type | Description
368368

369+
| `certExpirys`
370+
| `array`
371+
| The certificate expiry dates from the controller config
372+
373+
| `certExpirys[]`
374+
| `object`
375+
| the certExpiry contains specific information about a certificate stored in the controllerConfig.
376+
369377
| `conditions`
370378
| `array`
371379
| conditions represents the latest available observations of current state.
@@ -402,6 +410,45 @@ Type::
402410
| `integer`
403411
| updatedMachineCount represents the total number of machines targeted by the pool that have the CurrentMachineConfig as their config.
404412

413+
|===
414+
=== .status.certExpirys
415+
Description::
416+
+
417+
--
418+
The certificate expiry dates from the controller config
419+
--
420+
421+
Type::
422+
`array`
423+
424+
425+
426+
427+
=== .status.certExpirys[]
428+
Description::
429+
+
430+
--
431+
the certExpiry contains specific information about a certificate stored in the controllerConfig.
432+
--
433+
434+
Type::
435+
`object`
436+
437+
438+
439+
440+
[cols="1,1,1",options="header"]
441+
|===
442+
| Property | Type | Description
443+
444+
| `bundle`
445+
| `string`
446+
| the bundle for which the expiry applies
447+
448+
| `subject`
449+
| `string`
450+
| the subject of the cert
451+
405452
|===
406453
=== .status.conditions
407454
Description::

0 commit comments

Comments
 (0)