github.com/whamcloud/lemur@v0.0.0-20190827193804-4655df8a52af/man/lhsmd.1.md (about) 1 % LHSMD (1) User Manual 2 % Intel Corporation 3 % REPLACE_DATE 4 5 # NAME 6 7 lhsmd - Lustre HSM Agent 8 9 # SYNOPSIS 10 11 lhsmd [-config *FILE*] [-debug] 12 13 # DESCRIPTION 14 15 Lhsmd is a Lustre HSM Agent. It handles HSM requests from the Lustre 16 coordinator, and forwards the requests to the configured data mover 17 plugins based on the archive id of the request. The configuration of 18 the plugins specifies which Lustre Archive ID is associated with an a 19 each archive endpoint. More than one plugin can be used at the same 20 time, and each data mover can support multiple archive IDs and 21 endpoints. 22 23 The agent configuration file specifies which Lustre filesystem is being managed, 24 which plugins to start, and options storing 25 metrics in an InfluxDB database. By default, example config files are 26 provided in `/etc/lhsmd`. These can be copied to the correct, non 27 ".example" name and customized accordingly. 28 29 Although the agent can be run directly on the command for debugging 30 purposes, for production use we recommend using systemd (or equivalent) to 31 manage and run the lhsmd service to ensure only one agent runs per 32 host. 33 34 # systemctl enable lhsmd 35 # systemctl start lhsmd 36 37 # OPTIONS 38 39 -config *FILE* 40 : Specify configuration file instead of using default 41 `/etc/lhsmd/agent`. 42 43 -debug 44 : Enable debug logging. 45 46 # GENERAL USAGE 47 48 The default location for the agent configuration file is `/etc/lhsmd/agent`. These are the configuration options available. 49 50 `client_device` 51 : Required option, the `client_device` the mount target for the Lustre filesystem the agent will be using. The 52 agent will create mount points of the filesystem for itself and for each of the configured plugins. 53 54 `mount_root` 55 : The `mount_root` is the location for the Lustre mount points created by the agent. 56 57 `enabled_plugins` 58 : A list of plugins to start. If the plugin name is not an absolute path, the agent will search for a binary 59 matching the plugin name provided here. 60 61 `plugin_dir` 62 : An additional directory to search for plugins. 63 64 `handler_count` 65 : Number of threads that will be used to process HSM requests in the agent. (The number of threads in the 66 plugins is configured separately) 67 68 `snapshots` 69 : Optional section to enable the HSM Snapshot feature. When this is enabled, 70 then each time a file is archived, the agent will create a released copy of file in 71 `.hsmsnapshot` which corresponds to archived version of the file. If the original file 72 is changed or deleted, then the snapshot can be used to retrieve the archived version. 73 74 `enabled` 75 : If true, then the experimental HSM snapshot feature is enabled. 76 77 `influxdb` 78 : Optional section for storing `lhsmd` metrics in an InfluxDB database. 79 80 `url` 81 : Optional URL used for sending metrics to an InfluxDB. If not set, the metrics will not be saved. 82 83 `db` 84 : Name for the database for metrics. 85 86 `user` 87 : InfluxDB user name. 88 89 `password` 90 : InfluxDB password. 91 92 # EXAMPLES 93 94 A sample agent configuration that enables the snapshot feature: 95 96 mount_root= "/var/lib/lhsmd/roots" 97 client_device= "10.0.2.15@tcp:/lustre" 98 enabled_plugins = ["lhsm-plugin-posix", "lhsm-plugin-s3"] 99 handler_count = 4 100 snapshots { 101 enabled = true 102 } 103 104 influxdb { 105 url = "http://10.0.1.123:8086" 106 db = "lhsmd" 107 user = "*user*" 108 password = "*password*" 109 } 110 111 # SEE ALSO 112 113 `lhsm-plugin-s3` (1), `lhsm-plugin-posix` (1), `lfs-hsm` (1)