CLI クライアント(rc)

RustFS のコマンドラインクライアントをインストールし、クラスターへの接続と状態確認に使う方法を説明します。

rc は、S3 のオブジェクト操作と RustFS の管理に使うコマンドラインクライアントです。このガイドでは rc のインストール、クラスターエイリアスの設定、主な確認コマンドを説明します。ダウンロード例では v0.1.30 を使います。インストールの前に、RustFS CLI のリリースで、より新しいバージョンがないか確認します。

インストール

Linux

既定の Linux アーカイブは、広い互換性のために musl で静的リンクされています。uname -m と一致するタブを選びます。

x86_64 のホストの場合は次のとおりです。

curl -fLO https://github.com/rustfs/cli/releases/download/v0.1.30/rustfs-cli-linux-amd64-v0.1.30.tar.gz
tar -xzf rustfs-cli-linux-amd64-v0.1.30.tar.gz
sudo install -m 0755 rc /usr/local/bin/rc

環境が特に glibc リンクのバイナリを必要とする場合は、リリースページから linux-amd64-gnu または linux-arm64-gnu のアーカイブを選びます。

macOS

uname -m が返す値と一致するタブを選びます。

Intel(x86_64)の Mac の場合は次のとおりです。

curl -fLO https://github.com/rustfs/cli/releases/download/v0.1.30/rustfs-cli-macos-amd64-v0.1.30.tar.gz
tar -xzf rustfs-cli-macos-amd64-v0.1.30.tar.gz
sudo install -m 0755 rc /usr/local/bin/rc

Homebrew でパッケージをインストールすることもできます。

brew install rustfs/tap/rc

Windows

現在の Windows リリースが提供するのは AMD64 バイナリです。公式の Scoop バケットからインストールします。

scoop bucket add rustfs https://github.com/rustfs/scoop-bucket
scoop install rustfs/rc

インストールを確認する

新しいターミナルを開き、rc が使えることを確認します。

rc --version
rc --help

使い方

エイリアスを設定する

エイリアスには、RustFS のエンドポイントと認証情報を保存できます。コマンドごとに繰り返す必要はありません。実行前に認証情報を置き換えます。

rc alias set local http://localhost:9000 <your-access-key> <your-secret-key>
rc alias list

alias set は、同じ名前の既存エイリアスを置き換えます。alias list はシークレットキーを表示しません。

サービスの健全性を確認する

サービスが生存しているか、必要な依存関係が準備完了かを確認します。

rc ping local
rc ready local

クラスターを確認する

管理用のクラスター情報コマンドで、クラスターの状態、サーバー、ディスク、ストレージ容量を確認します。

rc admin info cluster local

デプロイが複数のプールを使う場合は、サーバープールを一覧します。

rc admin pool list local

管理コマンドには、対応する RustFS Admin API の権限を持つ認証情報が必要です。

バケットとオブジェクトを確認する

新しいスクリプトでは、名詞を先頭にしたコマンドグループを使うことを推奨します。

rc bucket list local/
rc object list local/my-bucket
rc object stat local/my-bucket/hello.txt

ライフサイクルルールとストレージ階層を管理する

rc は、ライフサイクルルール、リモートのストレージ階層、復元リクエストを bucket lifecycle にまとめています。

rc bucket lifecycle rule list local/my-bucket
rc bucket lifecycle tier list local
rc bucket lifecycle restore local/my-bucket/hello.txt --days 7

rule コマンドで、バケットのライフサイクルルールを追加、編集、削除、エクスポート、インポートします。tier コマンドで、リモート階層を追加、確認し、認証情報を更新し、削除します。古い rc ilm 形式は互換エイリアスとして残っています。新しいスクリプトでは rc bucket lifecycle を推奨します。

ルールと復元の手順はライフサイクル管理を、リモート階層の設定と保守は階層化ストレージを参照します。

ほかのコマンドを確認する

インストールしたバージョンがサポートするコマンドとオプションを見るには、どのコマンド階層でも --help を使います。

rc --help
rc alias --help
rc admin --help
rc admin info --help
rc bucket --help
rc bucket lifecycle --help
rc object --help

ソース一式とコマンドリファレンスは、RustFS CLI リポジトリを参照します。

On this page