leftyer/rancher
1
0
Fork 0
mirror of https://gitee.com/rancher/rancher.git synced 2025-12-06 15:59:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

Address code review: Add CAPI contract documentation links

Browse Source 
Add explicit links to the CAPI infrastructure cluster and machine template
contracts in the documentation comments for InfrastructureRef and NodeConfig.

Co-authored-by: snasovich <85187633+snasovich@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2025-12-04 17:57:51 +00:00
parent 739363d6da
commit f94fd310c0
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
pkg/apis/provisioning.cattle.io/v1/cluster_types.go
View File

@@ -163,7 +163,8 @@ type RKEConfig struct {
// - AWSCluster (infrastructure.cluster.x-k8s.io/v1beta2) from CAPA
// - Other native CAPI infrastructure provider clusters
// The referenced infrastructure cluster must be pre-created in the same
// namespace and implement the CAPI infrastructure cluster contract.
// namespace and implement the CAPI infrastructure cluster contract
// (see https://cluster-api.sigs.k8s.io/developer/providers/contracts/infra-cluster).
// +nullable
// +optional
InfrastructureRef *corev1.ObjectReference `json:"infrastructureRef,omitempty"`
@@ -221,7 +222,8 @@ type RKEMachinePool struct {
// - AWSMachineTemplate (infrastructure.cluster.x-k8s.io/v1beta2) from CAPA
// - Other native CAPI infrastructure provider machine templates
// When using a native CAPI template, ensure the template is pre-created
// in the same namespace and implements the CAPI machine template contract.
// in the same namespace and implements the CAPI machine template contract
// (see https://cluster-api.sigs.k8s.io/developer/providers/contracts/infra-machine).
// +nullable
// +required
NodeConfig *corev1.ObjectReference `json:"machineConfigRef,omitempty"`