add yaml option (#148)

Author: jpinsonneau

cmd/config.yaml

@@ -1038,22 +1038,22 @@ filters:
     name: Xlat Zone Id
     component: number
   - id: xlat_src_address
-    name: Xlat src address
+    name: Xlat source address
     component: text
     category: source
     hint: Specify a single IP or range.
   - id: xlat_dst_address
-    name: Xlat dst address
+    name: Xlat destination address
     component: text
     category: destination
     hint: Specify a single IP or range.
   - id: xlat_src_port
-    name: Xlat src port
+    name: Xlat source port
     component: autocomplete
     category: source
     hint: Specify a single port number or name.
   - id: xlat_dst_port
-    name: Xlat dst port
+    name: Xlat destination port
     component: autocomplete
     category: destination
     hint: Specify a single port number or name.
@@ -1402,22 +1402,22 @@ fields:
     description: packet translation zone id
   - name: XlatSrcPort
     type: number
-    description: packet translation src port
+    description: packet translation source port
   - name: XlatDstPort
     type: number
-    description: packet translation dst port
+    description: packet translation destination port
   - name: XlatSrcAddr
     type: string
-    description: packet translation src address
+    description: packet translation source address
   - name: XlatDstAddr
     type: string
-    description: packet translation dst address
+    description: packet translation destination address
   - name: K8S_ClusterName
     type: string
     description: Cluster name or identifier
   - name: _RecordType
     type: string
-    description: "Type of record: 'flowLog' for regular flow logs, or 'newConnection', 'heartbeat', 'endConnection' for conversation tracking"
+    description: "Type of record: `flowLog` for regular flow logs, or `newConnection`, `heartbeat`, `endConnection` for conversation tracking"
   - name: _HashId
     type: string
     description: In conversation tracking, the conversation identifier

commands/netobserv

@@ -13,6 +13,10 @@ if [ -z "${captureStarted+x}" ]; then captureStarted=false; fi
 if [ -z "${copy+x}" ]; then copy="prompt"; fi
 # run foreground by default
 if [ -z "${runBackground+x}" ]; then runBackground="false"; fi
+# output as yaml only
+if [ -z "${outputYAML+x}" ]; then outputYAML="false"; fi
+# formated date for file names
+if [ -z "${dateName+x}" ]; then dateName="$(date +"%Y_%m_%d_%I_%M")"; fi
 
 # options such as filters, background etc
 options=""
@@ -53,10 +57,17 @@ maxTime="5m"
 # max bytes (default: 50MB)
 maxBytes=50000000
 
+# skip dependencies check for help or version
 if [[ ! "$*" =~ ^(.*)help|version(.*) ]]; then
   check_dependencies "$required_yq_version" "$supported_archs" "$required_bash_version"
 fi
 
+# detect output yaml option before running the script to avoid any apply
+if [[ "$*" =~ ^(.*)yaml=true|(yaml$)|(yaml )(.*) ]]; then
+  echo "Output YAMLs without applying..."
+  outputYAML="true"
+fi
+
 case "$1" in
 *help)
   help
@@ -178,21 +189,35 @@ if [[ "$command" == "flows" || "$command" == "packets" ]]; then
   # 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"
+  if [[ "$runBackground" == "true" || "$outputYAML" == "true" ]]; then
+    runCommand="bash -c \"$execCommand && $runCommand\""
     execCommand=""
   fi
+  cmd="${K8S_CLI_BIN} run -n $namespace collector \\
+  --image=$img --image-pull-policy='Always' --restart='Never' \\
+  --overrides='{\"spec\": {\"serviceAccount\": \"netobserv-cli\"}}' \\
+  --command -- $runCommand"
 
-  echo "Running network-observability-cli get-$command... "
-  ${K8S_CLI_BIN} run \
-    -n $namespace \
-    collector \
-    --image=$img --image-pull-policy='Always' \
-    --overrides='{ "spec": { "serviceAccount": "netobserv-cli" }  }' \
-    --restart='Never' \
-    --command -- $runCommand
+  if [[ "$outputYAML" == "true" ]]; then
+    echo "Check the generated YAML file in output folder."
+    echo
+    echo "You can create $command agents by executing:"
+    echo " ${K8S_CLI_BIN} apply -f ./output/${command}_capture_${dateName}.yml"
+    echo
+    echo "Then create the collector using:"
+    echo -e " $cmd"
+    echo
+    echo "And follow its progression with:"
+    echo " ${K8S_CLI_BIN} logs collector -n $namespace -f"
+    echo
+    exit 0
+  fi
+
+  echo "Running network-observability-cli get-$cmd... "
+  eval "$cmd"
 
   ${K8S_CLI_BIN} wait \
+    --timeout 60s \
     -n $namespace \
     --for=condition=Ready pod/collector || exit 1
 
@@ -210,6 +235,16 @@ if [[ "$command" == "flows" || "$command" == "packets" ]]; then
     echo " - '${K8S_CLI_BIN} netobserv cleanup' to remove the netobserv components"
   fi
 elif [ "$command" = "metrics" ]; then
+  if [[ "$outputYAML" == "true" ]]; then
+    echo "Check the generated YAML file in output folder."
+    echo
+    echo "You can create metrics agents by executing:"
+    echo " ${K8S_CLI_BIN} apply -f ./output/${command}_capture_${dateName}.yml"
+    echo 
+    echo "Then open your OCP Console and search for netobserv-cli dashboard"
+    echo
+    exit 0
+  fi
   runBackground="true"
   echo "Metrics capture started."
   consoleURL="$(oc whoami --show-console)"