-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
cmd/operator-sdk/olmcatalog: scaffold package.yaml for a set of… (#1364)
* cmd/operator-sdk/olmcatalog/gen-csv.go: add PackageManifest scaffold and the optional --csv-channel and --default-channel flags to specify in which channel an operator's CSV name should reside in their package manifest * internal/pkg/scaffold/olm-catalog: PackageManifest scaffold adds and updates an <operatorname>.package.yaml file in deploy/olm-catalo/<operator-name>, a file used by OLM to manage operator CSV's * Gopkg.lock,vendor: revendor * doc/sdk-cli-reference.md: add --csv-channel and --default-channel to gen-csv * CHANGELOG.md: add package manifest flags
- Loading branch information
Eric Stroczynski
authored
Jun 28, 2019
1 parent
eedbe31
commit 0fc5746
Showing
11 changed files
with
433 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,190 @@ | ||
| // Copyright 2019 The Operator-SDK Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package catalog | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "io/ioutil" | ||
| "os" | ||
| "path/filepath" | ||
| "sort" | ||
| "strings" | ||
|
|
||
| "github.com/operator-framework/operator-sdk/internal/pkg/scaffold" | ||
| "github.com/operator-framework/operator-sdk/internal/pkg/scaffold/input" | ||
|
|
||
| "github.com/ghodss/yaml" | ||
| olmregistry "github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry" | ||
| "github.com/pkg/errors" | ||
| log "github.com/sirupsen/logrus" | ||
| "github.com/spf13/afero" | ||
| ) | ||
|
|
||
| const PackageManifestFileExt = ".package.yaml" | ||
|
|
||
| type PackageManifest struct { | ||
| input.Input | ||
|
|
||
| // CSVVersion is the version of the CSV being updated. | ||
| CSVVersion string | ||
| // Channel is CSVVersion's package manifest channel. If a new package | ||
| // manifest is generated, this channel will be the manifest default. | ||
| Channel string | ||
| // If ChannelIsDefault is true, Channel will be the package manifests' | ||
| // default channel. | ||
| ChannelIsDefault bool | ||
| } | ||
|
|
||
| var _ input.File = &PackageManifest{} | ||
|
|
||
| // GetInput gets s' Input. | ||
| func (s *PackageManifest) GetInput() (input.Input, error) { | ||
| if s.Path == "" { | ||
| lowerProjName := strings.ToLower(s.ProjectName) | ||
| // Path is what the operator-registry expects: | ||
| // {manifests -> olm-catalog}/{operator_name}/{operator_name}.package.yaml | ||
| s.Path = filepath.Join(OLMCatalogDir, lowerProjName, | ||
| lowerProjName+PackageManifestFileExt) | ||
| } | ||
| return s.Input, nil | ||
| } | ||
|
|
||
| var _ scaffold.CustomRenderer = &PackageManifest{} | ||
|
|
||
| // SetFS is a no-op to implement CustomRenderer. | ||
| func (s *PackageManifest) SetFS(_ afero.Fs) {} | ||
|
|
||
| // CustomRender either reads an existing package manifest or creates a new | ||
| // manifest and modifies it based on values set in s. | ||
| func (s *PackageManifest) CustomRender() ([]byte, error) { | ||
| i, err := s.GetInput() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| path := filepath.Join(s.AbsProjectPath, i.Path) | ||
|
|
||
| pm := &olmregistry.PackageManifest{} | ||
| if _, err := os.Stat(path); err != nil && os.IsNotExist(err) { | ||
| pm = s.newPackageManifest() | ||
| } else if err == nil { | ||
| b, err := ioutil.ReadFile(path) | ||
| if err != nil { | ||
| return nil, errors.Wrapf(err, "failed to read package manifest %s", path) | ||
| } | ||
| if len(b) > 0 { | ||
| if err = yaml.Unmarshal(b, pm); err != nil { | ||
| return nil, errors.Wrapf(err, "failed to unmarshal package manifest %s", path) | ||
| } | ||
| } else { | ||
| // File exists but is empty. | ||
| pm = s.newPackageManifest() | ||
| } | ||
| } else { | ||
| return nil, errors.Wrapf(err, "package manifest %s", path) | ||
| } | ||
|
|
||
| if err := validatePackageManifest(pm); err != nil { | ||
| return nil, errors.Wrapf(err, "failed to validate package manifest %s", pm.PackageName) | ||
| } | ||
|
|
||
| if err = s.setChannels(pm); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| sort.Slice(pm.Channels, func(i int, j int) bool { | ||
| return pm.Channels[i].Name < pm.Channels[j].Name | ||
| }) | ||
|
|
||
| return yaml.Marshal(pm) | ||
| } | ||
|
|
||
| func (s *PackageManifest) newPackageManifest() *olmregistry.PackageManifest { | ||
| // Take the current CSV version to be the "alpha" channel, as an operator | ||
| // should only be designated anything more stable than "alpha" by a human. | ||
| channel := "alpha" | ||
| if s.Channel != "" { | ||
| channel = s.Channel | ||
| } | ||
| pm := &olmregistry.PackageManifest{ | ||
| PackageName: s.ProjectName, | ||
| Channels: []olmregistry.PackageChannel{ | ||
| {Name: channel, CurrentCSVName: getCSVName(s.ProjectName, s.CSVVersion)}, | ||
| }, | ||
| DefaultChannelName: channel, | ||
| } | ||
| return pm | ||
| } | ||
|
|
||
| func validatePackageManifest(pm *olmregistry.PackageManifest) error { | ||
| if pm.PackageName == "" { | ||
| return fmt.Errorf("package name cannot be empty") | ||
| } | ||
| if len(pm.Channels) == 0 { | ||
| return fmt.Errorf("channels cannot be empty") | ||
| } | ||
| if pm.DefaultChannelName == "" { | ||
| return fmt.Errorf("default channel cannot be empty") | ||
| } | ||
|
|
||
| seen := map[string]struct{}{} | ||
| for i, c := range pm.Channels { | ||
| if c.Name == "" { | ||
| return fmt.Errorf("channel %d name cannot be empty", i) | ||
| } | ||
| if c.CurrentCSVName == "" { | ||
| return fmt.Errorf("channel %s currentCSV cannot be empty", c.Name) | ||
| } | ||
| if _, ok := seen[c.Name]; ok { | ||
| return fmt.Errorf("duplicate package manifest channel name %s; channel names must be unique", c.Name) | ||
| } | ||
| seen[c.Name] = struct{}{} | ||
| } | ||
| if _, ok := seen[pm.DefaultChannelName]; !ok { | ||
| return fmt.Errorf("default channel %s does not exist in channels", pm.DefaultChannelName) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // setChannels checks for duplicate channels in pm and sets the default | ||
| // channel if possible. | ||
| func (s *PackageManifest) setChannels(pm *olmregistry.PackageManifest) error { | ||
| if s.Channel != "" { | ||
| pm.Channels = append(pm.Channels, olmregistry.PackageChannel{ | ||
| Name: s.Channel, | ||
| CurrentCSVName: getCSVName(s.ProjectName, s.CSVVersion), | ||
| }) | ||
| } | ||
|
|
||
| // Use s.Channel as the default channel if caller has specified it as the | ||
| // default. | ||
| if s.ChannelIsDefault && s.Channel != "" { | ||
| pm.DefaultChannelName = s.Channel | ||
| } | ||
| if pm.DefaultChannelName == "" { | ||
| log.Warn("Package manifest default channel is empty and should be set to an existing channel.") | ||
| } | ||
| defaultExists := false | ||
| for _, c := range pm.Channels { | ||
| if pm.DefaultChannelName == c.Name { | ||
| defaultExists = true | ||
| } | ||
| } | ||
| if !defaultExists { | ||
| log.Warnf("Package manifest default channel %s does not exist in channels.", pm.DefaultChannelName) | ||
| } | ||
|
|
||
| return nil | ||
| } |
Oops, something went wrong.