転送エージェントのコマンドライン オプション

転送エージェントは、ファイル システムから Google Cloud にデータを転送します。このページで説明するフラグとオプションを使用して、エージェントの実行時にエージェント オプションを制御できます。

コマンドの概要

sudo docker run [--ulimit memlock=64000000 -d --rm -v host-directory:container-directory]
--env environment-variable=variable-value
gcr.io/cloud-ingest/tsop-agent:latest
{--help | --version | --project-id=project-id}
[--agent-id-prefix=id-prefix --creds-file=credential-file
--enable_mount_directory --hostname=hostname
--log-dir=logs-directory
--max-physical-mem=maximum-memory]

Docker のオプション

--ulimit memlock=64000000

Docker の共有プールの共有メモリをロックしてメモリに常駐させることにより、複数のセッションからアクセスできるようにします。

-d

Docker コンテナを切断モードで起動するか、バックグラウンドで起動します。これにより、引き続き Linux ターミナルからコマンドを発行できます。

詳細については、Detached -d をご覧ください。

--rm

Docker の終了時にコンテナとそのファイル システムを削除します。

詳細については、Clean up (--rm) をご覧ください。

-v host-directory:container-directory

ホストからコンテナにマッピングする 1 つ以上のボリュームを指定します。-v を使用する場合は、host-directory と container-directory を同一にする必要があります。そうしないと、Storage Transfer Service は転送するファイルを見つけることができません。

詳細については、VOLUME [共有ファイルシステム] をご覧ください。

--env environment-variable=variable-value

Docker コンテナの環境変数を指定します。転送プロキシを使用するようにエージェントを構成するには、このフラグを使用します。詳細については、転送プロキシの使用をご覧ください。

エージェントのオプション

--agent-id-prefix=id-prefix

エージェント ID の先頭に追加されるオプションの接頭辞で、Google Cloud Console でエージェントやそのマシンを識別するために使用します。接頭辞を使用する場合、エージェント ID は prefix + hostname + Docker container ID の形式になります。

--creds-file=credential-file

オプションの JSON 形式のサービス アカウント認証情報ファイル。サービス アカウントの認証情報ファイルを生成する方法については、サービス アカウント キーの作成と管理をご覧ください。

注: --enable_mount_directory を使用している場合を除き、このパスに接頭辞 /transfer_root を付ける必要があります。例: /transfer_root/path/to/cred_file.json。

--enable_mount_directory

必要に応じて、個々の Docker-v ボリューム マウントを指定する代わりに、Docker コンテナ内のディレクトリ /transfer_root の下にファイル システム全体をマウントします。このフラグを使用する場合は、ログ ディレクトリやサービス アカウント認証情報ファイルのパスに接頭辞の /transfer_root を付ける必要はありません。/transfer_root は、転送ログや GUI エラーサンプルでは表示されません。

--help

使い方の簡単な説明が表示されます。

--hostname=hostname

エージェントが動作しているホスト名を設定します。特定のエージェントが動作しているマシンのホスト名の報告に使用されます。

注: このフラグを使用する場合は --hostname=$(hostname) を渡すことをおすすめします。

--log-dir=logs-directory

エージェントがログを書き込むオプションのディレクトリ。デフォルトのディレクトリは /tmp/ です。

注: --enable_mount_directory を使用している場合を除き、このパスに接頭辞 /transfer_root を付ける必要があります。例: /transfer/root/path/to/log_file。

--max-physical-mem=maximum-memory

エージェントは、デフォルトで最大 8 GiB のシステムメモリを使用します。このデフォルトが環境に合わない場合は、適切な最大メモリ使用量を次の形式で指定できます。

max-physical-mem 値	最大メモリ設定
6g	6 GB
6gb	6 GB
6GiB	6 GiB

--project-id=project-id

作成および請求される転送リソースをホストするプロジェクト ID の必須文字列。

--version

エージェントの現行バージョンを表示します。