Skip to content

Commit f65ea7e

Browse files
grokspawngrokspawn
authored
add Release version as an optional field in the CSV (#454)
* add Release version as an optional field in the CSV Signed-off-by: grokspawn <jordan@nimblewidget.com> Assisted-by: claude * review resolutions Signed-off-by: grokspawn <jordan@nimblewidget.com> --------- Signed-off-by: grokspawn <jordan@nimblewidget.com>
1 parent 4efa173 commit f65ea7e

10 files changed

Lines changed: 313 additions & 5 deletions

File tree

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ $(YQ): $(LOCALBIN)
129129
GOBIN=$(LOCALBIN) go install $(GO_INSTALL_OPTS) github.com/mikefarah/yq/v4@$(YQ_VERSION)
130130

131131
.PHONY: kind
132-
kind: $(KIND) ## Download yq locally if necessary.
132+
kind: $(KIND) ## Download kind locally if necessary.
133133
$(KIND): $(LOCALBIN)
134134
GOBIN=$(LOCALBIN) go install $(GO_INSTALL_OPTS) sigs.k8s.io/kind@latest
135135

‎crds/operators.coreos.com_clusterserviceversions.yaml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ spec:
2727
jsonPath: .spec.version
2828
name: Version
2929
type: string
30+
- description: The release of this version of the CSV
31+
jsonPath: .spec.release
32+
name: Release
33+
type: string
3034
- description: The name of a CSV that this one replaces
3135
jsonPath: .spec.replaces
3236
name: Replaces
@@ -8988,6 +8992,30 @@ spec:
89888992
type: string
89898993
name:
89908994
type: string
8995+
release:
8996+
description: |-
8997+
release specifies the packaging version of the operator, defaulting to empty
8998+
release is optional
8999+
9000+
A ClusterServiceVersion's release field is used to distinguish between different builds of the same operator version
9001+
This is useful for operators that need to make changes to the CSV which don't affect their functionality,
9002+
for example:
9003+
- to fix a typo in their description
9004+
- to add/amend annotations or labels
9005+
- to amend examples or documentation
9006+
- to produce different builds for different environments
9007+
9008+
It is up to operator authors to determine the semantics of release versions they use
9009+
for their operator. All release versions must conform to the semver prerelease format
9010+
(dot-separated identifiers containing only alphanumerics and hyphens) and are limited
9011+
to a maximum length of 20 characters.
9012+
type: string
9013+
maxLength: 20
9014+
x-kubernetes-validations:
9015+
- rule: self.matches('^[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*$')
9016+
message: release version must be composed of dot-separated identifiers containing only alphanumerics and hyphens
9017+
- rule: '!self.split(''.'').exists(x, x.matches(''^0[0-9]+$''))'
9018+
message: numeric identifiers in release version must not have leading zeros
89919019
replaces:
89929020
description: The name of a CSV this one replaces. Should match the `metadata.Name` field of the old CSV.
89939021
type: string

‎crds/zz_defs.go‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pkg/lib/release/release.go‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
package release
2+
3+
import (
4+
"encoding/json"
5+
"slices"
6+
"strings"
7+
8+
semver "github.com/blang/semver/v4"
9+
)
10+
11+
// +k8s:openapi-gen=true
12+
// OperatorRelease is a wrapper around a slice of semver.PRVersion which supports correct
13+
// marshaling to YAML and JSON.
14+
// +kubebuilder:validation:Type=string
15+
// +kubebuilder:validation:MaxLength=20
16+
// +kubebuilder:validation:XValidation:rule="self.matches('^[0-9A-Za-z-]+(\\\\.[0-9A-Za-z-]+)*$')",message="release version must be composed of dot-separated identifiers containing only alphanumerics and hyphens"
17+
// +kubebuilder:validation:XValidation:rule="!self.split('.').exists(x, x.matches('^0[0-9]+$'))",message="numeric identifiers in release version must not have leading zeros"
18+
type OperatorRelease struct {
19+
Release []semver.PRVersion `json:"-"`
20+
}
21+
22+
// DeepCopyInto creates a deep-copy of the Version value.
23+
func (v *OperatorRelease) DeepCopyInto(out *OperatorRelease) {
24+
out.Release = slices.Clone(v.Release)
25+
}
26+
27+
// MarshalJSON implements the encoding/json.Marshaler interface.
28+
func (v OperatorRelease) MarshalJSON() ([]byte, error) {
29+
segments := []string{}
30+
for _, segment := range v.Release {
31+
segments = append(segments, segment.String())
32+
}
33+
return json.Marshal(strings.Join(segments, "."))
34+
}
35+
36+
// UnmarshalJSON implements the encoding/json.Unmarshaler interface.
37+
func (v *OperatorRelease) UnmarshalJSON(data []byte) (err error) {
38+
var versionString string
39+
40+
if err = json.Unmarshal(data, &versionString); err != nil {
41+
return
42+
}
43+
44+
segments := strings.Split(versionString, ".")
45+
for _, segment := range segments {
46+
release, err := semver.NewPRVersion(segment)
47+
if err != nil {
48+
return err
49+
}
50+
v.Release = append(v.Release, release)
51+
}
52+
53+
return nil
54+
}
55+
56+
// OpenAPISchemaType is used by the kube-openapi generator when constructing
57+
// the OpenAPI spec of this type.
58+
//
59+
// See: https://github.com/kubernetes/kube-openapi/tree/master/pkg/generators
60+
func (_ OperatorRelease) OpenAPISchemaType() []string { return []string{"string"} }
61+
62+
// OpenAPISchemaFormat is used by the kube-openapi generator when constructing
63+
// the OpenAPI spec of this type.
64+
// "semver" is not a standard openapi format but tooling may use the value regardless
65+
func (_ OperatorRelease) OpenAPISchemaFormat() string { return "semver" }
66+
67+
func (r OperatorRelease) String() string {
68+
segments := []string{}
69+
for _, segment := range r.Release {
70+
segments = append(segments, segment.String())
71+
}
72+
return strings.Join(segments, ".")
73+
}

‎pkg/lib/release/release_test.go‎

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
package release
2+
3+
import (
4+
"encoding/json"
5+
"testing"
6+
7+
semver "github.com/blang/semver/v4"
8+
"github.com/stretchr/testify/require"
9+
)
10+
11+
func TestOperatorReleaseMarshal(t *testing.T) {
12+
tests := []struct {
13+
name string
14+
in OperatorRelease
15+
out []byte
16+
err error
17+
}{
18+
{
19+
name: "single-segment",
20+
in: OperatorRelease{Release: []semver.PRVersion{mustNewPRVersion("1")}},
21+
out: []byte(`"1"`),
22+
},
23+
{
24+
name: "two-segments",
25+
in: OperatorRelease{Release: []semver.PRVersion{mustNewPRVersion("1"), mustNewPRVersion("0")}},
26+
out: []byte(`"1.0"`),
27+
},
28+
{
29+
name: "multi-segment",
30+
in: OperatorRelease{Release: []semver.PRVersion{
31+
mustNewPRVersion("1"),
32+
mustNewPRVersion("2"),
33+
mustNewPRVersion("3"),
34+
}},
35+
out: []byte(`"1.2.3"`),
36+
},
37+
{
38+
name: "numeric-segments",
39+
in: OperatorRelease{Release: []semver.PRVersion{
40+
mustNewPRVersion("20240101"),
41+
mustNewPRVersion("12345"),
42+
}},
43+
out: []byte(`"20240101.12345"`),
44+
},
45+
{
46+
name: "alphanumeric-segments",
47+
in: OperatorRelease{Release: []semver.PRVersion{
48+
mustNewPRVersion("alpha"),
49+
mustNewPRVersion("beta"),
50+
mustNewPRVersion("1"),
51+
}},
52+
out: []byte(`"alpha.beta.1"`),
53+
},
54+
{
55+
name: "alphanumeric-with-hyphens",
56+
in: OperatorRelease{Release: []semver.PRVersion{
57+
mustNewPRVersion("rc-1"),
58+
mustNewPRVersion("build-123"),
59+
}},
60+
out: []byte(`"rc-1.build-123"`),
61+
},
62+
{
63+
name: "mixed-alphanumeric",
64+
in: OperatorRelease{Release: []semver.PRVersion{
65+
mustNewPRVersion("1"),
66+
mustNewPRVersion("2-beta"),
67+
mustNewPRVersion("x86-64"),
68+
}},
69+
out: []byte(`"1.2-beta.x86-64"`),
70+
},
71+
}
72+
for _, tt := range tests {
73+
t.Run(tt.name, func(t *testing.T) {
74+
m, err := tt.in.MarshalJSON()
75+
require.Equal(t, tt.out, m, string(m))
76+
require.Equal(t, tt.err, err)
77+
})
78+
}
79+
}
80+
81+
func TestOperatorReleaseUnmarshal(t *testing.T) {
82+
type TestStruct struct {
83+
Release OperatorRelease `json:"r"`
84+
}
85+
tests := []struct {
86+
name string
87+
in []byte
88+
out TestStruct
89+
err error
90+
}{
91+
{
92+
name: "single-segment",
93+
in: []byte(`{"r": "1"}`),
94+
out: TestStruct{Release: OperatorRelease{Release: []semver.PRVersion{mustNewPRVersion("1")}}},
95+
},
96+
{
97+
name: "two-segments",
98+
in: []byte(`{"r": "1.0"}`),
99+
out: TestStruct{Release: OperatorRelease{Release: []semver.PRVersion{mustNewPRVersion("1"), mustNewPRVersion("0")}}},
100+
},
101+
{
102+
name: "multi-segment",
103+
in: []byte(`{"r": "1.2.3"}`),
104+
out: TestStruct{Release: OperatorRelease{Release: []semver.PRVersion{
105+
mustNewPRVersion("1"),
106+
mustNewPRVersion("2"),
107+
mustNewPRVersion("3"),
108+
}}},
109+
},
110+
{
111+
name: "numeric-segments",
112+
in: []byte(`{"r": "20240101.12345"}`),
113+
out: TestStruct{Release: OperatorRelease{Release: []semver.PRVersion{
114+
mustNewPRVersion("20240101"),
115+
mustNewPRVersion("12345"),
116+
}}},
117+
},
118+
{
119+
name: "alphanumeric-segments",
120+
in: []byte(`{"r": "alpha.beta.1"}`),
121+
out: TestStruct{Release: OperatorRelease{Release: []semver.PRVersion{
122+
mustNewPRVersion("alpha"),
123+
mustNewPRVersion("beta"),
124+
mustNewPRVersion("1"),
125+
}}},
126+
},
127+
{
128+
name: "alphanumeric-with-hyphens",
129+
in: []byte(`{"r": "rc-1.build-123"}`),
130+
out: TestStruct{Release: OperatorRelease{Release: []semver.PRVersion{
131+
mustNewPRVersion("rc-1"),
132+
mustNewPRVersion("build-123"),
133+
}}},
134+
},
135+
{
136+
name: "mixed-alphanumeric",
137+
in: []byte(`{"r": "1.2-beta.x86-64"}`),
138+
out: TestStruct{Release: OperatorRelease{Release: []semver.PRVersion{
139+
mustNewPRVersion("1"),
140+
mustNewPRVersion("2-beta"),
141+
mustNewPRVersion("x86-64"),
142+
}}},
143+
},
144+
}
145+
for _, tt := range tests {
146+
t.Run(tt.name, func(t *testing.T) {
147+
s := TestStruct{}
148+
err := json.Unmarshal(tt.in, &s)
149+
require.Equal(t, tt.out, s)
150+
require.Equal(t, tt.err, err)
151+
})
152+
}
153+
}
154+
155+
func mustNewPRVersion(s string) semver.PRVersion {
156+
v, err := semver.NewPRVersion(s)
157+
if err != nil {
158+
panic(err)
159+
}
160+
return v
161+
}

‎pkg/manifests/bundleloader.go‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ func (b *bundleLoader) LoadBundle() error {
3939

4040
errs = append(errs, b.calculateCompressedBundleSize())
4141
b.addChannelsFromAnnotationsFile()
42+
b.addPackageFromAnnotationsFile()
4243

4344
if !b.foundCSV {
4445
errs = append(errs, fmt.Errorf("unable to find a csv in bundle directory %s", b.dir))
@@ -68,6 +69,14 @@ func (b *bundleLoader) addChannelsFromAnnotationsFile() {
6869
}
6970
}
7071

72+
func (b *bundleLoader) addPackageFromAnnotationsFile() {
73+
if b.bundle == nil {
74+
// None of this is relevant if the bundle was not found
75+
return
76+
}
77+
b.bundle.Package = b.annotationsFile.Annotations.PackageName
78+
}
79+
7180
// Compress the bundle to check its size
7281
func (b *bundleLoader) calculateCompressedBundleSize() error {
7382
if b.bundle == nil {

‎pkg/operators/v1alpha1/clusterserviceversion_types.go‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import (
1313
"k8s.io/apimachinery/pkg/labels"
1414
"k8s.io/apimachinery/pkg/util/intstr"
1515

16+
"github.com/operator-framework/api/pkg/lib/release"
1617
"github.com/operator-framework/api/pkg/lib/version"
1718
)
1819

@@ -274,8 +275,25 @@ type APIServiceDefinitions struct {
274275
// that can manage apps for a given version.
275276
// +k8s:openapi-gen=true
276277
type ClusterServiceVersionSpec struct {
277-
InstallStrategy NamedInstallStrategy `json:"install"`
278-
Version version.OperatorVersion `json:"version,omitempty"`
278+
InstallStrategy NamedInstallStrategy `json:"install"`
279+
Version version.OperatorVersion `json:"version,omitempty"`
280+
// release specifies the packaging version of the operator, defaulting to empty
281+
// release is optional
282+
//
283+
// A ClusterServiceVersion's release field is used to distinguish between different builds of the same operator version
284+
// This is useful for operators that need to make changes to the CSV which don't affect their functionality,
285+
// for example:
286+
// - to fix a typo in their description
287+
// - to add/amend annotations or labels
288+
// - to amend examples or documentation
289+
// - to produce different builds for different environments
290+
//
291+
// It is up to operator authors to determine the semantics of release versions they use
292+
// for their operator. All release versions must conform to the semver prerelease format
293+
// (dot-separated identifiers containing only alphanumerics and hyphens) and are limited
294+
// to a maximum length of 20 characters.
295+
// +optional
296+
Release release.OperatorRelease `json:"release,omitzero"`
279297
Maturity string `json:"maturity,omitempty"`
280298
CustomResourceDefinitions CustomResourceDefinitions `json:"customresourcedefinitions,omitempty"`
281299
APIServiceDefinitions APIServiceDefinitions `json:"apiservicedefinitions,omitempty"`
@@ -595,6 +613,7 @@ type ResourceInstance struct {
595613
// +kubebuilder:subresource:status
596614
// +kubebuilder:printcolumn:name="Display",type=string,JSONPath=`.spec.displayName`,description="The name of the CSV"
597615
// +kubebuilder:printcolumn:name="Version",type=string,JSONPath=`.spec.version`,description="The version of the CSV"
616+
// +kubebuilder:printcolumn:name="Release",type=string,JSONPath=`.spec.release`,description="The release of this version of the CSV"
598617
// +kubebuilder:printcolumn:name="Replaces",type=string,JSONPath=`.spec.replaces`,description="The name of a CSV that this one replaces"
599618
// +kubebuilder:printcolumn:name="Phase",type=string,JSONPath=`.status.phase`
600619

‎pkg/operators/v1alpha1/zz_generated.deepcopy.go‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pkg/validation/internal/bundle.go‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,26 @@ func validateBundle(bundle *manifests.Bundle) (result errors.ManifestResult) {
4242
if sizeErrors != nil {
4343
result.Add(sizeErrors...)
4444
}
45+
nameErrors := validateBundleName(bundle)
46+
if nameErrors != nil {
47+
result.Add(nameErrors...)
48+
}
4549
return result
4650
}
4751

52+
func validateBundleName(bundle *manifests.Bundle) []errors.Error {
53+
var errs []errors.Error
54+
// bundle naming with a specified release version must follow the pattern
55+
// <package-name>-v<csv-version>-<release-version>
56+
if len(bundle.CSV.Spec.Release.Release) > 0 {
57+
expectedName := fmt.Sprintf("%s-v%s-%s", bundle.Package, bundle.CSV.Spec.Version.String(), bundle.CSV.Spec.Release.String())
58+
if bundle.Name != expectedName {
59+
errs = append(errs, errors.ErrInvalidBundle(fmt.Sprintf("bundle name with release versioning %q does not match expected name %q", bundle.Name, expectedName), bundle.Name))
60+
}
61+
}
62+
return errs
63+
}
64+
4865
func validateServiceAccounts(bundle *manifests.Bundle) []errors.Error {
4966
// get service account names defined in the csv
5067
saNamesFromCSV := make(map[string]struct{}, 0)

‎pkg/validation/internal/typecheck.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ func checkEmptyFields(result *errors.ManifestResult, v reflect.Value, parentStru
2828

2929
// Omitted field tags will contain ",omitempty", and ignored tags will
3030
// match "-" exactly, respectively.
31-
isOptionalField := strings.Contains(tag, ",omitempty") || tag == "-"
31+
isOptionalField := strings.Contains(tag, ",omitempty") || strings.Contains(tag, ",omitzero") || tag == "-"
3232
emptyVal := fieldValue.IsZero()
3333

3434
newParentStructName := fieldType.Name

0 commit comments

Comments
 (0)