Skip to content

Commit e842ce4

Browse files
committed
add note on overwriting CSV data
1 parent 6f3918f commit e842ce4

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

doc/design/milestone-0.1.1/csv-generation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ type CSVUpdater interface {
4545

4646
`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.
4747

48-
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.
48+
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.
4949

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

0 commit comments

Comments
 (0)