Skip to content

Introduce olm.channel schema, remove channel metadata-related bundle properties #768

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
merged 5 commits into from
Sep 2, 2021
Merged

Introduce olm.channel schema, remove channel metadata-related bundle properties #768

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
13e4f4f
add olm.channel schema
joelanford Aug 28, 2021
297a149
render: don't render upgrade edge properties in bundles
joelanford Aug 30, 2021
00cb8d4
remove channel-related properties from bundles
joelanford Sep 1, 2021
ca53411
remove strategy.legacy layer from olm.channel schema
joelanford Sep 1, 2021
f4868c3
minor cleanups
joelanford Sep 1, 2021
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
22 changes: 1 addition & 21 deletions alpha/action/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ import (

"github.com/operator-framework/operator-registry/alpha/declcfg"
"github.com/operator-framework/operator-registry/alpha/model"
"github.com/operator-framework/operator-registry/alpha/property"
)

type ListPackages struct {
Expand Down Expand Up @@ -173,32 +172,13 @@ func (r *ListBundlesResult) WriteColumns(w io.Writer) error {
return err
}
for _, b := range r.Bundles {
skipRange, err := getSkipRange(b)
if err != nil {
return fmt.Errorf("get skipRange for bundle %q: %v", b.Name, err)
}
if _, err := fmt.Fprintf(tw, "%s\t%s\t%s\t%s\t%s\t%s\t%s\n", b.Package.Name, b.Channel.Name, b.Name, b.Replaces, strings.Join(b.Skips, ","), skipRange, b.Image); err != nil {
if _, err := fmt.Fprintf(tw, "%s\t%s\t%s\t%s\t%s\t%s\t%s\n", b.Package.Name, b.Channel.Name, b.Name, b.Replaces, strings.Join(b.Skips, ","), b.SkipRange, b.Image); err != nil {
return err
}

}
return tw.Flush()
}

func getSkipRange(b model.Bundle) (string, error) {
props, err := property.Parse(b.Properties)
if err != nil {
return "", err
}
if len(props.SkipRanges) > 1 {
return "", fmt.Errorf("multiple skip ranges not supported")
}
if len(props.SkipRanges) == 0 {
return "", nil
}
return string(props.SkipRanges[0]), nil
}

func indexRefToModel(ctx context.Context, ref string) (model.Model, error) {
render := Render{
Refs: []string{ref},
Expand Down
1 change: 1 addition & 0 deletions alpha/action/render.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,7 @@ func combineConfigs(cfgs []declcfg.DeclarativeConfig) *declcfg.DeclarativeConfig
out := &declcfg.DeclarativeConfig{}
for _, in := range cfgs {
out.Packages = append(out.Packages, in.Packages...)
out.Channels = append(out.Channels, in.Channels...)
out.Bundles = append(out.Bundles, in.Bundles...)
out.Others = append(out.Others, in.Others...)
}
Expand Down
73 changes: 38 additions & 35 deletions alpha/action/render_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,20 +75,27 @@ func TestRender(t *testing.T) {
DefaultChannel: "beta",
},
},
Channels: []declcfg.Channel{
{Schema: "olm.channel", Package: "foo", Name: "beta", Entries: []declcfg.ChannelEntry{
{Name: "foo.v0.1.0", SkipRange: "<0.1.0"},
{Name: "foo.v0.2.0", Replaces: "foo.v0.1.0", SkipRange: "<0.2.0", Skips: []string{"foo.v0.1.1", "foo.v0.1.2"}},
}},
{Schema: "olm.channel", Package: "foo", Name: "stable", Entries: []declcfg.ChannelEntry{
{Name: "foo.v0.1.0", SkipRange: "<0.1.0"},
{Name: "foo.v0.2.0", Replaces: "foo.v0.1.0", SkipRange: "<0.2.0", Skips: []string{"foo.v0.1.1", "foo.v0.1.2"}},
}},
},
Bundles: []declcfg.Bundle{
{
Schema: "olm.bundle",
Name: "foo.v0.1.0",
Package: "foo",
Image: "test.registry/foo-operator/foo-bundle:v0.1.0",
Properties: []property.Property{
property.MustBuildChannel("beta", ""),
property.MustBuildChannel("stable", ""),
property.MustBuildGVK("test.foo", "v1", "Foo"),
property.MustBuildGVKRequired("test.bar", "v1alpha1", "Bar"),
property.MustBuildPackage("foo", "0.1.0"),
property.MustBuildPackageRequired("bar", "<0.1.0"),
property.MustBuildSkipRange("<0.1.0"),
property.MustBuildBundleObjectData(foov1csv),
property.MustBuildBundleObjectData(foov1crd),
},
Expand All @@ -110,15 +117,10 @@ func TestRender(t *testing.T) {
Package: "foo",
Image: "test.registry/foo-operator/foo-bundle:v0.2.0",
Properties: []property.Property{
property.MustBuildChannel("beta", "foo.v0.1.0"),
property.MustBuildChannel("stable", "foo.v0.1.0"),
property.MustBuildGVK("test.foo", "v1", "Foo"),
property.MustBuildGVKRequired("test.bar", "v1alpha1", "Bar"),
property.MustBuildPackage("foo", "0.2.0"),
property.MustBuildPackageRequired("bar", "<0.1.0"),
property.MustBuildSkipRange("<0.2.0"),
property.MustBuildSkips("foo.v0.1.1"),
property.MustBuildSkips("foo.v0.1.2"),
property.MustBuildBundleObjectData(foov2csv),
property.MustBuildBundleObjectData(foov2crd),
},
Expand Down Expand Up @@ -165,20 +167,27 @@ func TestRender(t *testing.T) {
DefaultChannel: "beta",
},
},
Channels: []declcfg.Channel{
{Schema: "olm.channel", Package: "foo", Name: "beta", Entries: []declcfg.ChannelEntry{
{Name: "foo.v0.1.0", SkipRange: "<0.1.0"},
{Name: "foo.v0.2.0", Replaces: "foo.v0.1.0", SkipRange: "<0.2.0", Skips: []string{"foo.v0.1.1", "foo.v0.1.2"}},
}},
{Schema: "olm.channel", Package: "foo", Name: "stable", Entries: []declcfg.ChannelEntry{
{Name: "foo.v0.1.0", SkipRange: "<0.1.0"},
{Name: "foo.v0.2.0", Replaces: "foo.v0.1.0", SkipRange: "<0.2.0", Skips: []string{"foo.v0.1.1", "foo.v0.1.2"}},
}},
},
Bundles: []declcfg.Bundle{
{
Schema: "olm.bundle",
Name: "foo.v0.1.0",
Package: "foo",
Image: "test.registry/foo-operator/foo-bundle:v0.1.0",
Properties: []property.Property{
property.MustBuildChannel("beta", ""),
property.MustBuildChannel("stable", ""),
property.MustBuildGVK("test.foo", "v1", "Foo"),
property.MustBuildGVKRequired("test.bar", "v1alpha1", "Bar"),
property.MustBuildPackage("foo", "0.1.0"),
property.MustBuildPackageRequired("bar", "<0.1.0"),
property.MustBuildSkipRange("<0.1.0"),
property.MustBuildBundleObjectData(foov1csv),
property.MustBuildBundleObjectData(foov1crd),
},
Expand All @@ -200,15 +209,10 @@ func TestRender(t *testing.T) {
Package: "foo",
Image: "test.registry/foo-operator/foo-bundle:v0.2.0",
Properties: []property.Property{
property.MustBuildChannel("beta", "foo.v0.1.0"),
property.MustBuildChannel("stable", "foo.v0.1.0"),
property.MustBuildGVK("test.foo", "v1", "Foo"),
property.MustBuildGVKRequired("test.bar", "v1alpha1", "Bar"),
property.MustBuildPackage("foo", "0.2.0"),
property.MustBuildPackageRequired("bar", "<0.1.0"),
property.MustBuildSkipRange("<0.2.0"),
property.MustBuildSkips("foo.v0.1.1"),
property.MustBuildSkips("foo.v0.1.2"),
property.MustBuildBundleObjectData(foov2csv),
property.MustBuildBundleObjectData(foov2crd),
},
Expand Down Expand Up @@ -255,19 +259,26 @@ func TestRender(t *testing.T) {
DefaultChannel: "beta",
},
},
Channels: []declcfg.Channel{
{Schema: "olm.channel", Package: "foo", Name: "beta", Entries: []declcfg.ChannelEntry{
{Name: "foo.v0.1.0", SkipRange: "<0.1.0"},
{Name: "foo.v0.2.0", Replaces: "foo.v0.1.0", SkipRange: "<0.2.0", Skips: []string{"foo.v0.1.1", "foo.v0.1.2"}},
}},
{Schema: "olm.channel", Package: "foo", Name: "stable", Entries: []declcfg.ChannelEntry{
{Name: "foo.v0.2.0", Replaces: "foo.v0.1.0", SkipRange: "<0.2.0", Skips: []string{"foo.v0.1.1", "foo.v0.1.2"}},
}},
},
Bundles: []declcfg.Bundle{
{
Schema: "olm.bundle",
Name: "foo.v0.1.0",
Package: "foo",
Image: "test.registry/foo-operator/foo-bundle:v0.1.0",
Properties: []property.Property{
property.MustBuildChannel("beta", ""),
property.MustBuildGVK("test.foo", "v1", "Foo"),
property.MustBuildGVKRequired("test.bar", "v1alpha1", "Bar"),
property.MustBuildPackage("foo", "0.1.0"),
property.MustBuildPackageRequired("bar", "<0.1.0"),
property.MustBuildSkipRange("<0.1.0"),
property.MustBuildBundleObjectData(foov1csv),
property.MustBuildBundleObjectData(foov1crd),
},
Expand All @@ -289,15 +300,10 @@ func TestRender(t *testing.T) {
Package: "foo",
Image: "test.registry/foo-operator/foo-bundle:v0.2.0",
Properties: []property.Property{
property.MustBuildChannel("beta", "foo.v0.1.0"),
property.MustBuildChannel("stable", "foo.v0.1.0"),
property.MustBuildGVK("test.foo", "v1", "Foo"),
property.MustBuildGVKRequired("test.bar", "v1alpha1", "Bar"),
property.MustBuildPackage("foo", "0.2.0"),
property.MustBuildPackageRequired("bar", "<0.1.0"),
property.MustBuildSkipRange("<0.2.0"),
property.MustBuildSkips("foo.v0.1.1"),
property.MustBuildSkips("foo.v0.1.2"),
property.MustBuildBundleObjectData(foov2csv),
property.MustBuildBundleObjectData(foov2crd),
},
Expand Down Expand Up @@ -344,19 +350,26 @@ func TestRender(t *testing.T) {
DefaultChannel: "beta",
},
},
Channels: []declcfg.Channel{
{Schema: "olm.channel", Package: "foo", Name: "beta", Entries: []declcfg.ChannelEntry{
{Name: "foo.v0.1.0", SkipRange: "<0.1.0"},
{Name: "foo.v0.2.0", Replaces: "foo.v0.1.0", SkipRange: "<0.2.0", Skips: []string{"foo.v0.1.1", "foo.v0.1.2"}},
}},
{Schema: "olm.channel", Package: "foo", Name: "stable", Entries: []declcfg.ChannelEntry{
{Name: "foo.v0.2.0", Replaces: "foo.v0.1.0", SkipRange: "<0.2.0", Skips: []string{"foo.v0.1.1", "foo.v0.1.2"}},
}},
},
Bundles: []declcfg.Bundle{
{
Schema: "olm.bundle",
Name: "foo.v0.1.0",
Package: "foo",
Image: "test.registry/foo-operator/foo-bundle:v0.1.0",
Properties: []property.Property{
property.MustBuildChannel("beta", ""),
property.MustBuildGVK("test.foo", "v1", "Foo"),
property.MustBuildGVKRequired("test.bar", "v1alpha1", "Bar"),
property.MustBuildPackage("foo", "0.1.0"),
property.MustBuildPackageRequired("bar", "<0.1.0"),
property.MustBuildSkipRange("<0.1.0"),
property.MustBuildBundleObjectData(foov1csv),
property.MustBuildBundleObjectData(foov1crd),
},
Expand All @@ -378,15 +391,10 @@ func TestRender(t *testing.T) {
Package: "foo",
Image: "test.registry/foo-operator/foo-bundle:v0.2.0",
Properties: []property.Property{
property.MustBuildChannel("beta", "foo.v0.1.0"),
property.MustBuildChannel("stable", "foo.v0.1.0"),
property.MustBuildGVK("test.foo", "v1", "Foo"),
property.MustBuildGVKRequired("test.bar", "v1alpha1", "Bar"),
property.MustBuildPackage("foo", "0.2.0"),
property.MustBuildPackageRequired("bar", "<0.1.0"),
property.MustBuildSkipRange("<0.2.0"),
property.MustBuildSkips("foo.v0.1.1"),
property.MustBuildSkips("foo.v0.1.2"),
property.MustBuildBundleObjectData(foov2csv),
property.MustBuildBundleObjectData(foov2crd),
},
Expand Down Expand Up @@ -433,15 +441,10 @@ func TestRender(t *testing.T) {
Package: "foo",
Image: "test.registry/foo-operator/foo-bundle:v0.2.0",
Properties: []property.Property{
property.MustBuildChannel("beta", "foo.v0.1.0"),
property.MustBuildChannel("stable", "foo.v0.1.0"),
property.MustBuildGVK("test.foo", "v1", "Foo"),
property.MustBuildGVKRequired("test.bar", "v1alpha1", "Bar"),
property.MustBuildPackage("foo", "0.2.0"),
property.MustBuildPackageRequired("bar", "<0.1.0"),
property.MustBuildSkipRange("<0.2.0"),
property.MustBuildSkips("foo.v0.1.1"),
property.MustBuildSkips("foo.v0.1.2"),
},
RelatedImages: []declcfg.RelatedImage{
{
Expand Down
43 changes: 24 additions & 19 deletions alpha/action/testdata/foo-index-v0.2.0-declcfg/foo/index.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,35 @@ schema: olm.package
name: foo
defaultChannel: beta
---
schema: olm.channel
package: foo
name: beta
entries:
- name: foo.v0.1.0
skipRange: <0.1.0
- name: foo.v0.2.0
replaces: foo.v0.1.0
skipRange: <0.2.0
skips:
- foo.v0.1.1
- foo.v0.1.2
---
schema: olm.channel
package: foo
name: stable
entries:
- name: foo.v0.2.0
replaces: foo.v0.1.0
skipRange: <0.2.0
skips:
- foo.v0.1.1
- foo.v0.1.2
---
schema: olm.bundle
package: foo
name: foo.v0.1.0
image: test.registry/foo-operator/foo-bundle:v0.1.0
properties:
- type: olm.channel
value:
name: beta
- type: olm.gvk
value:
group: test.foo
Expand All @@ -29,8 +50,6 @@ properties:
value:
packageName: bar
versionRange: <0.1.0
- type: olm.skipRange
value: <0.1.0
- type: olm.bundle.object
value:
data: eyJhcGlWZXJzaW9uIjoib3BlcmF0b3JzLmNvcmVvcy5jb20vdjFhbHBoYTEiLCJraW5kIjoiQ2x1c3RlclNlcnZpY2VWZXJzaW9uIiwibWV0YWRhdGEiOnsiYW5ub3RhdGlvbnMiOnsib2xtLnNraXBSYW5nZSI6Ilx1MDAzYzAuMS4wIn0sIm5hbWUiOiJmb28udjAuMS4wIn0sInNwZWMiOnsiY3VzdG9tcmVzb3VyY2VkZWZpbml0aW9ucyI6eyJvd25lZCI6W3siZ3JvdXAiOiJ0ZXN0LmZvbyIsImtpbmQiOiJGb28iLCJuYW1lIjoiZm9vcy50ZXN0LmZvbyIsInZlcnNpb24iOiJ2MSJ9XX0sImRpc3BsYXlOYW1lIjoiRm9vIE9wZXJhdG9yIiwicmVsYXRlZEltYWdlcyI6W3siaW1hZ2UiOiJ0ZXN0LnJlZ2lzdHJ5L2Zvby1vcGVyYXRvci9mb286djAuMS4wIiwibmFtZSI6Im9wZXJhdG9yIn1dLCJ2ZXJzaW9uIjoiMC4xLjAifX0=
Expand All @@ -47,14 +66,6 @@ package: foo
name: foo.v0.2.0
image: test.registry/foo-operator/foo-bundle:v0.2.0
properties:
- type: olm.channel
value:
name: beta
replaces: foo.v0.1.0
- type: olm.channel
value:
name: stable
replaces: foo.v0.1.0
- type: olm.gvk
value:
group: test.foo
Expand All @@ -73,12 +84,6 @@ properties:
value:
packageName: bar
versionRange: <0.1.0
- type: olm.skipRange
value: <0.2.0
- type: olm.skips
value: foo.v0.1.1
- type: olm.skips
value: foo.v0.1.2
- type: olm.bundle.object
value:
data: eyJhcGlWZXJzaW9uIjoib3BlcmF0b3JzLmNvcmVvcy5jb20vdjFhbHBoYTEiLCJraW5kIjoiQ2x1c3RlclNlcnZpY2VWZXJzaW9uIiwibWV0YWRhdGEiOnsiYW5ub3RhdGlvbnMiOnsib2xtLnNraXBSYW5nZSI6Ilx1MDAzYzAuMi4wIn0sIm5hbWUiOiJmb28udjAuMi4wIn0sInNwZWMiOnsiY3VzdG9tcmVzb3VyY2VkZWZpbml0aW9ucyI6eyJvd25lZCI6W3siZ3JvdXAiOiJ0ZXN0LmZvbyIsImtpbmQiOiJGb28iLCJuYW1lIjoiZm9vcy50ZXN0LmZvbyIsInZlcnNpb24iOiJ2MSJ9XX0sImRpc3BsYXlOYW1lIjoiRm9vIE9wZXJhdG9yIiwiaW5zdGFsbCI6eyJzcGVjIjp7ImRlcGxveW1lbnRzIjpbeyJuYW1lIjoiZm9vLW9wZXJhdG9yIiwic3BlYyI6eyJ0ZW1wbGF0ZSI6eyJzcGVjIjp7ImNvbnRhaW5lcnMiOlt7ImltYWdlIjoidGVzdC5yZWdpc3RyeS9mb28tb3BlcmF0b3IvZm9vOnYwLjIuMCJ9XSwiaW5pdENvbnRhaW5lcnMiOlt7ImltYWdlIjoidGVzdC5yZWdpc3RyeS9mb28tb3BlcmF0b3IvZm9vLWluaXQ6djAuMi4wIn1dfX19fSx7Im5hbWUiOiJmb28tb3BlcmF0b3ItMiIsInNwZWMiOnsidGVtcGxhdGUiOnsic3BlYyI6eyJjb250YWluZXJzIjpbeyJpbWFnZSI6InRlc3QucmVnaXN0cnkvZm9vLW9wZXJhdG9yL2Zvby0yOnYwLjIuMCJ9XSwiaW5pdENvbnRhaW5lcnMiOlt7ImltYWdlIjoidGVzdC5yZWdpc3RyeS9mb28tb3BlcmF0b3IvZm9vLWluaXQtMjp2MC4yLjAifV19fX19XX0sInN0cmF0ZWd5IjoiZGVwbG95bWVudCJ9LCJyZWxhdGVkSW1hZ2VzIjpbeyJpbWFnZSI6InRlc3QucmVnaXN0cnkvZm9vLW9wZXJhdG9yL2Zvbzp2MC4yLjAiLCJuYW1lIjoib3BlcmF0b3IifSx7ImltYWdlIjoidGVzdC5yZWdpc3RyeS9mb28tb3BlcmF0b3IvZm9vLW90aGVyOnYwLjIuMCIsIm5hbWUiOiJvdGhlciJ9XSwicmVwbGFjZXMiOiJmb28udjAuMS4wIiwic2tpcHMiOlsiZm9vLnYwLjEuMSIsImZvby52MC4xLjIiXSwidmVyc2lvbiI6IjAuMi4wIn19
Expand Down
Loading