gcsfuse CLI

このページでは、Cloud Storage FUSE の操作に使用する gcsfuse コマンドライン オプションについて説明します。

概要

gcsfuse GLOBAL_OPTIONS BUCKET_NAME MOUNT_POINT

ここで

  • GLOBAL_OPTIONS は、マウントの設定方法と Cloud Storage FUSE の動作を制御するオプションです。

  • BUCKET_NAME は、マウントするバケットの名前です。たとえば、my-mount-bucket のようにします。省略可。動的マウントを実行するときに、このコマンドからバケット名を除外します。

  • MOUNT_POINT は、バケットがマウントされるローカル ディレクトリです。例: /path/to/mount/point

説明

gcsfuse CLI は、Cloud Storage バケットをファイル システムとしてローカルマシンにマウントするために使用します。

グローバル オプション

グローバル オプション 説明
--anonymous-access BOOLEAN リクエストの認証を無効にします。このフラグは、認証をサポートしていないカスタム エンドポイントを使用している場合に設定する必要があります。一般公開バケットで Cloud Storage FUSE を使用している場合も、このフラグを設定する必要があります。デフォルト値は false です。
--app-name VALUE マウントのアプリケーション名。
--billing-project VALUE マウントされたバケットにアクセスされたときに、課金に使用するプロジェクトを指定します。リクエスト元による支払いで有効にしたバケットをマウントするときに、多くの場合、このフラグは必要になります。デフォルトのプロジェクトはありません。
--client-protocol VALUE Cloud Storage バックエンドとの通信に使用されるプロトコルを指定します。HTTP/1.1 の場合、値は http1 になり、HTTP/2 の場合は http2 になります。デフォルト値は http1 です。
--config-file VALUE Cloud Storage FUSE の動作の構成に使用する構成ファイルのパスを指定します。例: --config-file /etc/gcsfuse.yaml
--custom-endpoint VALUE データを取得するための代替カスタム エンドポイントを指定します。 カスタム エンドポイントは、Cloud Storage JSON エンドポイント https://storage.googleapis.com/storage/v1 と同等のリソースとオペレーションをサポートする必要があります。カスタム エンドポイントが指定されていない場合、Cloud Storage FUSE はグローバル Cloud Storage JSON API エンドポイント https://storage.googleapis.com/storage/v1 を使用します。指定したカスタム エンドポイントで認証がサポートされていない場合は、--anonymous-access フラグを true に設定して認証をバイパスします。
--debug_fuse_errors 除外した場合、False と評価され、FUSE エラーがコンソール(--foreground の使用時)またはログファイル(--log-file の使用時)に記録されません。
--debug_fuse FUSE 関連のデバッグ出力を有効にします。このオプションを指定すると、ログの重大度が自動的に trace に設定されます。これには、トレースログ、デバッグログ、情報ログ、警告ログ、エラーログが含まれます。
--debug_gcs Cloud Storage のリクエストとタイミング情報を出力します。このオプションを指定すると、ログの重大度が自動的に trace に設定されます。これには、トレースログ、デバッグログ、情報ログ、警告ログ、エラーログが含まれます。
--debug-invariants 内部不変条件に違反した場合、パニックが発生します。
--debug_mutex ミューテックスの保持時間が長くなりすぎると、デバッグ メッセージを出力します。このオプションを指定すると、ログの重大度が自動的に trace に設定されます。これには、トレースログ、デバッグログ、情報ログ、警告ログ、エラーログが含まれます。
--dir-mode VALUE ディレクトリの権限ビット(8 進数)。デフォルト値は 755 です。
--enable-nonexistent-type-cache Cloud Storage でファイルが見つからない場合、NonexistentType 型のキャッシュ エントリが作成されます。ファイルが Cloud Storage で作成されても、ファイルの NonexistentType エントリがキャッシュに保存されている場合、Cloud Storage FUSE は、NonexistentType エントリがタイプ キャッシュから削除されるまで、そのファイルをリクエストできません。
--experimental-enable-json-read 読み取りオペレーションに Cloud Storage JSON API を使用するように Cloud Storage FUSE を指定します。デフォルトでは、読み取りオペレーションは Cloud Storage XML API を使用して実行されます。
--experimental-opentelemetry-collector-address VALUE 指定したアドレスの OpenTelemetry Collector に指標をエクスポートします。試験運用中。
--file-mode VALUE ファイルの権限ビットを 8 進数で指定します。デフォルト値は 644 です。
--foreground フォアグラウンドで gcsfuse コマンドを実行します。
--gid VALUE すべての i ノードのグループ識別子(GID)オーナーを指定します。デフォルトの GID 値は -1 です。
--help または -h Cloud Storage FUSE に関するヘルプを表示します。
--http-client-timeout VALUE Cloud Storage FUSE HTTP クライアントがタイムアウトになる前にサーバーからのレスポンスを待つ時間を指定します。デフォルト値は 0s で、タイムアウトがないことを示します。
--implicit-dirs

フォルダマネージド フォルダが暗黙的に含まれています。

詳細については、GitHub のファイルとディレクトリのドキュメントをご覧ください。
--key-file VALUE Cloud Storage へのリクエストを認証するための認証情報 JSON キーファイルの絶対パスを指定します。デフォルトでは、Cloud Storage FUSE はアプリケーションのデフォルト認証情報を使用してリクエストを認証します。
--limit-bytes-per-sec VALUE Cloud Storage FUSE が Cloud Storage からデータを読み込むことができる帯域幅の上限を指定します。測定時間は 30 秒です。デフォルトの上限値は -1 で、この場合上限はありません。
--limit-ops-per-sec VALUE 30 秒間に測定される 1 秒あたりのオペレーションの上限を指定します。デフォルトの上限値は -1 で、この場合、上限はありません。
--log-file VALUE Fluentd で解析できるログを保存するためのファイルを指定します。指定しないと、Cloud Storage FUSE がフォアグラウンドで実行されている場合は stdout に書式なしテキストのログが出力されます。Cloud Storage FUSE がバックグラウンドで実行されている場合は syslog に出力されます。
--log-format VALUE ログファイルの形式を指定します。値は text または json のいずれかです。デフォルト値は json です。
--max-conns-per-host VALUE サーバーごとに許可される TCP 接続の最大数を指定します。これは、--client-protocolhttp1 に設定されている場合に有効になります。デフォルト値は 0 です。これは、マシンの仕様で設定された上限を除き、TCP 接続に上限が存在しないことを指定します。
--max-idle-conns-per-host VALUE サーバーごとに許可されるアイドル状態の接続の最大数を指定します。デフォルト値は 100 です。
--max-retry-sleep VALUE 指数バックオフを使用した再試行ループで Cloud Storage FUSE がスリープできる最大時間を指定します。バックオフ時間が指定の最大時間を超えると、指定された最大時間で再試行が続行されます。デフォルトの上限値は 30s(30 秒)です。
-o VALUE

追加のシステム固有のマウント オプションを指定します。

FUSE のほとんどの汎用マウント オプション(rwsuid など)は Cloud Storage FUSE でサポートされており、-o フラグとともに渡すことができます。詳細については、Linux FUSE のドキュメントをご覧ください。

-o ro バケットを読み取り専用としてマウントします。
--only-dir VALUE バケット内の特定のディレクトリのみをマウントします。
--rename-dir-limit VALUE 指定した上限よりも子孫の少ないディレクトリの名前を変更できます。デフォルトの上限値は 0 です。
--retry-multiplier VALUE 連続する 2 回の再試行までの待機時間を指定します。
--reuse-token-from-url これを含めると True と評価されます。これは、--token-url から取得したトークンを使用するよう指定します。除外した場合、False と評価されます。これは、--token-url から取得したトークンを再利用しないよう指定します。
--sequential-read-size-mb VALUE Cloud Storage からダウンロードするデータのチャンクサイズをメガバイト(MB)単位で指定します。
--stackdriver-export-interval VALUE 指定した間隔で指標を Stackdriver にエクスポートします。デフォルト値は 0s です。これはエクスポートを指定しません。
--stat-cache-capacity VALUE 非推奨。統計情報キャッシュが保持できるエントリ数を指定します。これはメモリ消費に影響します。デフォルト値は 4096 です。

このフラグの代わりに、構成ファイルmetadata-cache: stat-cache max-size フィールドを使用して、統計情報キャッシュの最大サイズを設定します。詳細については、Cloud Storage FUSE 構成ファイルをご覧ください。
--stat-cache-ttl VALUE 非推奨StatObject の結果と i ノード属性をキャッシュに保存する期間を指定します。デフォルト値は 60s です。

このフラグの代わりに、構成ファイルmetadata-cache: ttl-secs フィールドを使用して、統計情報キャッシュとタイプ キャッシュの両方のメタデータ エントリの有効期間(TTL)を指定します。詳細については、Cloud Storage FUSE 構成ファイルをご覧ください。
--type-cache-ttl VALUE 非推奨。ディレクトリの i ノード内の名前とファイルまたはディレクトリ間のマッピングをキャッシュに保存する期間を指定します。デフォルト値は 60s です。

代わりに、metadata-cache: ttl-secs フィールドを使用して、統計情報キャッシュとタイプ キャッシュの両方のメタデータ エントリの有効期間(TTL)を指定します。詳細については、Cloud Storage FUSE 構成ファイルをご覧ください。
--temp-dir value VALUE Cloud Storage にアップロードする前に書き込みがステージングされる一時ディレクトリのパスを指定します。デフォルト値はシステムのデフォルトです(多くの場合、/tmp)。
--token-url VALUE --key-file が存在しない場合にアクセス トークンを取得するための URL を指定します。
--uid VALUE すべての i ノードのユーザー識別子(UID)所有者を指定します。デフォルトの UID 値は -1 です。
--version または -v インストールした Cloud Storage FUSE のバージョンが表示されます。