NETOBSERV-1907 run in background (#102)

* run in background

* install tar if needed

* fix maxTime log

* fix option arg

* Update commands/netobserv

Co-authored-by: Joel Takvorian <[email protected]>

* improve background message

---------

Co-authored-by: Joel Takvorian <[email protected]>

Author: jpinsonneau

Dockerfile

@@ -24,7 +24,14 @@ COPY res/ res/
 COPY scripts/ scripts/
 COPY Makefile Makefile
 COPY .mk/ .mk/
-# Embed commands in case users want to pull it from collector image
+
+# Install oc to allow collector to run commands
+RUN set -x; \
+    OC_TAR_URL="https://mirror.openshift.com/pub/openshift-v4/$(uname -m)/clients/ocp/latest/openshift-client-linux.tar.gz" && \
+    curl -L -q -o /tmp/oc.tar.gz "$OC_TAR_URL" && \
+    tar -C /tmp -xvf /tmp/oc.tar.gz oc kubectl
+
+# Embedd commands in case users want to pull it from collector image
 RUN USER=netobserv VERSION=main make oc-commands
 
 # Prepare output dir
@@ -33,7 +40,11 @@ RUN mkdir -p output
 # Create final image from ubi + built binary and command
 FROM --platform=linux/$TARGETARCH registry.access.redhat.com/ubi9/ubi:9.4
 WORKDIR /
+
+COPY --from=builder /opt/app-root/build .
 COPY --from=builder /opt/app-root/build .
+COPY --from=builder /tmp/oc /usr/bin/oc
+COPY --from=builder /tmp/kubectl /usr/bin/kubectl
 COPY --from=builder --chown=65532:65532 /opt/app-root/output /output
 USER 65532:65532
 

cmd/flow_capture.go

@@ -148,16 +148,20 @@ func runFlowCaptureOnAddr(port int, filename string) {
 		// terminate capture if max bytes reached
 		totalBytes = totalBytes + int64(bytes)
 		if totalBytes > maxBytes {
-			log.Infof("Capture reached %s, exiting now...", sizestr.ToString(maxBytes))
-			return
+			if exit := onLimitReached(); exit {
+				log.Infof("Capture reached %s, exiting now...", sizestr.ToString(maxBytes))
+				return
+			}
 		}
 
 		// terminate capture if max time reached
 		now := currentTime()
 		duration := now.Sub(startupTime)
 		if int(duration) > int(maxTime) {
-			log.Infof("Capture reached %s, exiting now...", maxTime)
-			return
+			if exit := onLimitReached(); exit {
+				log.Infof("Capture reached %s, exiting now...", maxTime)
+				return
+			}
 		}
 
 		captureStarted = true
@@ -242,7 +246,7 @@ func toSize(fieldName string) int {
 func updateTable() {
 	// don't refresh terminal too often to avoid blinking
 	now := currentTime()
-	if int(now.Sub(lastRefresh)) > int(maxRefreshRate) {
+	if !captureEnded && int(now.Sub(lastRefresh)) > int(maxRefreshRate) {
 		lastRefresh = now
 		resetTerminal()
 
@@ -252,12 +256,18 @@ func updateTable() {
 			fmt.Printf("Log level: %s ", logLevel)
 			fmt.Printf("Duration: %s ", duration.Round(time.Second))
 			fmt.Printf("Capture size: %s\n", sizestr.ToString(totalBytes))
-			if len(strings.TrimSpace(filter)) > 0 {
-				fmt.Printf("Filters: %s\n", filter)
+			if len(strings.TrimSpace(options)) > 0 {
+				fmt.Printf("Options: %s\n", options)
+			}
+			if strings.Contains(options, "background=true") {
+				fmt.Printf("Showing last: %d\n", flowsToShow)
+				fmt.Printf("Display: %s\n", strings.Join(display, ","))
+				fmt.Printf("Enrichment: %s\n", strings.Join(enrichement, ","))
+			} else {
+				fmt.Printf("Showing last: %d Use Up / Down keyboard arrows to increase / decrease limit\n", flowsToShow)
+				fmt.Printf("Display: %s	Use Left / Right keyboard arrows to cycle views\n", strings.Join(display, ","))
+				fmt.Printf("Enrichment: %s	Use Page Up / Page Down keyboard keys to cycle enrichment scopes\n", strings.Join(enrichement, ","))
 			}
-			fmt.Printf("Showing last: %d Use Up / Down keyboard arrows to increase / decrease limit\n", flowsToShow)
-			fmt.Printf("Display: %s	Use Left / Right keyboard arrows to cycle views\n", strings.Join(display, ","))
-			fmt.Printf("Enrichment: %s	Use Page Up / Page Down keyboard keys to cycle enrichment scopes\n", strings.Join(enrichement, ","))
 		}
 
 		if slices.Contains(display, rawDisplay) {
@@ -394,7 +404,6 @@ func updateTable() {
 				fmt.Printf("Type anything to filter incoming flows in view\n")
 			}
 		}
-
 	}
 }
 

cmd/packet_capture.go

@@ -158,17 +158,21 @@ func runPacketCaptureOnAddr(port int, filename string) {
 		// terminate capture if max bytes reached
 		totalBytes = totalBytes + int64(len(fp.GenericMap.Value))
 		if totalBytes > maxBytes {
-			log.Infof("Capture reached %s, exiting now...", sizestr.ToString(maxBytes))
-			return
+			if exit := onLimitReached(); exit {
+				log.Infof("Capture reached %s, exiting now...", sizestr.ToString(maxBytes))
+				return
+			}
 		}
 		totalPackets = totalPackets + 1
 
 		// terminate capture if max time reached
 		now := currentTime()
 		duration := now.Sub(startupTime)
 		if int(duration) > int(maxTime) {
-			log.Infof("Capture reached %s, exiting now...", maxTime)
-			return
+			if exit := onLimitReached(); exit {
+				log.Infof("Capture reached %s, exiting now...", maxTime)
+				return
+			}
 		}
 
 		captureStarted = true

cmd/root.go

@@ -24,7 +24,7 @@ var (
 	logLevel string
 	ports    []int
 	nodes    []string
-	filter   string
+	options  string
 	maxTime  time.Duration
 	maxBytes int64
 
@@ -57,6 +57,7 @@ var (
 	outputBuffer     *bytes.Buffer
 	collectorStarted = false
 	captureStarted   = false
+	captureEnded     = false
 	stopReceived     = false
 	useMocks         = false
 	keyboardError    = ""
@@ -73,7 +74,7 @@ func init() {
 	rootCmd.PersistentFlags().StringVarP(&logLevel, "loglevel", "l", "info", "Log level")
 	rootCmd.PersistentFlags().IntSliceVarP(&ports, "ports", "", []int{9999}, "TCP ports to listen")
 	rootCmd.PersistentFlags().StringSliceVarP(&nodes, "nodes", "", []string{""}, "Node names per port (optionnal)")
-	rootCmd.PersistentFlags().StringVarP(&filter, "filter", "", "", "Filter(s)")
+	rootCmd.PersistentFlags().StringVarP(&options, "options", "", "", "Options(s)")
 	rootCmd.PersistentFlags().DurationVarP(&maxTime, "maxtime", "", 5*time.Minute, "Maximum capture time")
 	rootCmd.PersistentFlags().Int64VarP(&maxBytes, "maxbytes", "", 50000000, "Maximum capture bytes")
 	rootCmd.PersistentFlags().BoolVarP(&useMocks, "mock", "", false, "Use mock")
@@ -103,7 +104,8 @@ func onInit() {
 		log.Fatalf("specified nodes names doesn't match ports length")
 	}
 
-	log.Infof("Running network-observability-cli\nLog level: %s\nFilter(s): %s", logLevel, filter)
+	printBanner()
+	log.Infof("Log level: %s\nOption(s): %s", logLevel, options)
 	showKernelVersion()
 
 	if useMocks {
@@ -112,6 +114,17 @@ func onInit() {
 	}
 }
 
+func printBanner() {
+	fmt.Print(`
+------------------------------------------------------------------------
+         _  _     _       _                       ___ _    ___
+        | \| |___| |_ ___| |__ ___ ___ _ ___ __  / __| |  |_ _|
+        | .' / -_)  _/ _ \ '_ (_-</ -_) '_\ V / | (__| |__ | | 
+        |_|\_\___|\__\___/_.__/__/\___|_|  \_/   \___|____|___|
+
+------------------------------------------------------------------------`)
+}
+
 func showKernelVersion() {
 	output, err := exec.Command("uname", "-r").Output()
 	if err != nil {
@@ -123,3 +136,34 @@ func showKernelVersion() {
 		log.Infof("Kernel version: %s", strings.TrimSpace(string(output)))
 	}
 }
+
+func onLimitReached() bool {
+	shouldExit := false
+	if !captureEnded {
+		if strings.Contains(options, "background=true") {
+			captureEnded = true
+			resetTerminal()
+			out, err := exec.Command("/oc-netobserv", "stop").Output()
+			if err != nil {
+				log.Fatal(err)
+			}
+			fmt.Printf("%s", out)
+			fmt.Print(`Thank you for using...`)
+			printBanner()
+			fmt.Print(`
+
+	- Download the generated output using 'oc netobserv copy' command
+
+	- Once finished, clean the collector pod using 'oc netobserv cleanup'
+
+                                                      See you soon !
+																											
+																											
+		`)
+		} else {
+			shouldExit = true
+		}
+	}
+
+	return shouldExit
+}

cmd/root_test.go

@@ -73,7 +73,7 @@ func TestDefaultArguments(t *testing.T) {
 	assert.Equal(t, "info", logLevel)
 	assert.Equal(t, []int{9999}, ports)
 	assert.Equal(t, []string{""}, nodes)
-	assert.Empty(t, filter)
+	assert.Empty(t, options)
 }
 
 func setup() {

commands/netobserv

@@ -9,9 +9,11 @@ if [ -z "${isE2E+x}" ]; then isE2E=false; fi
 if [ -z "${captureStarted+x}" ]; then captureStarted=false; fi
 # prompt copy by default
 if [ -z "${copy+x}" ]; then copy="prompt"; fi
+# run foreground by default
+if [ -z "${runBackground+x}" ]; then runBackground="false"; fi
 
-# interface filter such as 'br-ex' or pcap filter such as 'tcp,80'
-filter=""
+# options such as filters, background etc
+options=""
 
 # CLI image to use
 img="quay.io/netobserv/network-observability-cli:main"
@@ -43,7 +45,7 @@ function flows() {
       exit 0 ;;
     *)
       shift # remove first argument
-      filter="$*"
+      options="$*"
       # run flows command
       command="flows" ;;
   esac
@@ -56,7 +58,7 @@ function packets() {
       exit 0 ;;
     *)
       shift # remove first argument
-      filter="$*"
+      options="$*"
       # run packets command
       command="packets" ;;
   esac
@@ -72,12 +74,15 @@ case "$1" in
     echo "Syntax: netobserv [flows|packets|cleanup] [options]"
     echo
     echo "commands:"
-    echo "  flows      Capture flows information. You can specify an optional interface name as filter such as 'netobserv flows br-ex'."
+    echo "  flows      Capture flows information in JSON format."
     echo "        Options:"
     flows_usage
     echo "  packets    Capture packets information in pcap format."
     echo "        Options:"
     packets_usage
+    echo "  follow     Follow collector logs when running in background."
+    echo "  stop       Stop collection by removing agent daemonset."
+    echo "  copy       Copy generated files locally."
     echo "  cleanup    Remove netobserv components."
     echo "  version    Print software version."
     echo
@@ -90,6 +95,18 @@ case "$1" in
     flows $* ;;
 "packets")
     packets $* ;;
+"follow")
+    # run follow command
+    follow
+    exit 0 ;;
+"stop")
+    # run deleteDaemonset command
+    deleteDaemonset
+    exit 0 ;;
+"copy")
+    # run copy output command
+    copyOutput
+    exit 0 ;;
 "cleanup")
     # run cleanup command
     cleanup
@@ -101,24 +118,44 @@ esac
 
 trap cleanup EXIT
 
-setup $command $filter
+setup $command $options
+
+# convert options to string
+optionStr="${options//--/}"
+optionStr="${optionStr// /|}"
+
+# prepare commands & args
+runCommand="sleep infinity"
+execCommand="/network-observability-cli get-$command ${optionStr:+"--options" "${optionStr}"} --loglevel $logLevel --maxtime $maxTime --maxbytes $maxBytes"
+if [[ "$runBackground" == "true" ]]; then
+  runCommand="$execCommand & $runCommand"
+  execCommand=""
+fi
 
 echo "Running network-observability-cli get-$command... "
 ${K8S_CLI_BIN} run \
   -n netobserv-cli \
   collector \
   --image=$img\
   --image-pull-policy='Always' \
+  --overrides='{ "spec": { "serviceAccount": "netobserv-cli" }  }' \
   --restart='Never' \
-  --command -- sleep infinity
+  --command -- $runCommand
 
 ${K8S_CLI_BIN} wait \
   -n netobserv-cli \
   --for=condition=Ready pod/collector || exit 1
 
 captureStarted=true
 
-${K8S_CLI_BIN} exec -i --tty \
-  -n netobserv-cli \
-  collector \
-  -- /network-observability-cli get-$command ${filter:+"--filter" "${filter//--/}"} --loglevel $logLevel --maxtime $maxTime --maxbytes $maxBytes
+if [ -n "${execCommand}" ]; then
+  ${K8S_CLI_BIN} exec -i --tty \
+    -n netobserv-cli \
+    collector \
+    -- $execCommand
+else 
+  echo "Background capture started. Use:"
+  echo " - '${K8S_CLI_BIN} netobserv follow' to see the capture progress"
+  echo " - '${K8S_CLI_BIN} netobserv copy' to copy the generated files locally"
+  echo " - '${K8S_CLI_BIN} netobserv cleanup' to remove the netobserv components"
+fi

e2e/script_test.go

@@ -30,7 +30,7 @@ func TestHelpCommand(t *testing.T) {
 		assert.Contains(t, str, "Find more information at: https://github.com/netobserv/network-observability-cli/")
 		// ensure help to display proper options
 		assert.Contains(t, str, "Syntax: netobserv [flows|packets|cleanup] [options]")
-		assert.Contains(t, str, "flows      Capture flows information. You can specify an optional interface name as filter such as 'netobserv flows br-ex'.")
+		assert.Contains(t, str, "flows      Capture flows information in JSON format.")
 		assert.Contains(t, str, "packets    Capture packets information in pcap format.")
 		assert.Contains(t, str, "cleanup    Remove netobserv components.")
 		assert.Contains(t, str, "version    Print software version.")