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.

Sign up for GitHub

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
Merged

Add description markers for dataupload and datadownload CRDs #7028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/unreleased/7028-shubham-pampattiwar
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add description markers for dataupload and datadownload CRDs
6 changes: 6 additions & 0 deletions config/crd/v1/bases/velero.io_restores.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,12 @@ spec:
- Continue
- Fail
type: string
waitForReady:
description: WaitForReady ensures command will
be launched when container is Ready instead
of Running.
nullable: true
type: boolean
waitTimeout:
description: WaitTimeout defines the maximum amount
of time Velero should wait for the container
Expand Down
4 changes: 2 additions & 2 deletions config/crd/v1/crds/crds.go
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions config/crd/v2alpha1/bases/velero.io_datadownloads.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ spec:
name: v2alpha1
schema:
openAPIV3Schema:
description: DataDownload acts as the protocol between data mover plugins
and data mover controller for the datamover restore operation
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
Expand Down
2 changes: 2 additions & 0 deletions config/crd/v2alpha1/bases/velero.io_datauploads.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ spec:
name: v2alpha1
schema:
openAPIV3Schema:
description: DataUpload acts as the protocol between data mover plugins and
data mover controller for the datamover backup operation
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
Expand Down
4 changes: 2 additions & 2 deletions config/crd/v2alpha1/crds/crds.go
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions pkg/apis/velero/v1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pkg/apis/velero/v2alpha1/data_download_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

type DataDownload struct {
metav1.TypeMeta `json:",inline"`

Expand Down
1 change: 1 addition & 0 deletions pkg/apis/velero/v2alpha1/data_upload_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ type DataUploadStatus struct {
// +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Time duration since this DataUpload was created"
// +kubebuilder:printcolumn:name="Node",type="string",JSONPath=".status.node",description="Name of the node where the DataUpload is processed"

// DataUpload acts as the protocol between data mover plugins and data mover controller for the datamover backup operation
type DataUpload struct {
metav1.TypeMeta `json:",inline"`

Expand Down
Loading