closes #191
This pull request implements a significant refactor to the falcon-container-sensor-pull.sh script and the corresponding README to enhance usability and maintainability. The changes primarily revolve around how sensor types are selected for download.
Changes Introduced:
Replaced the individual flags -n, --node, --kubernetes-admission-controller, and --kubernetes-protection-agent with a single option, -t, --type <SENSOR_TYPE>. This option allows users to specify which sensor to download with a more concise and maintainable syntax.
Ensured backward compatibility for the replaced flags. This update includes a depraction warning to prepare users for the future removal of the cli args.
Added a detailed "Sensor Types" section to the README, providing users with a straightforward reference for available sensor types and their descriptions.
Ensured backward compatibility with the deprecated $SENSORTYPE environment variable. This update includes a deprecation warning to prepare users for the future removal of $SENSORTYPE.
Updated the shell script to validate the SENSOR_TYPE value against the list of valid sensor types. An unrecognized sensor type will now yield a descriptive error message, guiding users towards valid options.
Benefits:
This update simplifies the selection of sensor types by replacing multiple flags with a single, intuitive flag.
By providing a clear description of available sensor types in the README, this update enhances user understanding and facilitates easier selection of sensor types.
The improved error messaging for invalid sensor types will reduce user confusion and help users troubleshoot issues more effectively.
By simplifying the process of selecting sensor types and enhancing the related documentation, this PR aims to improve user experience and facilitate future maintenance of the falcon-container-sensor-pull.sh script.
closes #191 This pull request implements a significant refactor to the
falcon-container-sensor-pull.shscript and the corresponding README to enhance usability and maintainability. The changes primarily revolve around how sensor types are selected for download.Changes Introduced:
Replaced the individual flags
-n,--node,--kubernetes-admission-controller, and--kubernetes-protection-agentwith a single option,-t,--type <SENSOR_TYPE>. This option allows users to specify which sensor to download with a more concise and maintainable syntax.Ensured backward compatibility for the replaced flags. This update includes a depraction warning to prepare users for the future removal of the cli args.
Added a detailed "Sensor Types" section to the README, providing users with a straightforward reference for available sensor types and their descriptions.
Ensured backward compatibility with the deprecated
$SENSORTYPEenvironment variable. This update includes a deprecation warning to prepare users for the future removal of$SENSORTYPE.Updated the shell script to validate the
SENSOR_TYPEvalue against the list of valid sensor types. An unrecognized sensor type will now yield a descriptive error message, guiding users towards valid options.Benefits:
This update simplifies the selection of sensor types by replacing multiple flags with a single, intuitive flag.
By providing a clear description of available sensor types in the README, this update enhances user understanding and facilitates easier selection of sensor types.
The improved error messaging for invalid sensor types will reduce user confusion and help users troubleshoot issues more effectively.
By simplifying the process of selecting sensor types and enhancing the related documentation, this PR aims to improve user experience and facilitate future maintenance of the
falcon-container-sensor-pull.shscript.