Skip to content

Commit c7a7846

Browse files
jeesmonEric Stroczynski
and
Eric Stroczynski
authored
doc: CSV marker for fixing olm-crds-have-resources-test (#4736)
Signed-off-by: Jeesmon Jacob <[email protected]> Co-authored-by: Eric Stroczynski <[email protected]>
1 parent 5957f57 commit c7a7846

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

website/content/en/docs/advanced-topics/scorecard/scorecard.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ for an overview of command invocation.
5252
## Configuration
5353

5454
The scorecard test execution is driven by a configuration file named `config.yaml`, generated by `make bundle`. Note that if run `make bundle` that any
55-
changes you have made to `config.yaml` will be overwritten. To persist
56-
any changes to `config.yaml` you can update the kustomize templates found in the
55+
changes you have made to `config.yaml` will be overwritten. To persist
56+
any changes to `config.yaml` you can update the kustomize templates found in the
5757
`config/scorecard` directory.
5858
The configuration file is located at the following location within your bundle directory (`bundle/` by default):
5959
```sh
@@ -114,7 +114,7 @@ $ operator-sdk scorecard <bundle_dir_or_image> [flags]
114114

115115
The scorecard requires a positional argument that holds either the
116116
on-disk path to your operator bundle or the name of a bundle image. Note
117-
that the scorecard does not run your operator but merely uses
117+
that the scorecard does not run your operator but merely uses
118118
the scorecard configuration within the bundle contents to know which tests
119119
to execute.
120120

@@ -180,7 +180,7 @@ The scorecard ships with pre-defined tests that are arranged into suites.
180180
| -------- | -------- | -------- |
181181
| Bundle Validation | This test validates the bundle manifests found in the bundle that is passed into scorecard. If the bundle contents contain errors, then the test result output will include the validator log as well as error messages from the validation library. See this [document][olm-bundle] for details on bundles.| olm-bundle-validation-test |
182182
| Provided APIs have validation |This test verifies that the CRDs for the provided CRs contain a validation section and that there is validation for each spec and status field detected in the CR. | olm-crds-have-validation-test |
183-
| Owned CRDs Have Resources Listed | This test makes sure that the CRDs for each CR provided via the `cr-manifest` option have a `resources` subsection in the [`owned` CRDs section][owned-crds] of the CSV. If the test detects used resources that are not listed in the resources section, it will list them in the suggestions at the end of the test. Users are required to fill out the resources section after initial code generation for this test to pass. | olm-crds-have-resources-test |
183+
| Owned CRDs Have Resources Listed | This test makes sure that the CRDs for each CR provided via the `cr-manifest` option have a `resources` subsection in the [`owned` CRDs section][owned-crds] of the CSV. If the test detects used resources that are not listed in the resources section, it will list them in the suggestions at the end of the test. Users are required to fill out the resources section after initial code generation for this test to pass. For Go-based operators, use ClusterServiceVersion [API Markers](/docs/building-operators/golang/references/markers) to add resources. | olm-crds-have-resources-test |
184184
| Spec Fields With Descriptors | This test verifies that every field in the Custom Resources' spec sections have a corresponding descriptor listed in the CSV.| olm-spec-descriptors-test |
185185
| Status Fields With Descriptors | This test verifies that every field in the Custom Resources' status sections have a corresponding descriptor listed in the CSV.| olm-status-descriptors-test |
186186

website/content/en/docs/building-operators/golang/references/markers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ These examples assume `Memcached`, `MemcachedSpec`, and `MemcachedStatus` are th
112112
type MemcachedPods struct {
113113
// Size is the size of the memcached deployment.
114114
//+operator-sdk:csv:customresourcedefinitions:type=spec
115-
//+operator-sdk:csv:customresourcedefinitions.type=status
115+
//+operator-sdk:csv:customresourcedefinitions:type=status
116116
Size int32 `json:"size"`
117117
}
118118
```

0 commit comments

Comments
 (0)