Skip to content

v1.3.1

Choose a tag to compare

@leighwgordon leighwgordon released this 26 Nov 03:06
1aa2c60

exporter-install-scripts

Documentation

https://github.com/smc-public/exporter-install-scripts

Usage

Usage: [EXPORTER_NAME]-install.sh [ARGUMENTS]
  or: [EXPORTER_NAME]-install.sh --uninstall

Mandatory arguments to long options are mandatory for short options too.

INSTALL MODE ARGUMENTS
  -a, --allow-upgrade                 allow script to overwrite existing installation [default: false]
  -c, --allow-create-user             allow script to create user and group if they don't exist [default: false]
  -A, --allow-all-actions             shorthand to enable all '--allow-*' actions [default: false]
  -u, --user SERVICE_USER             service user account [default: root]
  -g, --group SERVICE_GROUP           service user account [default: SERVICE_USER]

UNINSTALL MODE ARGUMENTS
  -U, --uninstall                     uninstall exporter installation directory and service [default: false]
                                        uninstall does *not* remove user/group created by previous invocations

COMMON ARGUMENTS
  -C, --chroot                        run the script in chroot mode [default: false]
                                        does not start/stop services or perform any other actions which will not work
                                        correctly when run in a chroot environment (e.g. when installing into an image)
  -o, --output-format OUTPUT_FORMAT   output format [accepted values: text, json] [default: text]
                                        JSON format suppresses output to STDOUT, and instead outputs a JSON summary upon
                                        script completion (log file is still written to disk)
  -v, --verbose                       output additional debugging statements for internal script operations
  -h, --help                          display this help and exit

Bundles

These scripts provide a mechanism for installing predetermined installations of multiple exporters with hardcoded
parameters. This enables a standard and predictable way to install multiple exporters (e.g. when creating machine
images). For additional scenarios, additional bundles may be created or for advanced/non-standard use cases, the
installation scripts should be installed and parameterised individually in the downstream tooling.

Available bundles

  • defaultgpu - installs Node Exporter, SMC Exporter and DCGM Exporter with services running as root