sigs.k8s.io/cluster-api@v1.7.1/cmd/clusterctl/api/v1alpha3/metadata_type.go (about)

     1  /*
     2  Copyright 2019 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package v1alpha3
    18  
    19  import (
    20  	"github.com/blang/semver/v4"
    21  	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
    22  	"k8s.io/apimachinery/pkg/util/version"
    23  )
    24  
    25  // +kubebuilder:object:root=true
    26  
    27  // Metadata for a provider repository.
    28  type Metadata struct {
    29  	metav1.TypeMeta   `json:",inline"`
    30  	metav1.ObjectMeta `json:"metadata,omitempty"`
    31  
    32  	// +optional
    33  	ReleaseSeries []ReleaseSeries `json:"releaseSeries"`
    34  }
    35  
    36  // ReleaseSeries maps a provider release series (major/minor) with a API Version of Cluster API (contract).
    37  type ReleaseSeries struct {
    38  	// Major version of the release series
    39  	Major uint `json:"major,omitempty"`
    40  
    41  	// Minor version of the release series
    42  	Minor uint `json:"minor,omitempty"`
    43  
    44  	// Contract defines the Cluster API contract supported by this series.
    45  	//
    46  	// The value is an API Version, e.g. `v1alpha3`.
    47  	Contract string `json:"contract,omitempty"`
    48  }
    49  
    50  func (rs ReleaseSeries) newer(release ReleaseSeries) bool {
    51  	v := semver.Version{Major: uint64(rs.Major), Minor: uint64(rs.Minor)}
    52  	ver := semver.Version{Major: uint64(release.Major), Minor: uint64(release.Minor)}
    53  	return v.GTE(ver)
    54  }
    55  
    56  func init() {
    57  	objectTypes = append(objectTypes, &Metadata{})
    58  }
    59  
    60  // GetReleaseSeriesForVersion returns the release series for a given version.
    61  func (m *Metadata) GetReleaseSeriesForVersion(version *version.Version) *ReleaseSeries {
    62  	for _, releaseSeries := range m.ReleaseSeries {
    63  		if version.Major() == releaseSeries.Major && version.Minor() == releaseSeries.Minor {
    64  			return &releaseSeries
    65  		}
    66  	}
    67  
    68  	return nil
    69  }
    70  
    71  // GetReleaseSeriesForContract returns the release series for a given API Version, e.g. `v1alpha4`.
    72  // If more than one release series use the same contract then the latest newer release series is
    73  // returned.
    74  func (m *Metadata) GetReleaseSeriesForContract(contract string) *ReleaseSeries {
    75  	var rs ReleaseSeries
    76  	var found bool
    77  	for _, releaseSeries := range m.ReleaseSeries {
    78  		if contract == releaseSeries.Contract {
    79  			found = true
    80  			if releaseSeries.newer(rs) {
    81  				rs = releaseSeries
    82  			}
    83  		}
    84  	}
    85  	if !found {
    86  		return nil
    87  	}
    88  	return &rs
    89  }