Skip to content

🌱 Standardize api import aliases #5830

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
k8s-ci-robot merged 1 commit into from
Dec 10, 2021
Merged

🌱 Standardize api import aliases #5830

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .golangci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,55 @@ linters-settings:
# Controller Runtime
- pkg: sigs.k8s.io/controller-runtime
alias: ctrl
# CABPK
- pkg: sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1alpha3
alias: bootstrapv1alpha3
- pkg: sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1alpha4
alias: bootstrapv1alpha4
- pkg: sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1beta1
alias: bootstrapv1
Copy link
Copy Markdown
Member

@enxebre enxebre Dec 9, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we reserve v1 for real v1 and let the beta imports be consistent e.g bootstrapv1beta1?

Copy link
Copy Markdown
Member Author

@sbueringer sbueringer Dec 9, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm good question. Up until know we used v1 everywhere (and with everywhere I also mean in a bunch of providers :))

Copy link
Copy Markdown
Member Author

@sbueringer sbueringer Dec 9, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the main idea behind that is that when we upgrade the version only the import changes and not huge parts of the codebase

Copy link
Copy Markdown
Member

@fabriziopandini fabriziopandini Dec 9, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes. this is for avoiding churn in the codebase at each release and it kind of makes sense if you read it as the last version in the v1 series (or at least that was the original idea)

# KCP
- pkg: sigs.k8s.io/cluster-api/controlplane/kubeadm/api/v1alpha3
alias: controlplanev1alpha3
- pkg: sigs.k8s.io/cluster-api/controlplane/kubeadm/api/v1alpha4
alias: controlplanev1alpha4
- pkg: sigs.k8s.io/cluster-api/controlplane/kubeadm/api/v1beta1
alias: controlplanev1
# CAPI
- pkg: sigs.k8s.io/cluster-api/api/v1alpha3
alias: clusterv1alpha3
- pkg: sigs.k8s.io/cluster-api/api/v1alpha4
alias: clusterv1alpha4
- pkg: sigs.k8s.io/cluster-api/api/v1beta1
alias: clusterv1
# CAPI exp
- pkg: sigs.k8s.io/cluster-api/exp/api/v1alpha3
alias: expv1alpha3
Copy link
Copy Markdown
Member

@enxebre enxebre Dec 10, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: clusterexp*?

Copy link
Copy Markdown
Member Author

@sbueringer sbueringer Dec 10, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be fine for me. I just used the currently most commonly used alias. But I'm not sure which one would be better (same would probably apply to addonsv1 => clusteraddonsv1, too)

On one side having the cluster prefix would be more consistent with infraexp on the other side it's ab it longer

@fabriziopandini WDYT?

Copy link
Copy Markdown
Member

@fabriziopandini fabriziopandini Dec 10, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

using cluster prefix seems kind of redundant to me, but no strong opinions

Copy link
Copy Markdown
Member Author

@sbueringer sbueringer Dec 10, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar here.

- pkg: sigs.k8s.io/cluster-api/exp/api/v1alpha4
alias: expv1alpha4
- pkg: sigs.k8s.io/cluster-api/exp/api/v1beta1
alias: expv1
# CAPI exp addons
- pkg: sigs.k8s.io/cluster-api/exp/addons/api/v1alpha3
alias: addonsv1alpha3
- pkg: sigs.k8s.io/cluster-api/exp/addons/api/v1alpha4
alias: addonsv1alpha4
- pkg: sigs.k8s.io/cluster-api/exp/addons/api/v1beta1
alias: addonsv1
# CAPD
- pkg: sigs.k8s.io/cluster-api/test/infrastructure/docker/api/v1alpha3
alias: infrav1alpha3
- pkg: sigs.k8s.io/cluster-api/test/infrastructure/docker/api/v1alpha4
alias: infrav1alpha4
- pkg: sigs.k8s.io/cluster-api/test/infrastructure/docker/api/v1beta1
alias: infrav1
# CAPD exp
- pkg: sigs.k8s.io/cluster-api/test/infrastructure/docker/exp/api/v1alpha3
alias: infraexpv1alpha3
- pkg: sigs.k8s.io/cluster-api/test/infrastructure/docker/exp/api/v1alpha4
alias: infraexpv1alpha4
- pkg: sigs.k8s.io/cluster-api/test/infrastructure/docker/exp/api/v1beta1
alias: infraexpv1
nolintlint:
allow-unused: false
allow-leading-space: false
Expand Down
80 changes: 40 additions & 40 deletions api/v1alpha3/conversion.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ import (
apiconversion "k8s.io/apimachinery/pkg/conversion"
"sigs.k8s.io/controller-runtime/pkg/conversion"

"sigs.k8s.io/cluster-api/api/v1beta1"
clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
"sigs.k8s.io/cluster-api/util/conditions"
utilconversion "sigs.k8s.io/cluster-api/util/conversion"
)

func (src *Cluster) ConvertTo(dstRaw conversion.Hub) error {
dst := dstRaw.(*v1beta1.Cluster)
dst := dstRaw.(*clusterv1.Cluster)

if err := Convert_v1alpha3_Cluster_To_v1beta1_Cluster(src, dst, nil); err != nil {
return err
Expand All @@ -36,11 +36,11 @@ func (src *Cluster) ConvertTo(dstRaw conversion.Hub) error {
// will be "now". See https://github.com/kubernetes-sigs/cluster-api/issues/3798#issuecomment-708619826 for more
// discussion.
if src.Status.ControlPlaneInitialized {
conditions.MarkTrue(dst, v1beta1.ControlPlaneInitializedCondition)
conditions.MarkTrue(dst, clusterv1.ControlPlaneInitializedCondition)
}

// Manually restore data.
restored := &v1beta1.Cluster{}
restored := &clusterv1.Cluster{}
if ok, err := utilconversion.UnmarshalData(src, restored); err != nil || !ok {
return err
}
Expand All @@ -53,14 +53,14 @@ func (src *Cluster) ConvertTo(dstRaw conversion.Hub) error {
}

func (dst *Cluster) ConvertFrom(srcRaw conversion.Hub) error {
src := srcRaw.(*v1beta1.Cluster)
src := srcRaw.(*clusterv1.Cluster)

if err := Convert_v1beta1_Cluster_To_v1alpha3_Cluster(src, dst, nil); err != nil {
return err
}

// Set the v1alpha3 boolean status field if the v1alpha4 condition was true
if conditions.IsTrue(src, v1beta1.ControlPlaneInitializedCondition) {
if conditions.IsTrue(src, clusterv1.ControlPlaneInitializedCondition) {
dst.Status.ControlPlaneInitialized = true
}

Expand All @@ -73,26 +73,26 @@ func (dst *Cluster) ConvertFrom(srcRaw conversion.Hub) error {
}

func (src *ClusterList) ConvertTo(dstRaw conversion.Hub) error {
dst := dstRaw.(*v1beta1.ClusterList)
dst := dstRaw.(*clusterv1.ClusterList)

return Convert_v1alpha3_ClusterList_To_v1beta1_ClusterList(src, dst, nil)
}

func (dst *ClusterList) ConvertFrom(srcRaw conversion.Hub) error {
src := srcRaw.(*v1beta1.ClusterList)
src := srcRaw.(*clusterv1.ClusterList)

return Convert_v1beta1_ClusterList_To_v1alpha3_ClusterList(src, dst, nil)
}

func (src *Machine) ConvertTo(dstRaw conversion.Hub) error {
dst := dstRaw.(*v1beta1.Machine)
dst := dstRaw.(*clusterv1.Machine)

if err := Convert_v1alpha3_Machine_To_v1beta1_Machine(src, dst, nil); err != nil {
return err
}

// Manually restore data.
restored := &v1beta1.Machine{}
restored := &clusterv1.Machine{}
if ok, err := utilconversion.UnmarshalData(src, restored); err != nil || !ok {
return err
}
Expand All @@ -102,7 +102,7 @@ func (src *Machine) ConvertTo(dstRaw conversion.Hub) error {
}

func (dst *Machine) ConvertFrom(srcRaw conversion.Hub) error {
src := srcRaw.(*v1beta1.Machine)
src := srcRaw.(*clusterv1.Machine)

if err := Convert_v1beta1_Machine_To_v1alpha3_Machine(src, dst, nil); err != nil {
return err
Expand All @@ -117,25 +117,25 @@ func (dst *Machine) ConvertFrom(srcRaw conversion.Hub) error {
}

func (src *MachineList) ConvertTo(dstRaw conversion.Hub) error {
dst := dstRaw.(*v1beta1.MachineList)
dst := dstRaw.(*clusterv1.MachineList)

return Convert_v1alpha3_MachineList_To_v1beta1_MachineList(src, dst, nil)
}

func (dst *MachineList) ConvertFrom(srcRaw conversion.Hub) error {
src := srcRaw.(*v1beta1.MachineList)
src := srcRaw.(*clusterv1.MachineList)

return Convert_v1beta1_MachineList_To_v1alpha3_MachineList(src, dst, nil)
}

func (src *MachineSet) ConvertTo(dstRaw conversion.Hub) error {
dst := dstRaw.(*v1beta1.MachineSet)
dst := dstRaw.(*clusterv1.MachineSet)

if err := Convert_v1alpha3_MachineSet_To_v1beta1_MachineSet(src, dst, nil); err != nil {
return err
}
// Manually restore data.
restored := &v1beta1.MachineSet{}
restored := &clusterv1.MachineSet{}
if ok, err := utilconversion.UnmarshalData(src, restored); err != nil || !ok {
return err
}
Expand All @@ -144,7 +144,7 @@ func (src *MachineSet) ConvertTo(dstRaw conversion.Hub) error {
}

func (dst *MachineSet) ConvertFrom(srcRaw conversion.Hub) error {
src := srcRaw.(*v1beta1.MachineSet)
src := srcRaw.(*clusterv1.MachineSet)

if err := Convert_v1beta1_MachineSet_To_v1alpha3_MachineSet(src, dst, nil); err != nil {
return err
Expand All @@ -158,36 +158,36 @@ func (dst *MachineSet) ConvertFrom(srcRaw conversion.Hub) error {
}

func (src *MachineSetList) ConvertTo(dstRaw conversion.Hub) error {
dst := dstRaw.(*v1beta1.MachineSetList)
dst := dstRaw.(*clusterv1.MachineSetList)

return Convert_v1alpha3_MachineSetList_To_v1beta1_MachineSetList(src, dst, nil)
}

func (dst *MachineSetList) ConvertFrom(srcRaw conversion.Hub) error {
src := srcRaw.(*v1beta1.MachineSetList)
src := srcRaw.(*clusterv1.MachineSetList)

return Convert_v1beta1_MachineSetList_To_v1alpha3_MachineSetList(src, dst, nil)
}

func (src *MachineDeployment) ConvertTo(dstRaw conversion.Hub) error {
dst := dstRaw.(*v1beta1.MachineDeployment)
dst := dstRaw.(*clusterv1.MachineDeployment)

if err := Convert_v1alpha3_MachineDeployment_To_v1beta1_MachineDeployment(src, dst, nil); err != nil {
return err
}

// Manually restore data.
restored := &v1beta1.MachineDeployment{}
restored := &clusterv1.MachineDeployment{}
if ok, err := utilconversion.UnmarshalData(src, restored); err != nil || !ok {
return err
}

if restored.Spec.Strategy != nil && restored.Spec.Strategy.RollingUpdate != nil {
if dst.Spec.Strategy == nil {
dst.Spec.Strategy = &v1beta1.MachineDeploymentStrategy{}
dst.Spec.Strategy = &clusterv1.MachineDeploymentStrategy{}
}
if dst.Spec.Strategy.RollingUpdate == nil {
dst.Spec.Strategy.RollingUpdate = &v1beta1.MachineRollingUpdateDeployment{}
dst.Spec.Strategy.RollingUpdate = &clusterv1.MachineRollingUpdateDeployment{}
}
dst.Spec.Strategy.RollingUpdate.DeletePolicy = restored.Spec.Strategy.RollingUpdate.DeletePolicy
}
Expand All @@ -197,7 +197,7 @@ func (src *MachineDeployment) ConvertTo(dstRaw conversion.Hub) error {
}

func (dst *MachineDeployment) ConvertFrom(srcRaw conversion.Hub) error {
src := srcRaw.(*v1beta1.MachineDeployment)
src := srcRaw.(*clusterv1.MachineDeployment)

if err := Convert_v1beta1_MachineDeployment_To_v1alpha3_MachineDeployment(src, dst, nil); err != nil {
return err
Expand All @@ -212,26 +212,26 @@ func (dst *MachineDeployment) ConvertFrom(srcRaw conversion.Hub) error {
}

func (src *MachineDeploymentList) ConvertTo(dstRaw conversion.Hub) error {
dst := dstRaw.(*v1beta1.MachineDeploymentList)
dst := dstRaw.(*clusterv1.MachineDeploymentList)

return Convert_v1alpha3_MachineDeploymentList_To_v1beta1_MachineDeploymentList(src, dst, nil)
}

func (dst *MachineDeploymentList) ConvertFrom(srcRaw conversion.Hub) error {
src := srcRaw.(*v1beta1.MachineDeploymentList)
src := srcRaw.(*clusterv1.MachineDeploymentList)

return Convert_v1beta1_MachineDeploymentList_To_v1alpha3_MachineDeploymentList(src, dst, nil)
}

func (src *MachineHealthCheck) ConvertTo(dstRaw conversion.Hub) error {
dst := dstRaw.(*v1beta1.MachineHealthCheck)
dst := dstRaw.(*clusterv1.MachineHealthCheck)

if err := Convert_v1alpha3_MachineHealthCheck_To_v1beta1_MachineHealthCheck(src, dst, nil); err != nil {
return err
}

// Manually restore data.
restored := &v1beta1.MachineHealthCheck{}
restored := &clusterv1.MachineHealthCheck{}
if ok, err := utilconversion.UnmarshalData(src, restored); err != nil || !ok {
return err
}
Expand All @@ -244,7 +244,7 @@ func (src *MachineHealthCheck) ConvertTo(dstRaw conversion.Hub) error {
}

func (dst *MachineHealthCheck) ConvertFrom(srcRaw conversion.Hub) error {
src := srcRaw.(*v1beta1.MachineHealthCheck)
src := srcRaw.(*clusterv1.MachineHealthCheck)

if err := Convert_v1beta1_MachineHealthCheck_To_v1alpha3_MachineHealthCheck(src, dst, nil); err != nil {
return err
Expand All @@ -259,57 +259,57 @@ func (dst *MachineHealthCheck) ConvertFrom(srcRaw conversion.Hub) error {
}

func (src *MachineHealthCheckList) ConvertTo(dstRaw conversion.Hub) error {
dst := dstRaw.(*v1beta1.MachineHealthCheckList)
dst := dstRaw.(*clusterv1.MachineHealthCheckList)

return Convert_v1alpha3_MachineHealthCheckList_To_v1beta1_MachineHealthCheckList(src, dst, nil)
}

func (dst *MachineHealthCheckList) ConvertFrom(srcRaw conversion.Hub) error {
src := srcRaw.(*v1beta1.MachineHealthCheckList)
src := srcRaw.(*clusterv1.MachineHealthCheckList)

return Convert_v1beta1_MachineHealthCheckList_To_v1alpha3_MachineHealthCheckList(src, dst, nil)
}

func Convert_v1beta1_MachineSetStatus_To_v1alpha3_MachineSetStatus(in *v1beta1.MachineSetStatus, out *MachineSetStatus, s apiconversion.Scope) error {
func Convert_v1beta1_MachineSetStatus_To_v1alpha3_MachineSetStatus(in *clusterv1.MachineSetStatus, out *MachineSetStatus, s apiconversion.Scope) error {
// Status.Conditions was introduced in v1alpha4, thus requiring a custom conversion function; the values is going to be preserved in an annotation thus allowing roundtrip without loosing informations
return autoConvert_v1beta1_MachineSetStatus_To_v1alpha3_MachineSetStatus(in, out, nil)
}

func Convert_v1beta1_ClusterSpec_To_v1alpha3_ClusterSpec(in *v1beta1.ClusterSpec, out *ClusterSpec, s apiconversion.Scope) error {
func Convert_v1beta1_ClusterSpec_To_v1alpha3_ClusterSpec(in *clusterv1.ClusterSpec, out *ClusterSpec, s apiconversion.Scope) error {
// NOTE: custom conversion func is required because spec.Topology does not exists in v1alpha3
return autoConvert_v1beta1_ClusterSpec_To_v1alpha3_ClusterSpec(in, out, s)
}

func Convert_v1alpha3_Bootstrap_To_v1beta1_Bootstrap(in *Bootstrap, out *v1beta1.Bootstrap, s apiconversion.Scope) error {
func Convert_v1alpha3_Bootstrap_To_v1beta1_Bootstrap(in *Bootstrap, out *clusterv1.Bootstrap, s apiconversion.Scope) error {
return autoConvert_v1alpha3_Bootstrap_To_v1beta1_Bootstrap(in, out, s)
}

func Convert_v1beta1_MachineRollingUpdateDeployment_To_v1alpha3_MachineRollingUpdateDeployment(in *v1beta1.MachineRollingUpdateDeployment, out *MachineRollingUpdateDeployment, s apiconversion.Scope) error {
func Convert_v1beta1_MachineRollingUpdateDeployment_To_v1alpha3_MachineRollingUpdateDeployment(in *clusterv1.MachineRollingUpdateDeployment, out *MachineRollingUpdateDeployment, s apiconversion.Scope) error {
return autoConvert_v1beta1_MachineRollingUpdateDeployment_To_v1alpha3_MachineRollingUpdateDeployment(in, out, s)
}

func Convert_v1beta1_MachineHealthCheckSpec_To_v1alpha3_MachineHealthCheckSpec(in *v1beta1.MachineHealthCheckSpec, out *MachineHealthCheckSpec, s apiconversion.Scope) error {
func Convert_v1beta1_MachineHealthCheckSpec_To_v1alpha3_MachineHealthCheckSpec(in *clusterv1.MachineHealthCheckSpec, out *MachineHealthCheckSpec, s apiconversion.Scope) error {
return autoConvert_v1beta1_MachineHealthCheckSpec_To_v1alpha3_MachineHealthCheckSpec(in, out, s)
}

func Convert_v1alpha3_ClusterStatus_To_v1beta1_ClusterStatus(in *ClusterStatus, out *v1beta1.ClusterStatus, s apiconversion.Scope) error {
func Convert_v1alpha3_ClusterStatus_To_v1beta1_ClusterStatus(in *ClusterStatus, out *clusterv1.ClusterStatus, s apiconversion.Scope) error {
return autoConvert_v1alpha3_ClusterStatus_To_v1beta1_ClusterStatus(in, out, s)
}

func Convert_v1alpha3_ObjectMeta_To_v1beta1_ObjectMeta(in *ObjectMeta, out *v1beta1.ObjectMeta, s apiconversion.Scope) error {
func Convert_v1alpha3_ObjectMeta_To_v1beta1_ObjectMeta(in *ObjectMeta, out *clusterv1.ObjectMeta, s apiconversion.Scope) error {
return autoConvert_v1alpha3_ObjectMeta_To_v1beta1_ObjectMeta(in, out, s)
}

func Convert_v1beta1_MachineStatus_To_v1alpha3_MachineStatus(in *v1beta1.MachineStatus, out *MachineStatus, s apiconversion.Scope) error {
func Convert_v1beta1_MachineStatus_To_v1alpha3_MachineStatus(in *clusterv1.MachineStatus, out *MachineStatus, s apiconversion.Scope) error {
return autoConvert_v1beta1_MachineStatus_To_v1alpha3_MachineStatus(in, out, s)
}

func Convert_v1beta1_MachineDeploymentStatus_To_v1alpha3_MachineDeploymentStatus(in *v1beta1.MachineDeploymentStatus, out *MachineDeploymentStatus, s apiconversion.Scope) error {
func Convert_v1beta1_MachineDeploymentStatus_To_v1alpha3_MachineDeploymentStatus(in *clusterv1.MachineDeploymentStatus, out *MachineDeploymentStatus, s apiconversion.Scope) error {
// Status.Conditions was introduced in v1alpha4, thus requiring a custom conversion function; the values is going to be preserved in an annotation thus allowing roundtrip without loosing informations
return autoConvert_v1beta1_MachineDeploymentStatus_To_v1alpha3_MachineDeploymentStatus(in, out, s)
}

func Convert_v1alpha3_MachineStatus_To_v1beta1_MachineStatus(in *MachineStatus, out *v1beta1.MachineStatus, s apiconversion.Scope) error {
func Convert_v1alpha3_MachineStatus_To_v1beta1_MachineStatus(in *MachineStatus, out *clusterv1.MachineStatus, s apiconversion.Scope) error {
// Status.version has been removed in v1beta1, thus requiring custom conversion function. the information will be dropped.
return autoConvert_v1alpha3_MachineStatus_To_v1beta1_MachineStatus(in, out, s)
}
Loading