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

Jump to bottom

Add short names for Volume Snapshot CRDs #604

Merged
merged 1 commit into from
Nov 11, 2021
Merged

Add short names for Volume Snapshot CRDs #604

merged 1 commit into from
Nov 11, 2021

Conversation

robbie-demuth
Copy link
Contributor

@robbie-demuth robbie-demuth commented Nov 2, 2021 •
edited
Loading

What type of PR is this?

/kind feature

What this PR does / why we need it:

This allows end users to run kubectl get vs, for example, instead of
kubectl get volumesnapshot. The following short names have been
implemented:

  • VolumeSnapshot - vs
  • VolumeSnapshotContent - vsc, vscs
  • VolumeSnapshotClass - vsclass, vsclasses

Screen Shot 2021-11-11 at 5 12 19 PM

Which issue(s) this PR fixes:

Fixes #603

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Yes

Added short names for Volume Snapshot CRDs:
* VolumeSnapshot - vs
* VolumeSnapshotContent - vsc, vscs
* VolumeSnapshotClass` - vsclass, vsclasses

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Nov 2, 2021
@k8s-ci-robot
Copy link
Contributor

Welcome @robbie-demuth!

It looks like this is your first PR to kubernetes-csi/external-snapshotter 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-csi/external-snapshotter has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @robbie-demuth. Thanks for your PR.

I'm waiting for a kubernetes-csi member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Nov 2, 2021
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 2, 2021
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Nov 2, 2021
@xing-yang
Copy link
Collaborator

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 2, 2021
@xing-yang
Copy link
Collaborator

/assign

@robbie-demuth
Copy link
Contributor Author

/retest

@robbie-demuth
Add short names for Volume Snapshot CRDs
4f5383a 
This allows end users to run `kubectl get vs`, for example, instead of
`kubectl get volumesnapshot`. The following short names have been
implemented:

* `VolumeSnapshot` - `vs`
* `VolumeSnapshotContent` - `vsc`, `vscs`
* `VolumeSnapshotClass` - `vsclass`, `vsclasses`
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 2, 2021
@robbie-demuth
Copy link
Contributor Author

@xing-yang - Anything you'd like me to do here to help usher this along?

xing-yang
xing-yang reviewed Nov 8, 2021
View reviewed changes
client/apis/volumesnapshot/v1/types.go
@@ -29,7 +29,7 @@ import (
// VolumeSnapshot is a user's request for either creating a point-in-time
// snapshot of a persistent volume, or binding to a pre-existing snapshot.
// +kubebuilder:object:root=true
// +kubebuilder:resource:scope=Namespaced
// +kubebuilder:resource:scope=Namespaced,shortName=vs
Copy link
Collaborator

Choose a reason for hiding this comment

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

Does this not require a plural?

Copy link
Contributor Author

@robbie-demuth robbie-demuth Nov 8, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

I'm not sure. It felt funny to type vss, but I can certainly add it if you'd like. I will note that the short name for stateful sets, sts, doesn't have a plural

Copy link
Collaborator

Choose a reason for hiding this comment

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

I wonder if there's a convention for that. If StatefulSet does not have a plural, we are probably fine.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I couldn't find any published conventions. I reached out to SIG-API-Machinery, SIG-Arch, and SIG-Usability via Slack, but didn't get a response

@xing-yang
Copy link
Collaborator

/assign @yuxiangqian @jingxu97

@xing-yang
Copy link
Collaborator

Can you add details in the release note, i.e., which short name is corresponding to which CRD.

@robbie-demuth
Copy link
Contributor Author

Done!

@xing-yang
Copy link
Collaborator

@robbie-demuth Can you post the results from using the short names?

@robbie-demuth
Copy link
Contributor Author

I added a screenshot to the description. Does that work for you?

@xing-yang
Copy link
Collaborator

Can you submit a followup PR to add this info in README? https://github.com/kubernetes-csi/external-snapshotter#readme

@xing-yang
Copy link
Collaborator

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 11, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: robbie-demuth, xing-yang

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 11, 2021
@xing-yang
Copy link
Collaborator

After this is merged, can you backport this to release-5.0 branch?

@robbie-demuth
Copy link
Contributor Author

Can you submit a followup PR to add this info in README? https://github.com/kubernetes-csi/external-snapshotter#readme

Sure, but what are you thinking exactly? I don't see anything in the README now that deals with custom resources (other than the resource quota stuff)

After this is merged, can you backport this to release-5.0 branch?

Sure thing

@robbie-demuth robbie-demuth mentioned this pull request Nov 11, 2021
Merged
@robbie-demuth
Copy link
Contributor Author

Opened #607 for the backport

@xing-yang
Copy link
Collaborator

How about adding a sub-section under https://github.com/kubernetes-csi/external-snapshotter#usage?

@k8s-ci-robot k8s-ci-robot merged commit 51f8cce into kubernetes-csi:master Nov 11, 2021
@robbie-demuth robbie-demuth deleted the short-names branch November 11, 2021 23:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xing-yang xing-yang xing-yang left review comments

@andyzhangx andyzhangx Awaiting requested review from andyzhangx

@yuxiangqian yuxiangqian Awaiting requested review from yuxiangqian

Assignees

@xing-yang xing-yang

@yuxiangqian yuxiangqian

@jingxu97 jingxu97

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Short names for Volume Snapshot CRDs
5 participants
@robbie-demuth @k8s-ci-robot @xing-yang @yuxiangqian @jingxu97