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

Enhance the capabilities of the karmadactl get command #5254

Merged
merged 2 commits into from
Aug 19, 2024
Merged

Enhance the capabilities of the karmadactl get command #5254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99ef7a3
enhance karmadactl get command
hulizhe Aug 19, 2024
37a6dc9
karmadactl get e2e test
hulizhe Aug 19, 2024
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
184 changes: 127 additions & 57 deletions pkg/karmadactl/get/get.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,17 @@ const (
proxyURL = "/apis/cluster.karmada.io/v1alpha1/clusters/%s/proxy/"
)

type adoption string

const (
// managedByKarmada indicates that these are resources of member clusters and are managed by the Karmada control plane.
managedByKarmada adoption = "Y"
// notManagedByKaramda indicates that these are resources of member clusters and are not managed by the Karmada control plane.
notManagedByKaramda adoption = "N"
// notApplicable indicates that these are Karmada control plane resources.
notApplicable adoption = "-"
)

var (
podColumns = []metav1.TableColumnDefinition{
{Name: "CLUSTER", Type: "string", Format: "", Priority: 0},
Expand All @@ -69,7 +80,7 @@ var (
eventColumn = metav1.TableColumnDefinition{Name: "EVENT", Type: "string", Format: "", Priority: 0}

getLong = templates.LongDesc(`
Display one or many resources in member clusters.
Display one or many resources in Karmada control plane and member clusters.

Prints a table of the most important information about the specified resources.
You can filter the list using a label selector and the --selector flag. If the
Expand All @@ -80,28 +91,31 @@ var (
of the --template flag, you can filter the attributes of the fetched resources.`)

getExample = templates.Examples(`
# List all pods in ps output format
# List all pods in Karmada control plane in ps output format
%[1]s get pods

# List all pods in ps output format with more information (such as node name)
# List all pods in Karmada control plane in ps output format with more information (such as node name)
%[1]s get pods -o wide

# List all pods of member1 cluster in ps output format
%[1]s get pods -C member1
%[1]s get pods --operation-scope=members --clusters=member1

# List a single replicasets controller with specified NAME in ps output format
# List all pods of Karmada control plane and member1 cluster in ps output format
%[1]s get pods --operation-scope=all --clusters=member1

# List a single replicasets controller with specified NAME in Karmada control plane in ps output format
%[1]s get replicasets nginx

# List deployments in JSON output format, in the "v1" version of the "apps" API group
# List deployments in Karmada control plane in JSON output format, in the "v1" version of the "apps" API group
%[1]s get deployments.v1.apps -o json

# Return only the phase value of the specified resource
%[1]s get -o template deployment/nginx -C member1 --template={{.spec.replicas}}
%[1]s get -o template deployment/nginx --template={{.spec.replicas}}

# List all replication controllers and services together in ps output format
# List all replication controllers and services together in Karmada control plane in ps output format
%[1]s get rs,services

# List one or more resources by their type and names
# List one or more resources in Karmada control plane by their type and names
%[1]s get rs/nginx-cb87b6d88 service/kubernetes`)
)

Expand All @@ -110,7 +124,7 @@ func NewCmdGet(f util.Factory, parentCommand string, streams genericiooptions.IO
o := NewCommandGetOptions(streams)
cmd := &cobra.Command{
Use: "get [NAME | -l label | -n namespace]",
Short: "Display one or many resources",
Short: "Display one or many resources in Karmada control plane and member clusters.",
Long: getLong,
SilenceUsage: true,
DisableFlagsInUseLine: true,
Expand All @@ -135,9 +149,11 @@ func NewCmdGet(f util.Factory, parentCommand string, streams genericiooptions.IO
o.PrintFlags.AddFlags(cmd)
flags := cmd.Flags()
options.AddKubeConfigFlags(flags)
o.OperationScope = options.KarmadaControlPlane
flags.Var(&o.OperationScope, "operation-scope", "Used to control the operation scope of the command. The optional values are karmada, members, and all. Defaults to karmada.")
flags.StringVarP(options.DefaultConfigFlags.Namespace, "namespace", "n", *options.DefaultConfigFlags.Namespace, "If present, the namespace scope for this CLI request")
flags.StringVarP(&o.LabelSelector, "labels", "l", "", "-l=label or -l label")
flags.StringSliceVarP(&o.Clusters, "clusters", "C", []string{}, "-C=member1,member2")
flags.StringSliceVarP(&o.Clusters, "clusters", "C", []string{}, "Used to specify target member clusters and only takes effect when the command's operation scope is members or all, for example: --operation-scope=all --clusters=member1,member2")
flags.BoolVarP(&o.AllNamespaces, "all-namespaces", "A", o.AllNamespaces, "If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.")
flags.BoolVar(&o.IgnoreNotFound, "ignore-not-found", o.IgnoreNotFound, "If the requested object does not exist the command will return exit code 0.")
flags.BoolVarP(&o.Watch, "watch", "w", o.Watch, "After listing/getting the requested object, watch for changes. Uninitialized objects are excluded if no object name is provided.")
Expand All @@ -149,7 +165,9 @@ func NewCmdGet(f util.Factory, parentCommand string, streams genericiooptions.IO

// CommandGetOptions contains the input to the get command.
type CommandGetOptions struct {
Clusters []string
Clusters []string
OperationScope options.OperationScope
targetMemberClusters []string

PrintFlags *get.PrintFlags
ToPrinter func(*meta.RESTMapping, *bool, bool, bool) (printers.ResourcePrinterFunc, error)
Expand Down Expand Up @@ -196,11 +214,11 @@ func NewCommandGetOptions(streams genericiooptions.IOStreams) *CommandGetOptions
// Complete takes the command arguments and infers any remaining options.
func (g *CommandGetOptions) Complete(f util.Factory) error {
newScheme := gclient.NewSchema()
namespace, _, err := f.ToRawKubeConfigLoader().Namespace()

err := g.handleNamespaceScopeFlags(f)
if err != nil {
return err
}
g.Namespace = namespace

templateArg := ""
if g.PrintFlags.TemplateFlags != nil && g.PrintFlags.TemplateFlags.TemplateArgument != nil {
Expand Down Expand Up @@ -250,7 +268,7 @@ func (g *CommandGetOptions) Complete(f util.Factory) error {
return err
}
g.karmadaClient = karmadaClient
return nil
return g.handleClusterScopeFlags()
}

// Validate checks the set of flags provided by the user.
Expand All @@ -265,7 +283,11 @@ func (g *CommandGetOptions) Validate(cmd *cobra.Command) error {
return fmt.Errorf("--output-watch-events option can only be used with --watch or --watch-only")
}

if len(g.Clusters) > 0 {
if err := options.VerifyOperationScopeFlags(g.OperationScope); err != nil {
return err
}

if options.ContainMembersScope(g.OperationScope) && len(g.Clusters) > 0 {
clusters, err := g.karmadaClient.ClusterV1alpha1().Clusters().List(context.TODO(), metav1.ListOptions{})
if err != nil {
return err
Expand All @@ -275,10 +297,39 @@ func (g *CommandGetOptions) Validate(cmd *cobra.Command) error {
return nil
}

func (g *CommandGetOptions) handleClusterScopeFlags() error {
var err error
switch g.OperationScope {
case options.KarmadaControlPlane:
g.targetMemberClusters = []string{}
case options.Members, options.All:
if len(g.Clusters) == 0 {
g.targetMemberClusters, err = LoadRegisteredClusters(g.karmadaClient)
return err
}
g.targetMemberClusters = g.Clusters
return nil
}
return nil
}

func (g *CommandGetOptions) handleNamespaceScopeFlags(f util.Factory) error {
var err error
g.Namespace, g.ExplicitNamespace, err = f.ToRawKubeConfigLoader().Namespace()
if err != nil {
return err
}
if g.AllNamespaces {
g.ExplicitNamespace = false
}
return nil
}

// Obj cluster info
type Obj struct {
Cluster string
Info *resource.Info
Cluster string
IsControlPlane bool
hulizhe marked this conversation as resolved.
Show resolved Hide resolved
Info *resource.Info
}

// WatchObj is a obj that is watched
Expand All @@ -296,35 +347,29 @@ func (g *CommandGetOptions) Run(f util.Factory, cmd *cobra.Command, args []strin
var watchObjs []WatchObj
var allErrs []error

if g.AllNamespaces {
g.ExplicitNamespace = false
}

outputOption := cmd.Flags().Lookup("output").Value.String()
if strings.Contains(outputOption, "custom-columns") || outputOption == "yaml" || strings.Contains(outputOption, "json") {
g.ServerPrint = false
}

if len(g.Clusters) == 0 {
clusterList, err := g.karmadaClient.ClusterV1alpha1().Clusters().List(context.TODO(), metav1.ListOptions{})
if err != nil {
return fmt.Errorf("failed to list all member clusters in control plane, err: %w", err)
}

for i := range clusterList.Items {
g.Clusters = append(g.Clusters, clusterList.Items[i].Name)
}
if options.ContainKarmadaScope(g.OperationScope) {
g.getObjInfo(&mux, f, "Karmada", true, &objs, &watchObjs, &allErrs, args)
}

wg.Add(len(g.Clusters))
for idx := range g.Clusters {
memberFactory, err := f.FactoryForMemberCluster(g.Clusters[idx])
if err != nil {
return err
if len(g.targetMemberClusters) != 0 {
wg.Add(len(g.targetMemberClusters))
for idx := range g.targetMemberClusters {
memberFactory, err := f.FactoryForMemberCluster(g.targetMemberClusters[idx])
if err != nil {
return err
}
go func() {
g.getObjInfo(&mux, memberFactory, g.targetMemberClusters[idx], false, &objs, &watchObjs, &allErrs, args)
wg.Done()
}()
}
go g.getObjInfo(&wg, &mux, memberFactory, g.Clusters[idx], &objs, &watchObjs, &allErrs, args)
wg.Wait()
}
wg.Wait()

if g.Watch || g.WatchOnly {
return g.watch(watchObjs)
Expand Down Expand Up @@ -428,12 +473,17 @@ func (g *CommandGetOptions) printObjs(objs []Obj, allErrs *[]error, _ []string)

// printIfNotFindResource is sure we output something if we wrote no output, and had no errors, and are not ignoring NotFound
func (g *CommandGetOptions) printIfNotFindResource(written int, allErrs *[]error, allResourcesNamespaced bool) {
if written == 0 && !g.IgnoreNotFound && len(*allErrs) == 0 {
if allResourcesNamespaced {
fmt.Fprintf(g.ErrOut, "No resources found in %s namespace.\n", *options.DefaultConfigFlags.Namespace)
} else {
fmt.Fprintln(g.ErrOut, "No resources found")
}
if written != 0 || g.IgnoreNotFound || len(*allErrs) != 0 {
return
}
if !options.ContainKarmadaScope(g.OperationScope) && len(g.targetMemberClusters) == 0 {
fmt.Fprintln(g.ErrOut, "No member Clusters found in Karmada control plane")
return
}
if allResourcesNamespaced {
fmt.Fprintf(g.ErrOut, "No resources found in %s namespace.\n", g.Namespace)
} else {
fmt.Fprintln(g.ErrOut, "No resources found")
}
}

Expand All @@ -446,23 +496,24 @@ func (g *CommandGetOptions) checkPrintWithNamespace(mapping *meta.RESTMapping) b
}

// getObjInfo get obj info in member cluster
func (g *CommandGetOptions) getObjInfo(wg *sync.WaitGroup, mux *sync.Mutex, f cmdutil.Factory,
cluster string, objs *[]Obj, watchObjs *[]WatchObj, allErrs *[]error, args []string,
func (g *CommandGetOptions) getObjInfo(mux *sync.Mutex, f cmdutil.Factory,
cluster string, isControlPlane bool, objs *[]Obj, watchObjs *[]WatchObj, allErrs *[]error, args []string,
) {
defer wg.Done()

restClient, err := f.RESTClient()
if err != nil {
*allErrs = append(*allErrs, err)
return
}

// check if it is authorized to proxy this member cluster
request := restClient.Get().RequestURI(fmt.Sprintf(proxyURL, cluster) + "api")
if _, err := request.DoRaw(context.TODO()); err != nil {
*allErrs = append(*allErrs, fmt.Errorf("cluster(%s) is inaccessible, please check authorization or network", cluster))
return
if !isControlPlane {
// check if it is authorized to proxy this member cluster
request := restClient.Get().RequestURI(fmt.Sprintf(proxyURL, cluster) + "api")
if _, err := request.DoRaw(context.TODO()); err != nil {
*allErrs = append(*allErrs, fmt.Errorf("cluster(%s) is inaccessible, please check authorization or network", cluster))
return
}
}

r := f.NewBuilder().
Unstructured().
NamespaceParam(g.Namespace).DefaultNamespace().AllNamespaces(g.AllNamespaces).
Expand Down Expand Up @@ -514,8 +565,9 @@ func (g *CommandGetOptions) getObjInfo(wg *sync.WaitGroup, mux *sync.Mutex, f cm
var objInfo Obj
for ix := range infos {
objInfo = Obj{
Cluster: cluster,
Info: infos[ix],
Cluster: cluster,
IsControlPlane: isControlPlane,
Info: infos[ix],
}
*objs = append(*objs, objInfo)
}
Expand Down Expand Up @@ -549,11 +601,15 @@ func (g *CommandGetOptions) reconstructionRow(objs []Obj, table *metav1.Table) (
continue
}

if objs[ix].IsControlPlane {
table.Rows[rowIdx].Cells = append(table.Rows[rowIdx].Cells, notApplicable)
continue
}
v, exist := unObj.GetLabels()[karmadautil.ManagedByKarmadaLabel]
if exist && v == karmadautil.ManagedByKarmadaLabelValue {
table.Rows[rowIdx].Cells = append(table.Rows[rowIdx].Cells, "Y")
table.Rows[rowIdx].Cells = append(table.Rows[rowIdx].Cells, managedByKarmada)
} else {
table.Rows[rowIdx].Cells = append(table.Rows[rowIdx].Cells, "N")
table.Rows[rowIdx].Cells = append(table.Rows[rowIdx].Cells, notManagedByKaramda)
}
}
allTableRows = append(allTableRows, table.Rows...)
Expand Down Expand Up @@ -954,3 +1010,17 @@ func (p *skipPrinter) PrintObj(obj runtime.Object, writer io.Writer) error {
table.Rows = nil
return p.delegate.PrintObj(table, writer)
}

// LoadRegisteredClusters gets a list of register clusters.
func LoadRegisteredClusters(clientSet karmadaclientset.Interface) ([]string, error) {
var clusters []string
clusterList, err := clientSet.ClusterV1alpha1().Clusters().List(context.TODO(), metav1.ListOptions{})
if err != nil {
return nil, fmt.Errorf("failed to list all member clusters in control plane, err: %w", err)
}

for i := range clusterList.Items {
clusters = append(clusters, clusterList.Items[i].Name)
}
return clusters, nil
}
Loading