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

Sort commands by their name #1474

Merged
merged 1 commit into from
Jul 8, 2024

Conversation

saschagrunert
Copy link
Member

What type of PR is this?

/kind documentation

What this PR does / why we need it:

The command list of crictl is now sorted alphabetically:

…

COMMANDS:
   attach              Attach to a running container
   checkpoint          Checkpoint one or more running containers
   completion          Output shell completion code
   config              Get and set crictl client configuration options
   create              Create a new container
   events, event       Stream the events of containers
   exec                Run a command in a running container
   imagefsinfo         Return image filesystem info
   images, image, img  List images
   info                Display information of the container runtime
   inspect             Display the status of one or more containers
   inspecti            Return the status of one or more images
   inspectp            Display the status of one or more pods
   logs                Fetch the logs of a container
   metricsp            List pod metrics. Metrics are unstructured key/value pairs gathered by CRI meant to replace cAdvisor's /metrics/cadvisor endpoint.
   pods                List pods
   port-forward        Forward local port to a pod
   ps                  List containers
   pull                Pull an image from a registry
   rm                  Remove one or more containers
   rmi                 Remove one or more images
   rmp                 Remove one or more pods
   run                 Run a new container inside a sandbox
   runp                Run a new pod
   runtime-config      Retrieve the container runtime configuration
   start               Start one or more created containers
   stats               List container(s) resource usage statistics
   statsp              List pod statistics. Stats represent a structured API that will fulfill the Kubelet's /stats/summary endpoint.
   stop                Stop one or more running containers
   stopp               Stop one or more running pods
   update              Update one or more running containers
   version             Display runtime version information
   help, h             Shows a list of commands or help for one command

…

Which issue(s) this PR fixes:

None

Special notes for your reviewer:

None

Does this PR introduce a user-facing change?

The `crictl` commands are now sorted alphabetically.

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jul 2, 2024
@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 2, 2024
The command list of `crictl` is now sorted alphabetically:

```
…

COMMANDS:
   attach              Attach to a running container
   checkpoint          Checkpoint one or more running containers
   completion          Output shell completion code
   config              Get and set crictl client configuration options
   create              Create a new container
   events, event       Stream the events of containers
   exec                Run a command in a running container
   imagefsinfo         Return image filesystem info
   images, image, img  List images
   info                Display information of the container runtime
   inspect             Display the status of one or more containers
   inspecti            Return the status of one or more images
   inspectp            Display the status of one or more pods
   logs                Fetch the logs of a container
   metricsp            List pod metrics. Metrics are unstructured key/value pairs gathered by CRI meant to replace cAdvisor's /metrics/cadvisor endpoint.
   pods                List pods
   port-forward        Forward local port to a pod
   ps                  List containers
   pull                Pull an image from a registry
   rm                  Remove one or more containers
   rmi                 Remove one or more images
   rmp                 Remove one or more pods
   run                 Run a new container inside a sandbox
   runp                Run a new pod
   runtime-config      Retrieve the container runtime configuration
   start               Start one or more created containers
   stats               List container(s) resource usage statistics
   statsp              List pod statistics. Stats represent a structured API that will fulfill the Kubelet's /stats/summary endpoint.
   stop                Stop one or more running containers
   stopp               Stop one or more running pods
   update              Update one or more running containers
   version             Display runtime version information
   help, h             Shows a list of commands or help for one command

…
```

Signed-off-by: Sascha Grunert <[email protected]>
@kwilczynski
Copy link
Member

/approve
/lgtm

@k8s-ci-robot
Copy link
Contributor

@kwilczynski: changing LGTM is restricted to collaborators

In response to this:

/approve
/lgtm

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-sigs/prow repository.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kwilczynski, saschagrunert

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

@haircommander
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 8, 2024
@k8s-ci-robot k8s-ci-robot merged commit 19b2c5a into kubernetes-sigs:master Jul 8, 2024
23 checks passed
@saschagrunert saschagrunert deleted the sort-commands branch July 9, 2024 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants