Skip to content

Commit

Permalink
update description and release 0.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
chengshiwen committed Apr 25, 2021
1 parent b160c3d commit 94b56a9
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
[![Releases](https://img.shields.io/github/release-pre/chengshiwen/kubectl-resource-versions.svg)](https://github.com/chengshiwen/kubectl-resource-versions/releases)
![GitHub stars](https://img.shields.io/github/stars/chengshiwen/kubectl-resource-versions.svg?label=github%20stars&logo=github)

kubectl-resource-versions - This kubectl plugin prints the supported API resources along with groups/versions on the server
kubectl-resource-versions - This kubectl plugin prints the API resources along with the supported API versions in the form of group/version on the server

## Intro

Have you ever wondered which api group and version should be used for a specified resource on a provided kubernetes cluster?

In one deployment definition you could see this `apiVersion: apps/v1beta2`, and in another `apiVersion: apps/v1`. Which one is correct? Which you should use? How to check which are supported on your Kubernetes cluster?

It is useful to find out the API resources available on the API server along with groups/versions that offer that API as shown below.
It is useful to find out the API resources along with the supported API versions in the form of group/version on the server as shown below.

![kubectl-resource-versions example](doc/kubectl-resource-versions.png)

Expand All @@ -38,13 +38,13 @@ $ kubectl-resource-versions --help
# or
$ kubectl resource-versions --help

Print the supported API resource versions on the server
Print the API resources along with the supported API versions in the form of group/version on the server

Usage:
kubectl-resource-versions [flags]

Examples:
# Print the supported API resource versions
# Print the API resources with the supported API versions
kubectl-resource-versions
# Print by kubectl plugin
kubectl resource-versions
Expand Down
10 changes: 5 additions & 5 deletions cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import (
"k8s.io/client-go/util/homedir"
)

const Version = "0.1.0"
const Version = "0.1.1"

type flags struct {
KubeConfig string
Expand All @@ -54,11 +54,11 @@ func Execute() {
func NewCommand() *cobra.Command {
flags := &flags{}
cmd := &cobra.Command{
Args: cobra.NoArgs,
Use: "kubectl-resource-versions",
Short: "Print the supported API resources with groups/versions",
Long: "Print the supported API resources along with groups/versions on the server",
Example: " # Print the supported API resources with groups/versions\n kubectl-resource-versions\n # Print by kubectl plugin\n kubectl resource-versions",
Short: "Print the API resources with the supported API versions",
Long: "Print the API resources along with the supported API versions in the form of group/version on the server",
Example: " # Print the API resources with the supported API versions\n kubectl-resource-versions\n # Print by kubectl plugin\n kubectl resource-versions",
Args: cobra.NoArgs,
SilenceUsage: true,
SilenceErrors: true,
Version: Version,
Expand Down

0 comments on commit 94b56a9

Please sign in to comment.