Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuaboud authored Dec 5, 2019
1 parent b96e9e3 commit e714b1b
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,28 @@ Create a [crontab](https://linux.die.net/man/5/crontab) entry to periodically ru

## Configuration
### Autotier Config
#### Global Config
For global configuration of `autotier`, options are placed below the `[Global]` header. Currently the only global option is log level, which can be set to either 0 (no logging), 1 (basic logging), or 2 (debug logging), and defaults to 1. Example:
```
[Global]
LOG_LEVEL=2
```
The global config section can be placed before, after, or between tier definitions.
#### Tier Config
The layout of a single tier's configuration entry is as follows:
```
[<Tier name>]
DIR=/path/to/storage/tier
EXPIRES=<number of seconds until file expiry>
USAGE_WATERMARK=<0-100% of tier usage at which to tier down old files>
```
As many tiers as desired can be defined in the configuration, however they must be in order of fastest to slowest. The tier's name can be whatever you want, as it is just used for config diagnostics. Usage watermark can be disabled by omitting the option in the configuration file, causing `autotier` to always tier down files older than the defined expiry age.
Below is an example of a configuration file:
As many tiers as desired can be defined in the configuration, however they must be in order of fastest to slowest. The tier's name can be whatever you want but it cannot be `global` or `Global`. Tier names are only used for config diagnostics. Usage watermark can be disabled by omitting the option in the configuration file, causing `autotier` to always tier down files older than the defined expiry age.
Below is a complete example of a configuration file:
```
# autotier.conf
[Global]
LOG_LEVEL=0
[Fastest Tier]
DIR=/tier_1 # fast tier storage pool
EXPIRES=3600 # one hour
Expand Down

0 comments on commit e714b1b

Please sign in to comment.