mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-07-27 13:37:30 +00:00
update describe command opts struct
This commit is contained in:
parent
6d3652eded
commit
e11b66a732
@ -18,16 +18,17 @@ package cmd
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
apierrors "k8s.io/apimachinery/pkg/api/errors"
|
apierrors "k8s.io/apimachinery/pkg/api/errors"
|
||||||
|
"k8s.io/apimachinery/pkg/api/meta"
|
||||||
utilerrors "k8s.io/apimachinery/pkg/util/errors"
|
utilerrors "k8s.io/apimachinery/pkg/util/errors"
|
||||||
"k8s.io/apimachinery/pkg/util/sets"
|
"k8s.io/apimachinery/pkg/util/sets"
|
||||||
"k8s.io/kubernetes/pkg/kubectl/cmd/templates"
|
"k8s.io/kubernetes/pkg/kubectl/cmd/templates"
|
||||||
cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
|
cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
|
||||||
|
"k8s.io/kubernetes/pkg/kubectl/genericclioptions"
|
||||||
"k8s.io/kubernetes/pkg/kubectl/resource"
|
"k8s.io/kubernetes/pkg/kubectl/resource"
|
||||||
"k8s.io/kubernetes/pkg/kubectl/util/i18n"
|
"k8s.io/kubernetes/pkg/kubectl/util/i18n"
|
||||||
"k8s.io/kubernetes/pkg/printers"
|
"k8s.io/kubernetes/pkg/printers"
|
||||||
@ -67,10 +68,36 @@ var (
|
|||||||
kubectl describe pods frontend`))
|
kubectl describe pods frontend`))
|
||||||
)
|
)
|
||||||
|
|
||||||
func NewCmdDescribe(parent string, f cmdutil.Factory, out, cmdErr io.Writer) *cobra.Command {
|
type DescribeOptions struct {
|
||||||
options := &resource.FilenameOptions{}
|
CmdParent string
|
||||||
describerSettings := &printers.DescriberSettings{
|
Selector string
|
||||||
|
Namespace string
|
||||||
|
|
||||||
|
Describer func(*meta.RESTMapping) (printers.Describer, error)
|
||||||
|
Builder *resource.Builder
|
||||||
|
|
||||||
|
BuilderArgs []string
|
||||||
|
|
||||||
|
EnforceNamespace bool
|
||||||
|
AllNamespaces bool
|
||||||
|
IncludeUninitialized bool
|
||||||
|
|
||||||
|
DescriberSettings *printers.DescriberSettings
|
||||||
|
FilenameOptions *resource.FilenameOptions
|
||||||
|
|
||||||
|
genericclioptions.IOStreams
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewCmdDescribe(parent string, f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command {
|
||||||
|
o := &DescribeOptions{
|
||||||
|
FilenameOptions: &resource.FilenameOptions{},
|
||||||
|
DescriberSettings: &printers.DescriberSettings{
|
||||||
ShowEvents: true,
|
ShowEvents: true,
|
||||||
|
},
|
||||||
|
|
||||||
|
CmdParent: parent,
|
||||||
|
|
||||||
|
IOStreams: streams,
|
||||||
}
|
}
|
||||||
|
|
||||||
cmd := &cobra.Command{
|
cmd := &cobra.Command{
|
||||||
@ -80,48 +107,64 @@ func NewCmdDescribe(parent string, f cmdutil.Factory, out, cmdErr io.Writer) *co
|
|||||||
Long: describeLong + "\n\n" + cmdutil.SuggestApiResources(parent),
|
Long: describeLong + "\n\n" + cmdutil.SuggestApiResources(parent),
|
||||||
Example: describeExample,
|
Example: describeExample,
|
||||||
Run: func(cmd *cobra.Command, args []string) {
|
Run: func(cmd *cobra.Command, args []string) {
|
||||||
err := RunDescribe(f, out, cmdErr, cmd, args, options, describerSettings)
|
cmdutil.CheckErr(o.Complete(f, cmd, args))
|
||||||
cmdutil.CheckErr(err)
|
cmdutil.CheckErr(o.Run())
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
usage := "containing the resource to describe"
|
usage := "containing the resource to describe"
|
||||||
cmdutil.AddFilenameOptionFlags(cmd, options, usage)
|
cmdutil.AddFilenameOptionFlags(cmd, o.FilenameOptions, usage)
|
||||||
cmd.Flags().StringP("selector", "l", "", "Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2)")
|
cmd.Flags().StringP("selector", "l", "", "Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2)")
|
||||||
cmd.Flags().Bool("all-namespaces", false, "If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.")
|
cmd.Flags().Bool("all-namespaces", false, "If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.")
|
||||||
cmd.Flags().BoolVar(&describerSettings.ShowEvents, "show-events", describerSettings.ShowEvents, "If true, display events related to the described object.")
|
cmd.Flags().BoolVar(&o.DescriberSettings.ShowEvents, "show-events", o.DescriberSettings.ShowEvents, "If true, display events related to the described object.")
|
||||||
cmdutil.AddIncludeUninitializedFlag(cmd)
|
cmdutil.AddIncludeUninitializedFlag(cmd)
|
||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
func RunDescribe(f cmdutil.Factory, out, cmdErr io.Writer, cmd *cobra.Command, args []string, options *resource.FilenameOptions, describerSettings *printers.DescriberSettings) error {
|
func (o *DescribeOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error {
|
||||||
selector := cmdutil.GetFlagString(cmd, "selector")
|
o.Selector = cmdutil.GetFlagString(cmd, "selector")
|
||||||
allNamespaces := cmdutil.GetFlagBool(cmd, "all-namespaces")
|
o.AllNamespaces = cmdutil.GetFlagBool(cmd, "all-namespaces")
|
||||||
cmdNamespace, enforceNamespace, err := f.DefaultNamespace()
|
|
||||||
|
var err error
|
||||||
|
o.Namespace, o.EnforceNamespace, err = f.DefaultNamespace()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if allNamespaces {
|
|
||||||
enforceNamespace = false
|
if o.AllNamespaces {
|
||||||
|
o.EnforceNamespace = false
|
||||||
}
|
}
|
||||||
if len(args) == 0 && cmdutil.IsFilenameSliceEmpty(options.Filenames) {
|
|
||||||
fmt.Fprintf(cmdErr, "You must specify the type of resource to describe. %s\n\n", cmdutil.SuggestApiResources(cmd.Parent().Name()))
|
if len(args) == 0 && cmdutil.IsFilenameSliceEmpty(o.FilenameOptions.Filenames) {
|
||||||
return cmdutil.UsageErrorf(cmd, "Required resource not specified.")
|
return fmt.Errorf("You must specify the type of resource to describe. %s\n", cmdutil.SuggestApiResources(o.CmdParent))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
o.BuilderArgs = args
|
||||||
|
|
||||||
|
o.Describer = f.Describer
|
||||||
|
o.Builder = f.NewBuilder()
|
||||||
|
|
||||||
// include the uninitialized objects by default
|
// include the uninitialized objects by default
|
||||||
// unless user explicitly set --include-uninitialized=false
|
// unless user explicitly set --include-uninitialized=false
|
||||||
includeUninitialized := cmdutil.ShouldIncludeUninitialized(cmd, true)
|
o.IncludeUninitialized = cmdutil.ShouldIncludeUninitialized(cmd, true)
|
||||||
r := f.NewBuilder().
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o *DescribeOptions) Validate(args []string) error {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o *DescribeOptions) Run() error {
|
||||||
|
r := o.Builder.
|
||||||
Unstructured().
|
Unstructured().
|
||||||
ContinueOnError().
|
ContinueOnError().
|
||||||
NamespaceParam(cmdNamespace).DefaultNamespace().AllNamespaces(allNamespaces).
|
NamespaceParam(o.Namespace).DefaultNamespace().AllNamespaces(o.AllNamespaces).
|
||||||
FilenameParam(enforceNamespace, options).
|
FilenameParam(o.EnforceNamespace, o.FilenameOptions).
|
||||||
LabelSelectorParam(selector).
|
LabelSelectorParam(o.Selector).
|
||||||
IncludeUninitialized(includeUninitialized).
|
IncludeUninitialized(o.IncludeUninitialized).
|
||||||
ResourceTypeOrNameArgs(true, args...).
|
ResourceTypeOrNameArgs(true, o.BuilderArgs...).
|
||||||
Flatten().
|
Flatten().
|
||||||
Do()
|
Do()
|
||||||
err = r.Err()
|
err := r.Err()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@ -129,8 +172,8 @@ func RunDescribe(f cmdutil.Factory, out, cmdErr io.Writer, cmd *cobra.Command, a
|
|||||||
allErrs := []error{}
|
allErrs := []error{}
|
||||||
infos, err := r.Infos()
|
infos, err := r.Infos()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if apierrors.IsNotFound(err) && len(args) == 2 {
|
if apierrors.IsNotFound(err) && len(o.BuilderArgs) == 2 {
|
||||||
return DescribeMatchingResources(f, cmdNamespace, args[0], args[1], describerSettings, out, err)
|
return o.DescribeMatchingResources(err, o.BuilderArgs[0], o.BuilderArgs[1])
|
||||||
}
|
}
|
||||||
allErrs = append(allErrs, err)
|
allErrs = append(allErrs, err)
|
||||||
}
|
}
|
||||||
@ -139,7 +182,7 @@ func RunDescribe(f cmdutil.Factory, out, cmdErr io.Writer, cmd *cobra.Command, a
|
|||||||
first := true
|
first := true
|
||||||
for _, info := range infos {
|
for _, info := range infos {
|
||||||
mapping := info.ResourceMapping()
|
mapping := info.ResourceMapping()
|
||||||
describer, err := f.Describer(mapping)
|
describer, err := o.Describer(mapping)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if errs.Has(err.Error()) {
|
if errs.Has(err.Error()) {
|
||||||
continue
|
continue
|
||||||
@ -148,7 +191,7 @@ func RunDescribe(f cmdutil.Factory, out, cmdErr io.Writer, cmd *cobra.Command, a
|
|||||||
errs.Insert(err.Error())
|
errs.Insert(err.Error())
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
s, err := describer.Describe(info.Namespace, info.Name, *describerSettings)
|
s, err := describer.Describe(info.Namespace, info.Name, *o.DescriberSettings)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if errs.Has(err.Error()) {
|
if errs.Has(err.Error()) {
|
||||||
continue
|
continue
|
||||||
@ -159,20 +202,20 @@ func RunDescribe(f cmdutil.Factory, out, cmdErr io.Writer, cmd *cobra.Command, a
|
|||||||
}
|
}
|
||||||
if first {
|
if first {
|
||||||
first = false
|
first = false
|
||||||
fmt.Fprint(out, s)
|
fmt.Fprint(o.Out, s)
|
||||||
} else {
|
} else {
|
||||||
fmt.Fprintf(out, "\n\n%s", s)
|
fmt.Fprintf(o.Out, "\n\n%s", s)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return utilerrors.NewAggregate(allErrs)
|
return utilerrors.NewAggregate(allErrs)
|
||||||
}
|
}
|
||||||
|
|
||||||
func DescribeMatchingResources(f cmdutil.Factory, namespace, rsrc, prefix string, describerSettings *printers.DescriberSettings, out io.Writer, originalError error) error {
|
func (o *DescribeOptions) DescribeMatchingResources(originalError error, resource, prefix string) error {
|
||||||
r := f.NewBuilder().
|
r := o.Builder.
|
||||||
Unstructured().
|
Unstructured().
|
||||||
NamespaceParam(namespace).DefaultNamespace().
|
NamespaceParam(o.Namespace).DefaultNamespace().
|
||||||
ResourceTypeOrNameArgs(true, rsrc).
|
ResourceTypeOrNameArgs(true, resource).
|
||||||
SingleResourceType().
|
SingleResourceType().
|
||||||
Flatten().
|
Flatten().
|
||||||
Do()
|
Do()
|
||||||
@ -180,7 +223,7 @@ func DescribeMatchingResources(f cmdutil.Factory, namespace, rsrc, prefix string
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
describer, err := f.Describer(mapping)
|
describer, err := o.Describer(mapping)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@ -193,11 +236,11 @@ func DescribeMatchingResources(f cmdutil.Factory, namespace, rsrc, prefix string
|
|||||||
info := infos[ix]
|
info := infos[ix]
|
||||||
if strings.HasPrefix(info.Name, prefix) {
|
if strings.HasPrefix(info.Name, prefix) {
|
||||||
isFound = true
|
isFound = true
|
||||||
s, err := describer.Describe(info.Namespace, info.Name, *describerSettings)
|
s, err := describer.Describe(info.Namespace, info.Name, *o.DescriberSettings)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
fmt.Fprintf(out, "%s\n", s)
|
fmt.Fprintf(o.Out, "%s\n", s)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if !isFound {
|
if !isFound {
|
||||||
|
Loading…
Reference in New Issue
Block a user