Improve migration doc & godocs

Author: sbueringer

api/controlplane/kubeadm/v1beta2/kubeadmcontrolplanetemplate_types.go

@@ -36,6 +36,7 @@ type KubeadmControlPlaneTemplateSpec struct {
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Time duration since creation of KubeadmControlPlaneTemplate"
 
 // KubeadmControlPlaneTemplate is the Schema for the kubeadmcontrolplanetemplates API.
+// NOTE: This CRD can only be used if the ClusterTopology feature gate is enabled.
 type KubeadmControlPlaneTemplate struct {
 	metav1.TypeMeta `json:",inline"`
 	// metadata is the standard object's metadata.

api/core/v1beta2/clusterclass_types.go

@@ -71,6 +71,7 @@ const (
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Time duration since creation of ClusterClass"
 
 // ClusterClass is a template which can be used to create managed topologies.
+// NOTE: This CRD can only be used if the ClusterTopology feature gate is enabled.
 type ClusterClass struct {
 	metav1.TypeMeta `json:",inline"`
 	// metadata is the standard object's metadata.

api/core/v1beta2/machinepool_types.go

@@ -333,6 +333,7 @@ func (m *MachinePoolStatus) GetTypedPhase() MachinePoolPhase {
 // +k8s:conversion-gen=false
 
 // MachinePool is the Schema for the machinepools API.
+// NOTE: This CRD can only be used if the MachinePool feature gate is enabled.
 type MachinePool struct {
 	metav1.TypeMeta `json:",inline"`
 	// metadata is the standard object's metadata.

api/core/v1beta2/zz_generated.openapi.go

@@ -15,6 +15,8 @@ limitations under the License.
 */
 
 // Package v1alpha1 contains the v1alpha1 RuntimeHooks.
+//
+// Note: This package contains the API of Runtime Hooks. It does not contain any Go types for CRDs.
 // +kubebuilder:object:generate=true
 // +k8s:openapi-gen=true
 package v1alpha1

api/runtime/hooks/v1alpha1/doc.go

@@ -220,6 +220,7 @@ const (
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Time duration since creation of ExtensionConfig"
 
 // ExtensionConfig is the Schema for the ExtensionConfig API.
+// NOTE: This CRD can only be used if the RuntimeSDK feature gate is enabled.
 type ExtensionConfig struct {
 	metav1.TypeMeta `json:",inline"`
 	// metadata is the standard object's metadata.