Command line parameters

Command Line Parameters

The usage details for the Cluster Optimizer can be obtained by executing the --help command, as shown below:

$optimizer --help
Usage:
  optimizer optimizer [flags]

Flags:
      --features stringArray Enable features, available features are [APIServer, Optimizer]
  -h, --help help for optimizer

Global Flags:
      --config string config file (default is $OPTIMIZER_HOME/conf/cluster-optimizer.yaml)
      --log-enable-color Enable color in log
      --log-enable-console Enable log to console
      --log-format string Set the log format (json or text) (default "json")
      --log-level string Set the log level (debug, info, warn, error, fatal) (default "info")

The following sections provide an in-depth explanation of each parameter.

Parameter Descriptions

--help

The --help flag displays usage information for the command line interface, providing an overview of available commands and flags.

-f, --features

The -f, --features flags specify which features of the Cluster Optimizer should be activated. The available features are APIServer, which enables only the API services, and Optimizer, which activates the optimization functionalities. By default, both APIServer and Optimizer are enabled, allowing for both automatic scaling features and virtual capacity management.

--config

The --config parameter specifies the path to the configuration file used by the cluster optimization platform. For details on configuring this file, refer to the Configuration File documentation.

--log-enable-color

The --log-enable-color flag determines whether to enable color coding in log outputs. Enabling this option can enhance log readability in console interfaces. The default value is false, meaning color is not enabled by default.

--log-enable-console

The --log-enable-console flag enables logging to the console, which can be particularly useful when logs are accessed via the kubectl log command. The default setting is false, indicating that console logging is disabled by default.

--log-format

The --log-format flag sets the format for log output. The available formats are json and text, with json being the default format. This parameter allows users to tailor the log output format to their needs.

--log-level

The --log-level parameter defines the verbosity of log outputs. The possible values are debug, info, warn, error, and fatal, with info being the default setting. This allows users to control the level of detail provided in the logs.