crictl: add option to filter by container name in ps

Signed-off-by: Antonio Murdaca <[email protected]>

Author: runcom

cmd/crictl/constants.go

@@ -19,6 +19,7 @@ package main
 const (
 	// This labels are copied from kubelet directly, and may change
 	// without warning in the future.
-	kubePodNameLabel      = "io.kubernetes.pod.name"
-	kubePodNamespaceLabel = "io.kubernetes.pod.namespace"
+	kubePodNameLabel       = "io.kubernetes.pod.name"
+	kubePodNamespaceLabel  = "io.kubernetes.pod.namespace"
+	kubeContainerNameLabel = "io.kubernetes.container.name"
 )

cmd/crictl/container.go

@@ -264,6 +264,11 @@ var listContainersCommand = cli.Command{
 			Value: "",
 			Usage: "Filter by container id",
 		},
+		cli.StringFlag{
+			Name:  "name",
+			Value: "",
+			Usage: "filter by container name regular expression pattern",
+		},
 		cli.StringFlag{
 			Name:  "pod, p",
 			Value: "",
@@ -310,16 +315,17 @@ var listContainersCommand = cli.Command{
 		}
 
 		opts := listOptions{
-			id:      context.String("id"),
-			podID:   context.String("pod"),
-			state:   context.String("state"),
-			verbose: context.Bool("verbose"),
-			quiet:   context.Bool("quiet"),
-			output:  context.String("output"),
-			all:     context.Bool("all"),
-			latest:  context.Bool("latest"),
-			last:    context.Int("last"),
-			noTrunc: context.Bool("no-trunc"),
+			id:         context.String("id"),
+			podID:      context.String("pod"),
+			state:      context.String("state"),
+			verbose:    context.Bool("verbose"),
+			quiet:      context.Bool("quiet"),
+			output:     context.String("output"),
+			all:        context.Bool("all"),
+			nameRegexp: context.String("name"),
+			latest:     context.Bool("latest"),
+			last:       context.Int("last"),
+			noTrunc:    context.Bool("no-trunc"),
 		}
 		opts.labels, err = parseLabelStringSlice(context.StringSlice("label"))
 		if err != nil {
@@ -617,6 +623,10 @@ func ListContainers(client pb.RuntimeServiceClient, opts listOptions) error {
 		fmt.Fprintln(w, "CONTAINER ID\tIMAGE\tCREATED\tSTATE\tNAME\tATTEMPT\tPOD ID")
 	}
 	for _, c := range r.Containers {
+		// Filter by pod name/namespace regular expressions.
+		if !matchesRegex(opts.nameRegexp, c.Labels[kubeContainerNameLabel]) {
+			continue
+		}
 		if opts.quiet {
 			fmt.Printf("%s\n", c.Id)
 			continue

cmd/crictl/sandbox.go

@@ -21,7 +21,6 @@ import (
 	"fmt"
 	"log"
 	"os"
-	"regexp"
 	"sort"
 	"strings"
 	"text/tabwriter"
@@ -227,7 +226,7 @@ var listPodCommand = cli.Command{
 			latest:             context.Bool("latest"),
 			last:               context.Int("last"),
 			noTrunc:            context.Bool("no-trunc"),
-			podNameRegexp:      context.String("name"),
+			nameRegexp:         context.String("name"),
 			podNamespaceRegexp: context.String("namespace"),
 		}
 		opts.labels, err = parseLabelStringSlice(context.StringSlice("label"))
@@ -383,18 +382,6 @@ func PodSandboxStatus(client pb.RuntimeServiceClient, ID, output string, quiet b
 	return nil
 }
 
-func podMatchesRegex(pattern, target string) bool {
-	if pattern == "" {
-		return true
-	}
-	matched, err := regexp.MatchString(pattern, target)
-	if err != nil {
-		// Assume it's not a match if an error occurs.
-		return false
-	}
-	return matched
-}
-
 // ListPodSandboxes sends a ListPodSandboxRequest to the server, and parses
 // the returned ListPodSandboxResponse.
 func ListPodSandboxes(client pb.RuntimeServiceClient, opts listOptions) error {
@@ -447,10 +434,10 @@ func ListPodSandboxes(client pb.RuntimeServiceClient, opts listOptions) error {
 	}
 	for _, pod := range r.Items {
 		// Filter by pod name/namespace regular expressions.
-		if !podMatchesRegex(opts.podNameRegexp, pod.Labels[kubePodNameLabel]) {
+		if !matchesRegex(opts.nameRegexp, pod.Labels[kubePodNameLabel]) {
 			continue
 		}
-		if !podMatchesRegex(opts.podNamespaceRegexp, pod.Labels[kubePodNamespaceLabel]) {
+		if !matchesRegex(opts.podNamespaceRegexp, pod.Labels[kubePodNamespaceLabel]) {
 			continue
 		}
 

cmd/crictl/util.go

@@ -22,6 +22,7 @@ import (
 	"fmt"
 	"os"
 	"reflect"
+	"regexp"
 	"sort"
 	"strings"
 
@@ -48,8 +49,8 @@ type listOptions struct {
 	id string
 	// podID of container
 	podID string
-	// Regular expression pattern to match pod name
-	podNameRegexp string
+	// Regular expression pattern to match pod or container
+	nameRegexp string
 	// Regular expression pattern to match the pod namespace
 	podNamespaceRegexp string
 	// state of the sandbox
@@ -308,3 +309,15 @@ func getTruncatedID(id, prefix string) string {
 	}
 	return id
 }
+
+func matchesRegex(pattern, target string) bool {
+	if pattern == "" {
+		return true
+	}
+	matched, err := regexp.MatchString(pattern, target)
+	if err != nil {
+		// Assume it's not a match if an error occurs.
+		return false
+	}
+	return matched
+}

cmd/crictl/sandbox_test.go cmd/crictl/util_test.go

@@ -20,12 +20,12 @@ import (
 	"testing"
 )
 
-func TestPodFilterByRegex(t *testing.T) {
+func TestNameFilterByRegex(t *testing.T) {
 	testCases := []struct {
-		desc      string
-		pattern   string
-		podString string
-		isMatch   bool
+		desc    string
+		pattern string
+		name    string
+		isMatch bool
 	}{
 		{
 			"exact name should match",
@@ -60,7 +60,7 @@ func TestPodFilterByRegex(t *testing.T) {
 	}
 	for _, tc := range testCases {
 		t.Run(tc.desc, func(t *testing.T) {
-			r := podMatchesRegex(tc.pattern, tc.podString)
+			r := matchesRegex(tc.pattern, tc.name)
 			if r != tc.isMatch {
 				t.Errorf("expected matched to be %v; actual result is %v", tc.isMatch, r)
 			}