Référence CLI

Référence des sous-commandes rustfs, des indicateurs du serveur, des équivalents en variables d’environnement et de la syntaxe des chemins de volume.

Le binaire rustfs fournit six sous-commandes. L’exécution de rustfs sans sous-commande démarre le serveur.

Sous-commandes

CommandeDescription
rustfs server [OPTIONS] <VOLUMES>...Démarre le serveur de stockage objet (comportement par défaut lorsqu’aucune sous-commande n’est fournie).
rustfs info [--all] [--json] [system|runtime|build|config|deps]Affiche les informations sur le système, l’exécution, la compilation, la configuration ou les dépendances.
rustfs tls inspect --path <DIR>Inspecte la disposition d’un répertoire de certificats TLS et l’état de son analyse.
rustfs diagnose [OPTIONS] <PATHS>...Analyse les fichiers journaux et signale les causes d’échec probables.
rustfs inspect <COMMAND>Inspecte les métadonnées de compartiment (bucket) persistées, sans serveur en cours d’exécution.
rustfs connect <COMMAND>Configure l’intégration sortante RustFS Connect.
Examples
rustfs server /data/rustfs
rustfs info --all --json
rustfs tls inspect --path /etc/rustfs/tls

Compatibilité des invocations historiques

Les arguments sont prétraités pour la rétrocompatibilité, afin que les anciens styles d’invocation continuent de fonctionner :

Forme historiqueInterprétée comme
rustfs /datarustfs server /data
rustfs --address :9000 /datarustfs server --address :9000 /data
rustfs (sans argument)rustfs server avec les volumes lus depuis RUSTFS_VOLUMES
rustfs --inforustfs info
rustfs helprustfs --help

Indicateurs du serveur

Chaque indicateur du serveur possède une variable d’environnement équivalente ; l’indicateur l’emporte lorsque les deux sont définis.

IndicateurVariable d’environnementValeur par défautDescription
<VOLUMES>... (positionnel)RUSTFS_VOLUMESobligatoireVolumes ou points de terminaison de stockage, séparés par des espaces.
--addressRUSTFS_ADDRESS:9000Adresse d’écoute de l’API S3 (ADDRESS:PORT, adresse IP ou nom d’hôte).
--server-domainsRUSTFS_SERVER_DOMAINSnon définieDomaines séparés par des virgules pour les requêtes en adressage de type hôte virtuel.
--access-keyRUSTFS_ACCESS_KEYnon définieClé d’accès racine (incompatible avec --access-key-file).
--access-key-fileRUSTFS_ACCESS_KEY_FILEnon définieFichier contenant la clé d’accès racine.
--secret-keyRUSTFS_SECRET_KEYnon définieClé secrète racine (incompatible avec --secret-key-file).
--secret-key-fileRUSTFS_SECRET_KEY_FILEnon définieFichier contenant la clé secrète racine.
--console-enableRUSTFS_CONSOLE_ENABLEtrueActive la console web intégrée.
--console-addressRUSTFS_CONSOLE_ADDRESS:9001Adresse d’écoute de la Console.
--obs-endpointRUSTFS_OBS_ENDPOINTvideURL de base OTLP/HTTP pour les traces, les métriques et les journaux.
--tls-pathRUSTFS_TLS_PATHnon définieRépertoire de certificats TLS pour l’API et la Console.
--licenseRUSTFS_LICENSEnon définieChaîne de licence.
--regionRUSTFS_REGIONnon définieRégion du service signalée aux clients.
--kms-enableRUSTFS_KMS_ENABLEfalseActive le chiffrement côté serveur KMS.
--kms-backendRUSTFS_KMS_BACKENDlocalBackend KMS : local, vault / vault-kv2, vault-transit.
--kms-key-dirRUSTFS_KMS_KEY_DIRnon définieRépertoire de clés du backend KMS local.
--kms-local-master-keyRUSTFS_KMS_LOCAL_MASTER_KEYnon définieClé principale pour le chiffrement des fichiers de clés du KMS local.
--kms-vault-addressRUSTFS_KMS_VAULT_ADDRESSnon définieAdresse Vault pour les backends Vault.
--kms-vault-tokenRUSTFS_KMS_VAULT_TOKENnon définieJeton Vault pour les backends Vault.
--kms-vault-mount-pathRUSTFS_KMS_VAULT_MOUNT_PATHnon définiePoint de montage Transit pour vault-transit (vaut transit par défaut) ; obsolète et inutilisé pour vault / vault-kv2.
--kms-default-key-idRUSTFS_KMS_DEFAULT_KEY_IDnon définieID de clé KMS par défaut pour le chiffrement.
--kms-allow-insecure-dev-defaultsRUSTFS_KMS_ALLOW_INSECURE_DEV_DEFAULTSfalseAutorise les valeurs par défaut KMS non sécurisées, réservées au développement.
--buffer-profileRUSTFS_BUFFER_PROFILEGeneralPurposeProfil de charge pour le dimensionnement adaptatif des tampons.
--buffer-profile-disableRUSTFS_BUFFER_PROFILE_DISABLEfalseUtilise les tampons de taille fixe historiques.

Si ni --access-key/--secret-key ni leurs variantes fichier ne sont fournis, le serveur revient aux identifiants par défaut intégrés (rustfsadmin/rustfsadmin) et journalise un avertissement. Définissez de véritables identifiants pour tout déploiement qui n’est pas à usage jetable.

Syntaxe des volumes

Les volumes sont transmis comme arguments positionnels (ou via RUSTFS_VOLUMES) et sont séparés par des espaces.

Expansion des ellipses

Un jeton de volume peut contenir une ou plusieurs plages {N...M}, qui s’étendent numériquement :

Ellipses expansion
# Expands to /data/rustfs0 /data/rustfs1 /data/rustfs2 /data/rustfs3
rustfs server /data/rustfs{0...3}

# Multi-node: expands across hosts and disks
rustfs server http://node{1...4}:9000/data/rustfs{0...3}

Règles vérifiées dans l’analyseur :

  • Le format de plage est {N...M}, où N et M sont des entiers positifs décimaux ou hexadécimaux et où M doit être supérieur à N.
  • Un seul jeton peut porter plusieurs plages (par exemple une plage d’hôtes et une plage de disques) ; toutes les combinaisons sont développées.
  • La taille maximale développée d’une plage est de 10 000 entrées.

Plusieurs pools

Des pools de serveurs distincts s’expriment comme des groupes de points de terminaison séparés par des espaces. Chaque argument (un par espace) forme son propre groupe d’expansion :

Two pools
rustfs server http://node{1...4}:9000/data/rustfs{0...3} http://node{5...8}:9000/data/rustfs{0...3}

Lorsqu’elle est définie via l’environnement, la même chaîne est placée dans RUSTFS_VOLUMES :

Via environment
export RUSTFS_VOLUMES="http://node{1...4}:9000/data/rustfs{0...3}"
rustfs server

On this page