@@ -195,19 +195,20 @@ type DockerMachineTemplate struct {
195
195
```
196
196
_ Note: the ` ResourceList ` and ` ResourceName ` referenced are from k8s.io/api/core/v1`_
197
197
198
- ` platform.NodeInfo ` is a struct that contains the architecture and operating system information of the node, to
199
- implement in the ` util ` package of the ` cluster-api ` project. The defined types and constants are exported for use by the
200
- cluster-api providers integrations.
198
+ ` platform.NodeInfo ` is a struct that contains the architecture and operating system information of the node, to implement
199
+ in the providers integration code.
201
200
Its definition would look like this:
202
201
203
202
``` go
204
203
package platform
205
204
206
- // Architecture represents the architecture of the node. Its underlying type is a string.
205
+ // Architecture represents the CPU architecture of the node. Its underlying type is a string.
206
+ // Its underlying type is a string and its value can be any of amd64, arm64, s390x, ppc64le.
207
+ // +kubebuilder:validation:Enum=amd64;arm64;s390x;ppc64le
207
208
// +enum
208
209
type Architecture string
209
210
210
- // Architecture constants defined for clarity and to be used by the cluster-api providers .
211
+ // Architecture constants defined for clarity.
211
212
const (
212
213
ArchitectureAmd64 Architecture = " amd64"
213
214
ArchitectureArm64 Architecture = " arm64"
@@ -217,11 +218,11 @@ const (
217
218
218
219
// NodeInfo contains information about the node's architecture and operating system.
219
220
type NodeInfo struct {
220
- // Architecture is the architecture of the node. It is a string that can be any of (amd64, arm64, s390x, ppc64le).
221
+ // architecture is the CPU architecture of the node.
222
+ // Its underlying type is a string and its value can be any of amd64, arm64, s390x, ppc64le.
221
223
// +optional
222
- // +kubebuilder:validation:Enum=amd64;arm64;s390x;ppc64le
223
224
Architecture Architecture ` json:"architecture,omitempty"`
224
- // OperatingSystem is a string representing the operating system of the node.
225
+ // operatingSystem is a string representing the operating system of the node.
225
226
// +optional
226
227
OperatingSystem string ` json:"operatingSystem,omitempty"`
227
228
}
0 commit comments