Common configuration examples for ossfs 2.0 - Object Storage Service

Pour monter un compartiment Object Storage Service (OSS), vous avez besoin d'un fichier de configuration adapté à votre scénario. Utilisez ce fichier lors du montage du compartiment.

Créer un fichier de configuration

Important

Chaque fichier de configuration ne permet de monter qu'un seul compartiment. Pour monter plusieurs compartiments, créez un fichier de configuration distinct pour chacun. Vous pouvez personnaliser les noms et les chemins des fichiers.

Vous pouvez utiliser n'importe quel nom et chemin pour le fichier de configuration ossfs 2,0. Par exemple, créez un fichier nommé /etc/ossfs2.conf.

sudo touch /etc/ossfs2.conf

Configurer les identifiants d'accès

Paire AccessKey

À partir d'ossfs 2.0.1, utilisez des variables d'environnement pour configurer la paire AccessKey d'un utilisateur Resource Access Management (RAM) afin de monter un compartiment OSS. Cette méthode est plus sécurisée et pratique. Les identifiants configurés via des variables d'environnement n'ont pas besoin d'être spécifiés à nouveau dans le fichier de configuration.

Variables d'environnement

export OSS_ACCESS_KEY_ID=LTAI******************
export OSS_ACCESS_KEY_SECRET=8CE4**********************

Fichier de configuration

--oss_endpoint=https://oss-cn-hangzhou-internal.aliyuncs.com
--oss_bucket=bucketName
--oss_access_key_id=AAAI************
--oss_access_key_secret=AAA8x*************************

Rôle RAM d'instance

À partir d'ossfs 2.0.2, configurez les identifiants d'accès en utilisant un rôle RAM d'instance dans le fichier de configuration.

--oss_endpoint=https://oss-cn-hangzhou-internal.aliyuncs.com
--oss_bucket=bucketName
--ram_role=EcsRamRoleOssTest

Processus externe

À partir d'ossfs 2.0.5, vous pouvez utiliser une commande pour démarrer un processus externe indépendant. Ce processus renvoie son résultat à ossfs via la sortie standard.

Important

Pour éviter les risques de sécurité, assurez-vous que la commande utilisée pour générer les identifiants n'est pas accessible aux processus ou utilisateurs non autorisés.
Vérifiez que la commande générant les identifiants n'écrit aucune information sensible sur stderr, car cela pourrait exposer ces informations à des utilisateurs non autorisés via la capture ou la journalisation.

Identifiants à long terme

{
  "AccessKeyId" : "ak",
  "AccessKeySecret" : "sk"
}

Identifiants temporaires

{
  "AccessKeyId" : "ak",
  "AccessKeySecret" : "sk",
  "Expiration" : "2025-12-29T07:45:02Z",
  "SecurityToken" : "token"
}

Le champ Expiration spécifie l'heure UTC au format ISO 8601.

Utilisez le format suivant pour configurer un processus externe :

--credential_process=user-cmd

Définissez use-cmd en fonction de votre cas d'utilisation. Les exigences de configuration sont les suivantes :

Si un paramètre ou un nom de fichier contient des espaces, placez la chaîne correspondante entre guillemets doubles ("").
Spécifiez le chemin complet vers l'exécutable, tel que /bin/bash, /bin/echo ou /bin/curl.
N'incluez aucune variable d'environnement dans la commande, telle que $HOME.

Voici quelques exemples courants :

Pour obtenir les identifiants à partir d'un fichier temporaire tel que /etc/creds.txt, utilisez la configuration suivante : --credential_process=/bin/cat /etc/creds.txt.
Pour récupérer les identifiants d'accès depuis un service personnalisé, utilisez la configuration suivante : --credential_process=/bin/curl <custom_service_endpoint>.

Important

ossfs valide uniquement que les paramètres sont au format JSON valide et incluent les champs requis. Assurez-vous que la commande que vous configurez produit des identifiants d'accès complets et valides. Par exemple, si vous utilisez un fichier temporaire, assurez-vous que les mises à jour du fichier sont atomiques, ou utilisez des mécanismes tels que flock pour appliquer l'exclusion mutuelle pour les opérations de lecture et d'écriture.

Format du fichier de configuration

Format

Le préfixe -- indique une option de montage. <option> est le nom de l'option, et value dans [=<value>] est sa valeur correspondante. Les crochets [] indiquent que la valeur est facultative.

--<option>[=<value>]

Exemple

# Endpoint of the region where the bucket is located
--oss_endpoint=https://oss-cn-hangzhou-internal.aliyuncs.com
# bucket name
--oss_bucket=bucketName
# AccessKey ID and AccessKey secret. (Optional) For ossfs 2.0.1 and later, you can configure access credentials by using environment variables instead of setting them in the configuration file.
--oss_access_key_id=AAAI************
--oss_access_key_secret=AAA8x*************************

Exemples de configuration

Remarque

Pour afficher l'endpoint d'un compartiment, accédez à la page Buckets, sélectionnez le compartiment cible, puis cliquez sur Overview dans le volet de navigation de gauche. L'endpoint s'affiche dans la section Port. Les exemples suivants utilisent un compartiment situé dans la région Chine (Hangzhou).

Les endpoints pour un compartiment dans la région Chine (Hangzhou) sont les suivants : l'endpoint public est oss-cn-hangzhou.aliyuncs.com. L'endpoint interne pour l'accès depuis une instance Elastic Compute Service (ECS) dans le réseau classique ou un Virtual Private Cloud (VPC) est oss-cn-hangzhou-internal.aliyuncs.com. L'endpoint d'accélération de transfert pour les téléchargements et téléversements mondiaux est oss-accelerate.aliyuncs.com. L'endpoint OSS accelerator est cn-hangzhou-internal.oss-data-acc.aliyuncs.com. Tous les endpoints prennent en charge HTTPS.

Ouvrez le fichier de configuration ossfs 2,0 que vous avez créé et configurez-le selon les exemples suivants. Tous les exemples utilisent un endpoint interne dans la région Chine (Hangzhou). Vous pouvez utiliser des endpoints internes et des endpoints OSS accelerator pour monter un compartiment uniquement depuis une instance dans un Virtual Private Cloud (VPC) au sein de la même région. Ces endpoints offrent des transferts de données plus rapides et plus stables. Nous déconseillons l'utilisation d'ossfs avec un endpoint public, car une latence élevée et des connexions Internet instables peuvent entraîner des problèmes de performances.

Monter un compartiment entier

Montez tous les répertoires et fichiers d'un compartiment dans un répertoire local.

# Endpoint of the region where the bucket is located
--oss_endpoint=https://oss-cn-hangzhou-internal.aliyuncs.com
# bucket name
--oss_bucket=bucketName
# AccessKey ID and AccessKey secret (optional for ossfs 2.0.1 and later)
--oss_access_key_id=LTAI******************
--oss_access_key_secret=8CE4**********************

Monter un répertoire spécifique

Lors du montage d'un compartiment, montez uniquement un répertoire spécifique du compartiment dans un répertoire local.

# Endpoint of the region where the bucket is located
--oss_endpoint=https://oss-cn-hangzhou-internal.aliyuncs.com
# bucket name
--oss_bucket=bucketName
# Path of the directory in the OSS bucket (optional)
--oss_bucket_prefix=folder-test/folder-prefix/
# AccessKey ID and AccessKey secret (optional for ossfs 2.0.1 and later)
--oss_access_key_id=LTAI******************
--oss_access_key_secret=8CE4**********************

Monter avec une limite de mémoire

Lors du montage d'un compartiment, vous pouvez allouer une quantité spécifique de mémoire au processus ossfs 2,0.

Important

Par défaut, ossfs 2,0 est optimisé pour les performances, utilisant jusqu'à environ 8 Go de mémoire pour les lectures et écritures de données. Si vos ressources mémoire sont limitées, configurez l'option total_mem_limit pour éviter les problèmes de manque de mémoire (OOM).

# Endpoint of the region where the bucket is located
--oss_endpoint=https://oss-cn-hangzhou-internal.aliyuncs.com
# bucket name
--oss_bucket=bucketName
# Memory limit in bytes (optional)
--total_mem_limit=4294967296
# AccessKey ID and AccessKey secret (optional for ossfs 2.0.1 and later)
--oss_access_key_id=LTAI******************
--oss_access_key_secret=8CE4**********************

Monter avec la journalisation de débogage

Définissez le niveau de journalisation sur debug et spécifiez un chemin personnalisé pour stocker les journaux.

# Endpoint of the region where the bucket is located
--oss_endpoint=https://oss-cn-hangzhou-internal.aliyuncs.com
# bucket name
--oss_bucket=bucketName
# Directory to store logs (optional). Ensure the /tmp/log directory exists.
--log_dir=/tmp/log/ossfs2
# Log level (optional)
--log_level=debug
# AccessKey ID and AccessKey secret (optional for ossfs 2.0.1 and later)
--oss_access_key_id=LTAI******************
--oss_access_key_secret=8CE4**********************

Monter avec des permissions d'accès

Important

Par défaut, ossfs 2,0 permet à tous les utilisateurs de lire et d'écrire tous les fichiers. Si vous avez besoin de permissions plus strictes, utilisez les paramètres suivants. Ces exemples s'appliquent uniquement à ossfs 2.0.1 et versions ultérieures.

Montez tous les répertoires du compartiment dans un répertoire local et refusez l'accès en lecture et écriture aux utilisateurs autres que root.

# Endpoint of the region where the bucket is located
--oss_endpoint=https://oss-cn-hangzhou-internal.aliyuncs.com
# bucket name
--oss_bucket=bucketName
# Deny access to users other than the mounting user
--allow_other=false
# Global directory permissions
--dir_mode=0755
# Global file permissions
--file_mode=0644
# AccessKey ID and AccessKey secret (optional for ossfs 2.0.1 and later)
--oss_access_key_id=LTAI******************
--oss_access_key_secret=8CE4**********************

Montez tous les répertoires du compartiment, en accordant des permissions de lecture et d'écriture à un utilisateur spécifique (défini par uid et gid) et des permissions en lecture seule aux autres.

# Endpoint of the region where the bucket is located
--oss_endpoint=https://oss-cn-hangzhou-internal.aliyuncs.com
# bucket name
--oss_bucket=bucketName
# Global directory permissions
--dir_mode=0755
# Global file permissions
--file_mode=0644
# Specific user UID and GID (use the id command to get the user's UID and GID)
--uid=1000
--gid=1000
# AccessKey ID and AccessKey secret (optional for ossfs 2.0.1 and later)
--oss_access_key_id=LTAI******************
--oss_access_key_secret=8CE4**********************

Étapes suivantes

Après avoir installé et configuré ossfs 2,0, vous pouvez monter un compartiment sur votre système Linux. Pour plus d'informations, consultez la rubrique Monter un compartiment.

Rubriques connexes

Pour plus d'informations sur les options de montage ossfs 2,0, consultez la rubrique Options de montage.