-
Notifications
You must be signed in to change notification settings - Fork 72
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve ClusterServiceVersion schema #168
Improve ClusterServiceVersion schema #168
Conversation
I realize now after opening this that the manifests are generated files. First time contributing to an API repo like this, so I'll research a bit more and update this. |
/hold |
/hold cancel |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
/ok-to-test |
@camilamacedo86 I rebased this and added a few more descriptions to the CSV API so it will need another review/lgtm |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/approve
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: dinhxuanvu, TheRealJon The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
@dinhxuanvu could you please retag the PR ? thanks ! :) |
It seems blocked by the resolution in : operator-framework/operator-lifecycle-manager#2767 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks like a helpful PR, and does improve the descriptions on the CSV API, but there is an issue with the size of the CRD when applied via kubectl apply
as the last-applied-configuration
annotation becomes too large for the server to accept. Increasing the size of the openapi schema will further complicate this issue.
The long term solution is to limit the depth of the codegen generated for the openapi spec, to prevent this issue from occurring. That being said I don't know whether we should prevent this PR from going in based on the issue, until the longer term fix is prepared.
Yes, and I would go further to say that these changes are a necessary improvement. The lack of documentation on these APIs has led to confusion about their usage and, a few bugs have been reported. Better docs would have saved a lot of time and effort spent for each bug that has been opened for this.
If I'm understanding correctly, the annotation size error has already been encountered and a workaround has been implemented. If that's the case, does this PR pose any further risk?
Would limiting the codegen depth prevent deeper APIs from having docs generated? |
@msugakov |
This PR is blocked by operator-framework/operator-lifecycle-manager#2778 |
@camilamacedo86 @exdx @porridge I've rebased this PR. Could we revisit getting this merged? |
@TheRealJon you might need to do a make manifests or make verify to fix the verify stage |
@perdasilva I've updated it, hopefully, this should pass now. |
/lgtm |
/hold to see if we can catch a review (lgtm) from one of the historical participants |
+1, lgtm too, thanks for your PR @TheRealJon ! |
@dinhxuanvu I brought this up in the k8s Slack #olm-dev channel to loop @grokspawn in. If both of you are in agreement, I think this is ready to merge. |
Add descriptions for kind, name, and version properties of APIResourceReference type as well as DisplayName, Description, Keywords, Maintainers, Provider, Links, and Icon properties of ClusterServiceVersionSpec.
@joelanford @grokspawn I've updated the wording to be more clear. PTAL! |
/hold cancel releasing this since it looks like we had some good dialog and reached a consensus. |
/lgtm Thanks! |
Fixes #167
Add descriptions for kind, name, and version properties of APIResourceReference type as well as DisplayName, Description, Keywords, Maintainers, Provider, Links, and Icon properties of ClusterServiceVersionSpec.