Skip to content

Commit

Permalink
add note on overwriting CSV data
Browse files Browse the repository at this point in the history
  • Loading branch information
estroz committed Oct 30, 2018
1 parent 6f3918f commit e842ce4
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/design/milestone-0.1.1/csv-generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ type CSVUpdater interface {

`Apply` will use data from the `CSVUpdater` implementer to operate on `*v1alpha1.ClusterServiceVersion` object fields relevant to that updater. The OLM defines the entire CSV spec [in a Golang struct][olm-csv-spec-code] the SDK can alias to implement `CSVUpdater`s.

Once sub-step two is reached when creating or updating a CSV, `renderCSV` will extract each yaml document discovered, and pass document data into a dispatcher function. The dispatcher selects the correct `CSVUpdater` to call based on the documents' `Kind` yaml object, a manifest type identifier used in all operator manifests.
Once sub-step two is reached when creating or updating a CSV, `renderCSV` will extract each yaml document discovered, and pass document data into a dispatcher function. The dispatcher selects the correct `CSVUpdater` to call based on the documents' `Kind` yaml object, a manifest type identifier used in all operator manifests. A CSV should reflect the current state of an operators' yaml manifests and any codified components in general, so any fields that correspond to data gathered from codified components will be overwritten; data like English descriptions will not be unless updated data is found.

The following is an example implementation of an [install strategy][olm-csv-install-strat-doc] `CSVUpdater`:

Expand Down

0 comments on commit e842ce4

Please sign in to comment.