Add descriptions and samples to CSV #372
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #372 +/- ##
==========================================
- Coverage 66.14% 65.59% -0.55%
==========================================
Files 35 35
Lines 3843 3843
==========================================
- Hits 2542 2521 -21
- Misses 1113 1127 +14
- Partials 188 195 +7
Flags with carried forward coverage won't be shown. Click here to find out more.
|
grzpiotrowski
force-pushed
the
csv-crd-desc
branch
3 times, most recently
from
e946601 to
b99f99e
Compare
| @@ -4,6 +4,78 @@ metadata: | |||
| annotations: | |||
| alm-examples: |- | |||
| [ | |||
| { | |||
There was a problem hiding this comment.
I think these might need to be added in the MGC repo? I think this will get nuked when we do a new bundle as it is pulled in from MGC
There was a problem hiding this comment.
Right, here I just added the sample files manually to the kuadrant-operator/config/samples/kustomization.yaml from where they propagate to the examples in CSV.
Fetching these samples automatically from the MGC repo would make more sense I guess. I need to check how to do that in Kustomize. If not possible than I think the samples would need to be fetched in the make bundle script.
There was a problem hiding this comment.
ah I see. Yeah I mean I guess this is ok, but would be better to have them from the source
There was a problem hiding this comment.
hm. Ok, did some experimentation and looks like we could put a kustomization.yaml to have a remote base with the samples in the MGC repo. The samples for TLSPolicy, ManagedZone and DNSPolicy are already there.
And since the DNSHealthCheckProbe and DNSRecord are created by the controller I suppose there is no real need to expose examples for these two in the Operator Hub through the CSV?
The snipped below would go to: multicluster-gateway-controller/config/samples/kustomization.yaml:
resources:
- kuadrant.io_v1alpha1_tlspolicy.yaml
- kuadrant.io_v1alpha1_managedzone.yaml
- dnspolicy.yamlThen we could have a reference to it as a remote resource for kustomize in kuadrant-operator:
resources:
- github.com/Kuadrant/multicluster-gateway-controller/config/samples?ref=mainThis would let us keep the samples in one place and not worry about updating them manually in kuadrant-operator.
There was a problem hiding this comment.
sounds like a good option. If you open the PR I will take a look at it
There was a problem hiding this comment.
PR opened. I'll leave the link here as a cross reference: Add config/samples/kustomization.yaml #720
| @@ -31,6 +31,31 @@ spec: | |||
| kind: RateLimitPolicy | |||
| name: ratelimitpolicies.kuadrant.io | |||
| version: v1beta2 | |||
| - description: DNSHealthCheckProbe enables performing health checks against a DNS endpoint (A or CNAME record) | |||
| @@ -0,0 +1,10 @@ | |||
| apiVersion: kuadrant.io/v1alpha1 | |||
| @@ -0,0 +1,15 @@ | |||
| apiVersion: kuadrant.io/v1alpha1 | |||
There was a problem hiding this comment.
probably less valuable as really only the dns conrtroller creates these but it looks accurate
The changes were made in the base CSV file and persist when we regenerate the bundle |
grzpiotrowski
force-pushed
the
csv-crd-desc
branch
from
b99f99e to
5a818c4
Compare
|
Ok, so I made the changes to have the DNSPolicy, TLSPolicy and ManagedZone samples being pulled from MGC repo via kustomize remote base, instead of having the samples duplicated into kuadrant-operator repo. This is a screenshot of how it will appear in OperatorHub now: |
|
Bundle test failing now as multicluster-gateway-controller/pull/720 will need to be merged first. |
Fixes #369
Added descriptions to CSV template for:
Added a kustomize remote base for the yaml samples from MGC repo:
DNSRecord and DNSHealthCheckProbe sample not included since these are created by the controller.
Changes/suggestions very welcome.
The final looks in the OperatorHub can be checked by pasting the whole content of the generated kuadrant-operator.clusterserviceversion.yaml to the OperatorHub Preview tool.