Startup Configuration File

AIStor supports using a YAML-formatted configuration file for specifying startup server parameters. The configuration file supports specific advanced deployment patterns, such as distributed clusters with non-sequential hostnames or otherwise heterogeneous hostname patterns.

The following example configuration lists all available fields and example values. Remove any parameters you do not need. The pools configuration includes an example of handling non-sequential hostnames across two distinct pools:

version: v2
address: ":9000"
console-address: ":9001"
rootUser: "minioadmin"
rootPassword: "secret-CHANGE-ME"
pools:
  - args:
      - "https://rack1.example.com:9000/mnt/disk{1...4}"
      - "https://rack3.example.com:9000/mnt/disk{1...4}"
      - "https://rack5.example.com:9000/mnt/disk{1...4}"
      - "https://rack7.example.com:9000/mnt/disk{1...4}"
  - args:
      - "https://rack2.example.com:9000/mnt/disk{1...4}"
      - "https://rack4.example.com:9000/mnt/disk{1...4}"
      - "https://rack6.example.com:9000/mnt/disk{1...4}"
      - "https://rack8.example.com:9000/mnt/disk{1...4}"
options:
  ftp: # settings for AIStor to act as an ftp server
    address: ":8021"
    passive-port-range: "30000-40000"
  sftp: # settings for AIStor to act as an sftp server
    address: ":8022"
    ssh-private-key: "/etc/minio/sftp-key"

The configuration file must include the version and pools fields.

The pools field takes an array of args, each of which define a set of hosts in a server pool. Each arg element is an endpoint string that supports standard ellipsis notation {n...m} for specifying sequential series of IP or hostnames. You can specify any combination of hosts and drives, allowing for more complex topologies without modifying OS settings like /etc/hosts or customized DNS configurations.

For example, the following configuration defines a pool with four hosts with heterogeneous naming conventions:

pools:
  - args:
      - "https://rack2.example.com:9000/mnt/disk{1...4}"
      - "https://rack4.example.com:9000/mnt/disk{1...4}"
      - "https://198.51.100.10:9000/mnt/disk{1...8}"
      - "https://203.0.113.10:9000/mnt/disk{1...8}"

While the pools configuration supports complex topologies, it requires careful planning and consideration around the consequences or outcomes of the selected infrastructure. For example, in the previous example the specfied hosts have uneven drive distribution. This results in certain hosts having a higher impact on HA and performance in the event of planned or unexpected downtime.

The options object supports configuration of FTP and SFTP services:

See File Transfer Protocol for more information on the FTP/SFTP feature.

The following table describes each configuration field and its corresponding environment variable or command line option. The table also lists the precedence order if the same parameter is set in multiple ways.