Skip to content

Commit bf46e70

Browse files
committed
doc/design/milestone-0.0.7/csv-generation.md: fix link
1 parent 0075fb5 commit bf46e70

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Goal
44

5-
The `operator-sdk generate olm-catalog` sub-command should generate a [**Cluster Service Version (CSV)**](olm-csv-definition) customized using information contained in user-defined yaml manifests and Golang source files. Operator developers, *users*, should be able to run `operator-sdk generate olm-catalog` and have their operators' state encapsulated in a CSV; this command should be idempotent and only update the CSV when a yaml manifest or Golang source file is changed. Users should not have to directly interact with a CSV, and should not be required to have in-depth CSV knowledge in order for their operator to interact with [**Operator Lifecycle Manager (OLM)**](olm-description) or publish metadata to the [**Catalog**](catalog-description)
5+
The `operator-sdk generate olm-catalog` sub-command should generate a [**Cluster Service Version (CSV)**][olm-csv-definition] customized using information contained in user-defined yaml manifests and Golang source files. Operator developers, *users*, should be able to run `operator-sdk generate olm-catalog` and have their operators' state encapsulated in a CSV; this command should be idempotent and only update the CSV when a yaml manifest or Golang source file is changed. Users should not have to directly interact with a CSV, and should not be required to have in-depth CSV knowledge in order for their operator to interact with [**Operator Lifecycle Manager (OLM)**][olm-description] or publish metadata to the [**Catalog**][catalog-description].
66

77
## Background
88

@@ -20,7 +20,7 @@ The `operator-sdk generate olm-catalog` command currently produces a generic CSV
2020

2121
1. Create a new CSV, with the same location and naming convention as exists currently, using available data in yaml manifests and Golang source files.
2222

23-
1. `renderCSV` will check for an existing CSV in `deploy`. Upon not finding one, a [`ClusterServiceVersion` struct instance](olm-code-csv-struct), defined by the OLM, is created and fields easily derived from operator metadata, such as Kubernetes API `ObjectMeta`, are populated.
23+
1. `renderCSV` will check for an existing CSV in `deploy`. Upon not finding one, a [`ClusterServiceVersion` instance][olm-code-csv-struct], defined by the OLM, is created and fields easily derived from operator metadata, such as Kubernetes API `ObjectMeta`, are populated.
2424
1. `renderCSV` will search `deploy` for manifests that contain yaml objects a CSV uses, such as a `Deployment` Kubernetes API resource, and cache found objects in a CSV struct
2525
1. Once this search completes, every cache instance field populated will be written back to the CSV yaml file. Note that individual yaml objects are overwritten and not the entire file.
2626

@@ -35,7 +35,7 @@ The `operator-sdk generate olm-catalog` command currently produces a generic CSV
3535
## Reference
3636

3737

38-
[olm-csv-definition]: https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md#what-is-a-cluster-service-version-csv
39-
[olm-description]: https://github.com/operator-framework/operator-lifecycle-manager/blob/master/README.md
40-
[catalog-description]: https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/architecture.md#catalog-registry-design
41-
[olm-code-csv-struct]: https://github.com/operator-framework/operator-lifecycle-manager/blob/master/pkg/api/apis/operators/v1alpha1/clusterserviceversion_types.go
38+
[olm-csv-definition]:https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md#what-is-a-cluster-service-version-csv
39+
[olm-description]:https://github.com/operator-framework/operator-lifecycle-manager/blob/master/README.md
40+
[catalog-description]:https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/architecture.md#catalog-registry-design
41+
[olm-code-csv-struct]:https://github.com/operator-framework/operator-lifecycle-manager/blob/8799f39ef342dc1ff7430eba7a88c1c3c70cbdcc/pkg/api/apis/operators/v1alpha1/clusterserviceversion_types.go#L261

0 commit comments

Comments
 (0)