-
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
OADP-2959: Add missing descriptions to all CRDs #1200
Conversation
mpryc
commented
Oct 26, 2023
•
edited
Loading
edited
Skipping CI for Draft Pull Request. |
bcdde5c
to
52ee895
Compare
/jira refresh |
@mpryc: No Jira issue is referenced in the title of this pull request. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
@mpryc: This pull request references OADP-2959 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target either version "4.15." or "openshift-4.15.", but it targets "OADP 1.3.0" instead. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
displayName: StartTimestamp | ||
path: startTimestamp | ||
version: v2alpha1 | ||
- description: VolumeSnapshotBackup is the Schema for the volumesnapshotbackups |
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.
VSB and VSR do not exist in master anymore, this can be applied to others branch
@@ -314,6 +314,164 @@ spec: | |||
displayName: Phase | |||
path: phase | |||
version: v1 | |||
- description: DataDownload represents a data download of a volume snapshot. There |
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.
Lets wait for rebase to get @shubham-pampattiwar PR for descriptions of DU and DD CRDs?
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.
yeah @mateusoliveira43 I can do a cherry-pick against openshift/velero if needed, upstream PR is merged @mpryc
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.
We won't be doing any more rebases to konveyor-dev until we've created oadp-1.3 branches, since we're already on the upstream release we're shipping for 1.3 -- any upstream commits needed for 1.3 will need to be cherry-picked via PR.
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.
ok ok, I will create a cherry-pick PR
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.
So there won't be any rebase meaning this PR is ok'ish and should be valid for the master. If there is any update removal of description needed following this patch it should be removed with PR. Am I understanding this correctly?
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.
I would remove changes related to DUCR and DDCR from this PR. As they will be automatically picked up once the Velero CRDs are updated.
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.
Will they? This is the bases manifest for the top level CSV so I don't think we have any automagic which is updating this file?
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.
I mean it's not the config/crd/bases/*.yaml
it's the config/manifests/bases/*.yaml
. The first one is for the description in the config object and those are automatically picked from the CRDs, however the second one living n the config/manifests/bases/*.yaml
applies to our top level operator and as such it's not automatically synced from any other resources.
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.
As they will be automatically picked up once the Velero CRDs are updated.
The description wouldn't be picked up automatically.
The operator-sdk bundle generation only automate Name, Version, Kind into bundle/CSV.
for _, defKey := range defKeys {
if owned, ownedExists := descMap[defKey]; ownedExists {
ownedDescs = append(ownedDescs, owned)
} else {
ownedDescs = append(ownedDescs, operatorsv1alpha1.CRDDescription{
Name: defKey.Name,
Version: defKey.Version,
Kind: defKey.Kind,
})
}
}
https://redhat-internal.slack.com/archives/C0144ECKUJ0/p1698773258374849
Still have to put in description manually and phase/specDescriptors if desired.
/retest |
@@ -289,8 +328,46 @@ spec: | |||
displayName: Conditions | |||
path: conditions | |||
version: v1alpha1 | |||
- kind: DataUpload | |||
- description: DataUpload represents a data upload of a volume snapshot. There |
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.
Please add the descriptions that got merged upstream: https://github.com/vmware-tanzu/velero/pull/7028/files
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.
Changed.
Adds missing descriptions to the following CRDs: - DataDownload - DataUpload - VolumeSnapshotBackup - VolumeSnapshotRestore - CloudStorage Signed-off-by: Michal Pryc <[email protected]>
@mpryc: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
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.
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.
Sounds like we're ok adding ignored descriptions because it's easier in the moment. Follow up to remove perhaps.
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: kaovilai, mpryc, sseago, weshayutin 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 |
/lgtm |
VSB and VSR need to be removed from the master branch. They are unnecessary in OADP 1.3+, but they also don't pose any harm. In the absence of the VSB and VSR in the CRD's / OCP APIs, the description will not be displayed, so adding extra description won't create any issues. For OADP 1.2, this will be a straightforward backport from the master branch because it contains VSB and VSR, which are required in OADP 1.2. |
…t#1200) Adds missing descriptions to the following CRDs: - DataDownload - DataUpload - VolumeSnapshotBackup - VolumeSnapshotRestore - CloudStorage Signed-off-by: Michal Pryc <[email protected]>
…1213) Adds missing descriptions to the following CRDs: - DataDownload - DataUpload - VolumeSnapshotBackup - VolumeSnapshotRestore - CloudStorage Signed-off-by: Michal Pryc <[email protected]>