Add better information for OperatorHub

[alexsnaps]

Attempt to fix #328

• Add description to RateLimitPolicy & AuthPolicy
• Add (display?) name to RateLimitPolicy & AuthPolicy
• Add an example to AuthPolicy
• Add new CRDs? See remove deployment of policy-controller for now #338

[codecov]

Codecov Report

Merging #330 (7cee3b3) into main (2740b79) will decrease coverage by 0.32%.
The diff coverage is n/a.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #330      +/-   ##
==========================================
- Coverage   65.10%   64.78%   -0.32%     
==========================================
  Files          35       35              
  Lines        3797     3797              
==========================================
- Hits         2472     2460      -12     
- Misses       1130     1139       +9     
- Partials      195      198       +3     

Flag	Coverage Δ
integration	69.54% <ø> (-0.60%)	⬇️
unit	59.40% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
api/v1beta1 (u)	∅ <ø> (∅)
pkg/common (u)	76.92% <ø> (ø)
pkg/istio (u)	30.24% <ø> (ø)
pkg/log (u)	31.81% <ø> (ø)
pkg/reconcilers (u)	33.33% <ø> (ø)
pkg/rlptools (u)	56.46% <ø> (ø)
controllers (i)	69.54% <ø> (-0.60%)	⬇️

Files	Coverage Δ
api/v1beta2/authpolicy_types.go	77.57% <ø> (ø)
api/v1beta2/ratelimitpolicy_types.go	26.86% <ø> (ø)

... and 5 files with indirect coverage changes

[grzpiotrowski]

Did a bit of searching and to get the AuthPolicy and RateLimitPolicy CRD's names displayed correctly it looks like we need to add a displayName in the spec -> customresourcedefinitions -> owned section of the CSV. Like so:

customresourcedefinitions:
    owned:
    - kind: AuthPolicy
      name: authpolicies.kuadrant.io
      version: v1beta2
      displayName: AuthPolicy
    - description: Kuadrant is the Schema for the kuadrants API
      displayName: Kuadrant
      kind: Kuadrant
      name: kuadrants.kuadrant.io
      version: v1beta1
    - kind: RateLimitPolicy
      name: ratelimitpolicies.kuadrant.io
      version: v1beta2
      displayName: RateLimitPolicy

Tested in the viewer here

[alexsnaps]

This integration test can be ignored:

2023-11-23T16:05:38.4177912Z �[38;5;9m• [FAILED] [32.090 seconds]�[0m
2023-11-23T16:05:38.4180192Z �[0mRateLimitPolicy controller �[38;5;243mRLP targeting Gateway �[38;5;9m�[1m[It] Creates all the resources for a basic Gateway and RateLimitPolicy�[0m
2023-11-23T16:05:38.4182033Z �[38;5;243m/home/runner/work/kuadrant-operator/kuadrant-operator/controllers/ratelimitpolicy_controller_test.go:419�[0m
2023-11-23T16:05:38.4182780Z 
2023-11-23T16:05:38.4182996Z   �[38;5;9m[FAILED] Unexpected error:
2023-11-23T16:05:38.4183553Z       <*errors.StatusError | 0xc000ce26e0>: 
2023-11-23T16:05:38.4184736Z       wasmplugins.extensions.istio.io "kuadrant-toystore-gw" not found
2023-11-23T16:05:38.4185343Z       {
2023-11-23T16:05:38.4185774Z           ErrStatus: {
2023-11-23T16:05:38.4186395Z               TypeMeta: {Kind: "", APIVersion: ""},
2023-11-23T16:05:38.4186971Z               ListMeta: {
2023-11-23T16:05:38.4187663Z                   SelfLink: "",
2023-11-23T16:05:38.4188234Z                   ResourceVersion: "",
2023-11-23T16:05:38.4188691Z                   Continue: "",
2023-11-23T16:05:38.4189366Z                   RemainingItemCount: nil,
2023-11-23T16:05:38.4189868Z               },
2023-11-23T16:05:38.4190194Z               Status: "Failure",
2023-11-23T16:05:38.4191309Z               Message: "wasmplugins.extensions.istio.io \"kuadrant-toystore-gw\" not found",
2023-11-23T16:05:38.4191974Z               Reason: "NotFound",
2023-11-23T16:05:38.4192430Z               Details: {
2023-11-23T16:05:38.4193030Z                   Name: "kuadrant-toystore-gw",
2023-11-23T16:05:38.4193558Z                   Group: "extensions.istio.io",
2023-11-23T16:05:38.4194138Z                   Kind: "wasmplugins",
2023-11-23T16:05:38.4194600Z                   UID: "",
2023-11-23T16:05:38.4195147Z                   Causes: nil,
2023-11-23T16:05:38.4195559Z                   RetryAfterSeconds: 0,
2023-11-23T16:05:38.4196171Z               },
2023-11-23T16:05:38.4196663Z               Code: 404,
2023-11-23T16:05:38.4197158Z           },
2023-11-23T16:05:38.4197572Z       }

It is being addressed as part of #331

[grzpiotrowski]

If all is correct then one more task left, to add new CRDs or rather add them to the config CSV so they also have a nice name displayed, description + samples?

[alexsnaps]

@grzpiotrowski Given what happened with #338, that last task is obsolete…
So I guess this is done & ready for review/merging, right?

[grzpiotrowski]

Yes, this should be good to merge in that case.
I pushed again rebasing on top of main and with some small corrections to the owned CRDs descirptions in the config CSV to match with the spelling in the doc comments.

The new CRDs are still present in the bundle manifests but I see they'll be deleted by that other PR.

[grzpiotrowski]

To test how it will render on Operator Hub, paste the whole CSV from the bundle here:
Operator Preview

[grzpiotrowski]

How it would look like now:

[guicassolato]

LGTM