Skip to content
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

Add description markers for dataupload and datadownload CRDs #7028

Merged
merged 1 commit into from
Oct 27, 2023

Conversation

shubham-pampattiwar
Copy link
Collaborator

Thank you for contributing to Velero!

Please add a summary of your change

Add description markers for dataupload and datadownload CRDs

Does your change fix a particular issue?

Related to openshift/oadp-operator#1204

Please indicate you've done the following:

  • Accepted the DCO. Commits without the DCO will delay acceptance.
  • Created a changelog file or added /kind changelog-not-required as a comment on this pull request.
  • Updated the corresponding documentation in site/content/docs/main.

Signed-off-by: Shubham Pampattiwar <[email protected]>

add changelog file

Signed-off-by: Shubham Pampattiwar <[email protected]>
@codecov
Copy link

codecov bot commented Oct 27, 2023

Codecov Report

Merging #7028 (4dbb262) into main (9ff4b1e) will decrease coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #7028      +/-   ##
==========================================
- Coverage   61.03%   61.00%   -0.03%     
==========================================
  Files         252      252              
  Lines       26898    26898              
==========================================
- Hits        16417    16409       -8     
- Misses       9319     9326       +7     
- Partials     1162     1163       +1     

see 1 file with indirect coverage changes

@@ -131,6 +131,7 @@ type DataDownloadStatus struct {
// +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Time duration since this DataDownload was created"
// +kubebuilder:printcolumn:name="Node",type="string",JSONPath=".status.node",description="Name of the node where the DataDownload is processed"

// DataDownload acts as the protocol between data mover plugins and data mover controller for the datamover restore operation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One thing I would add is that users should not create it, Velero creates it

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

User actions aren't referenced in any of the description markers for the CRDs -- that's something that is probably better handled in the user documentation. Also, the description that was added implies that it's not user-managed in any case -- there are several velero CRDs that are like this, it's not unique to these two.

@sseago sseago merged commit 23921e5 into vmware-tanzu:main Oct 27, 2023
23 of 24 checks passed
shubham-pampattiwar added a commit to shubham-pampattiwar/velero that referenced this pull request Oct 31, 2023
…tanzu#7028)

add changelog file

Signed-off-by: Shubham Pampattiwar <[email protected]>
(cherry picked from commit 23921e5)
shubham-pampattiwar added a commit to shubham-pampattiwar/velero that referenced this pull request Oct 31, 2023
…tanzu#7028)

add changelog file

Signed-off-by: Shubham Pampattiwar <[email protected]>
(cherry picked from commit 23921e5)

rename changelog file

Signed-off-by: Shubham Pampattiwar <[email protected]>
shubham-pampattiwar added a commit to shubham-pampattiwar/velero that referenced this pull request Nov 7, 2023
…tanzu#7028)

add changelog file

Signed-off-by: Shubham Pampattiwar <[email protected]>
(cherry picked from commit 23921e5)

rename changelog file

Signed-off-by: Shubham Pampattiwar <[email protected]>

fix PR CI validation errors

Signed-off-by: Shubham Pampattiwar <[email protected]>
blackpiglet added a commit that referenced this pull request Jan 17, 2024
…12-rel

Add description markers for dataupload and datadownload CRDs (#7028)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants