cmd/operator-sdk/olmcatalog/gen-csv.go: --write-config to write CSV config to disk #1346
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -17,6 +17,7 @@ package olmcatalog | |
| import ( | ||
| "fmt" | ||
| "io/ioutil" | ||
| "os" | ||
| "path/filepath" | ||
| "strings" | ||
|
|
||
|
|
@@ -56,18 +57,18 @@ Configure CSV generation by writing a config file 'deploy/olm-catalog/csv-config | |
| genCSVCmd.Flags().StringVar(&csvVersion, "csv-version", "", "Semantic version of the CSV") | ||
| genCSVCmd.MarkFlagRequired("csv-version") | ||
| genCSVCmd.Flags().StringVar(&fromVersion, "from-version", "", "Semantic version of an existing CSV to use as a base") | ||
| genCSVCmd.Flags().StringVar(&csvConfigPath, "csv-config", "", "Path to CSV config file. If unset, default file paths are used") | ||
|
Contributor
There was a problem hiding this comment. I think is good to keep the default path in the info. |
||
| genCSVCmd.Flags().BoolVar(&updateCRDs, "update-crds", false, "Update CRD manifests in deploy/{operator-name}/{csv-version} the using latest API's") | ||
|
|
||
| return genCSVCmd | ||
| } | ||
|
|
||
| func genCSVFunc(cmd *cobra.Command, args []string) (err error) { | ||
| if len(args) != 0 { | ||
| return fmt.Errorf("command %s doesn't accept any arguments", cmd.CommandPath()) | ||
| } | ||
|
|
||
| if err = verifyGenCSVFlags(); err != nil { | ||
| return err | ||
| } | ||
|
|
||
|
|
@@ -79,30 +80,46 @@ func genCSVFunc(cmd *cobra.Command, args []string) error { | |
| if projutil.IsOperatorGo() { | ||
| cfg.Repo = projutil.CheckAndGetProjectGoPkg() | ||
| } | ||
| s := &scaffold.Scaffold{} | ||
|
|
||
| if cmd.Flags().Changed(writeCSVConfigOpt) { | ||
| if err := writeConfig(s, cfg); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| var csvCfgFile *catalog.CSVConfigFile | ||
| if _, err = os.Stat(csvConfigPath); err == nil { | ||
| log.Infof("Using custom CSV config %s.", csvConfigPath) | ||
| csvCfgFile, err = catalog.GetCSVConfigFile(csvConfigPath) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } else if err != nil && csvConfigPath != "" { | ||
| return fmt.Errorf("error reading CSV config %s: %v", csvConfigPath, err) | ||
| } else { | ||
| log.Info("Using default CSV config.") | ||
| csvCfgFile = &catalog.CSVConfigFile{} | ||
| } | ||
|
|
||
|
Contributor
There was a problem hiding this comment. could not it be improved? |
||
| log.Infof("Generating CSV manifest version %s", csvVersion) | ||
|
|
||
| csv := &catalog.CSV{ | ||
| CSVVersion: csvVersion, | ||
| FromVersion: fromVersion, | ||
| CSVConfigFile: csvCfgFile, | ||
| } | ||
| if err := s.Execute(cfg, csv); err != nil { | ||
| return fmt.Errorf("catalog scaffold failed: (%v)", err) | ||
| } | ||
|
|
||
| // Write CRD's to the new or updated CSV package dir. | ||
| if updateCRDs { | ||
| i, err := csv.GetInput() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| err = writeCRDsToDir(csvCfgFile.CRDCRPaths, filepath.Dir(i.Path)) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -180,6 +180,10 @@ pkg/apis/app/v1alpha1/ | |
|
|
||
| Parent command for all OLM Catalog related commands. | ||
|
|
||
| #### Flags | ||
|
|
||
| * `--write-csv-config` string or empty - Write a default CSV config file. A default path is used if no value is provided. Set --write-csv-config=<path> to supply a non-default path | ||
|
|
||
| ### gen-csv | ||
|
|
||
| Writes a Cluster Service Version (CSV) manifest and optionally CRD files to `deploy/olm-catalog/{operator-name}/{csv-version}`. | ||
|
|
@@ -188,7 +192,8 @@ Writes a Cluster Service Version (CSV) manifest and optionally CRD files to `dep | |
|
|
||
| * `--csv-version` string - (required) Semantic version of the CSV manifest. | ||
| * `--from-version` string - Semantic version of CSV manifest to use as a base for a new version. | ||
| * `--csv-config` string - Path to CSV config file. If unset, default file paths are used | ||
| * `--write-csv-config` string or empty - Write a default CSV config file. A default path is used if no value is provided. Set --write-csv-config=<path> to supply a non-default path | ||
| * `--update-crds` Update CRD manifests in deploy/{operator-name}/{csv-version} using the latest CRD manifests. | ||
|
|
||
| #### Example | ||
|
|
||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -17,23 +17,23 @@ Operator SDK projects have an expected [project layout][doc-project-layout]. In | |
|
|
||
| `gen-csv` reads these files and adds their data to a CSV in an alternate form. | ||
|
|
||
| Both `olm-catalog` and `olm-catalog gen-csv` can write a CSV configuration file that configures parts of the CSV generation process. By setting `--write-csv-config`, these commands write a default CSV config file to `deploy/olm-catalog/csv-config.yaml`; setting `--write-csv-confg=<path>` will write a default config file to `path` instead. The defaults written in the following fields contain paths to the aforementioned files: | ||
|
|
||
| - `crd-cr-paths`: string , { string } - a list of CRD and CR manifest file/directory paths. Defaults to `[deploy/crds]`. | ||
| - `operator-path`: string - the operator `Deployment` manifest file path. Defaults to `deploy/operator.yaml`. | ||
| - `role-path`: string - the RBAC `Role` manifest file path. Defaults to `deploy/role.yaml`. | ||
|
|
||
| **Note**: The [design doc][doc-csv-design] has outdated field information which should not be referenced. | ||
|
|
||
| Fields in this config file can be modified to point towards alternate manifest locations, and passed to `gen-csv --csv-config=<path>` to configure CSV generation. For example, if I have one set of production CR/CRD manifests under `deploy/crds/production`, and a set of test manifests under `deploy/crds/test`, and I only want to include production manifests in my CSV, I can set `crd-cr-paths: [deploy/crds/production]`. `gen-csv` will then ignore `deploy/crds/test` when getting CR/CRD data. | ||
|
|
||
| ## Versioning | ||
|
|
||
| CSV's are versioned in path, file name, and in their `metadata.name` field. For example, running `operator-sdk olm-catalog gen-csv --csv-version 0.0.1` will generate a CSV at `deploy/olm-catalog/<operator-name>/0.0.1/<operator-name>.v0.0.1.clusterserviceversion.yaml`. A versioned directory such as `deploy/olm-catalog/<operator-name>/0.0.1` is known as a [*bundle*][doc-bundle]. Versions allow the OLM to upgrade or downgrade your Operator at runtime, i.e. in a cluster. A valid semantic version is required. | ||
|
|
||
| `gen-csv` allows you to upgrade your CSV using the `--from-version` flag. If you have an existing CSV with version `0.0.1` and want to write a new version `0.0.2`, you can run `operator-sdk olm-catalog gen-csv --csv-version 0.0.2 --from-version 0.0.1`. This will write a new CSV manifest to `deploy/olm-catalog/<operator-name>/0.0.2/<operator-name>.v0.0.2.clusterserviceversion.yaml` containing user-defined data from `0.0.1` and any modifications you've made to `roles.yaml`, `operator.yaml`, CR's, or CRD's. | ||
|
|
||
| The SDK can manage CRD's in your Operator bundle as well. You can pass the `--update-crds` flag to `gen-csv` to add or update your CRD's in your bundle by copying manifests pointed to by `crd-cr-paths` in your config. CRD's in a bundle are not updated by default. | ||
|
|
||
| ## First Generation | ||
|
|
||
|
|
@@ -89,7 +89,7 @@ Required: | |
| * `spec.labels`: (user) a list of `key:value` pairs to be used by Operator internals. | ||
| * `spec.version`: semantic version of the Operator, ex. `0.1.1`. | ||
| * `spec.installModes`: what mode of [installation namespacing][install-modes] OLM should use. Currently all but `MultiNamespace` are supported by SDK Operators. | ||
| * `spec.customresourcedefinitions`: any CRD's the Operator uses. This field will be filled by the SDK if any CRD manifests pointed to by `crd-cr-paths` in your config. | ||
| * `description`: description of the CRD. | ||
| * `resources`: any Kubernetes resources used by the CRD, ex. `Pod`'s and `ConfigMap`'s. | ||
| * `specDescriptors`: UI hints for inputs and outputs of the Operator's spec. | ||
|
|
||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -33,7 +33,6 @@ const ( | |
| BuildBinDir = BuildDir + filePathSep + "_output" + filePathSep + "bin" | ||
| BuildScriptDir = BuildDir + filePathSep + "bin" | ||
| DeployDir = "deploy" | ||
| CRDsDir = DeployDir + filePathSep + "crds" | ||
| VersionDir = "version" | ||
| ) | ||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -21,13 +21,50 @@ import ( | |
| "path/filepath" | ||
|
|
||
| "github.com/operator-framework/operator-sdk/internal/pkg/scaffold" | ||
| "github.com/operator-framework/operator-sdk/internal/pkg/scaffold/input" | ||
|
|
||
| "github.com/ghodss/yaml" | ||
| "github.com/spf13/afero" | ||
| ) | ||
|
|
||
| const CSVConfigYamlFile = "csv-config.yaml" | ||
|
|
||
| // CSVConfig is a scaffold wrapper for CSVConfig such that CSVConfig's can | ||
| // be marshalled and unmarshalled correctly. | ||
| type CSVConfig struct { | ||
| input.Input | ||
| File *CSVConfigFile | ||
|
|
||
| // TODO: remove once fs is moved to input.Input. | ||
| fs afero.Fs | ||
| } | ||
|
|
||
| var _ input.File = &CSVConfig{} | ||
|
|
||
| func (c *CSVConfig) GetInput() (input.Input, error) { | ||
| if c.Path == "" { | ||
| c.Path = filepath.Join(OLMCatalogDir, CSVConfigYamlFile) | ||
| } | ||
| if c.File == nil { | ||
| c.File = &CSVConfigFile{} | ||
| } | ||
| return c.Input, nil | ||
| } | ||
|
|
||
| var _ scaffold.CustomRenderer = &CSVConfig{} | ||
|
|
||
| func (c *CSVConfig) SetFS(fs afero.Fs) { c.fs = fs } | ||
|
|
||
| func (c *CSVConfig) CustomRender() ([]byte, error) { | ||
| if err := c.File.setFields(); err != nil { | ||
| return nil, err | ||
| } | ||
| return yaml.Marshal(c.File) | ||
| } | ||
|
|
||
| // CSVConfigFile is a configuration file for CSV composition. Its fields contain | ||
| // file path information. | ||
| type CSVConfigFile struct { | ||
| // The operator manifest file path. Defaults to deploy/operator.yaml. | ||
| OperatorPath string `json:"operator-path,omitempty"` | ||
| // The RBAC role manifest file path. Defaults to deploy/role.yaml. | ||
|
|
@@ -36,11 +73,10 @@ type CSVConfig struct { | |
| CRDCRPaths []string `json:"crd-cr-paths,omitempty"` | ||
| } | ||
|
|
||
| func GetCSVConfigFile(path string) (*CSVConfigFile, error) { | ||
| cfg := &CSVConfigFile{} | ||
| if _, err := os.Stat(path); err == nil { | ||
| cfgData, err := ioutil.ReadFile(path) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
@@ -59,7 +95,11 @@ func GetCSVConfig(cfgFile string) (*CSVConfig, error) { | |
|
|
||
| const yamlExt = ".yaml" | ||
|
|
||
| func isYAMLFile(path string) bool { | ||
| return filepath.Ext(path) == yamlExt | ||
| } | ||
|
|
||
| func (c *CSVConfigFile) setFields() error { | ||
| if c.OperatorPath == "" { | ||
| info, err := (&scaffold.Operator{}).GetInput() | ||
| if err != nil { | ||
|
|
@@ -101,7 +141,7 @@ func (c *CSVConfig) setFields() error { | |
| seen[p] = struct{}{} | ||
| } | ||
| } | ||
| } else if isYAMLFile(path) { | ||
| if _, ok := seen[path]; !ok { | ||
| paths = append(paths, path) | ||
| seen[path] = struct{}{} | ||
|
|
@@ -122,7 +162,7 @@ func getManifestPathsFromDir(dir string) (paths []string, err error) { | |
| if info == nil { | ||
| return fmt.Errorf("file info for %s was nil", path) | ||
| } | ||
| if !info.IsDir() && isYAMLFile(path) { | ||
| paths = append(paths, path) | ||
| } | ||
| return nil | ||
|
|
||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -25,7 +25,7 @@ import ( | |
| func TestConfig(t *testing.T) { | ||
| crdsDir := filepath.Join(testDataDir, scaffold.CRDsDir) | ||
|
|
||
| cfg := &CSVConfigFile{ | ||
| CRDCRPaths: []string{crdsDir}, | ||
| } | ||
| if err := cfg.setFields(); err != nil { | ||
|
|
@@ -35,9 +35,7 @@ func TestConfig(t *testing.T) { | |
| t.Errorf("Wanted 3 crd/cr files, got: %v", cfg.CRDCRPaths) | ||
| } | ||
|
|
||
| cfg.CRDCRPaths = []string{crdsDir, filepath.Join(crdsDir, "app_v1alpha1_app_crd.yaml")} | ||
| if err := cfg.setFields(); err != nil { | ||
| t.Errorf("Set fields crd-cr paths dir file mix: (%v)", err) | ||
| } | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
space