クライアントバージョン

クライアントバージョンは、クライアントからのアクセスをどのステージ(Worker)に振り分けたらよいかを判断するための情報です。

クライアントバージョンの説明

MAGELLAN にアクセスするクライアントは、アクセス時の情報にアクセスしたいステージ用のクライアントバージョンを含めなければなりません。

tips用アイコン

MAGELLAN にアクセスする情報にクライアントバージョンを含めるには、MAGELLAN が提供するライブラリ(libmagellan や Client SDK)を使用することで簡単に実現できます。

libmagellan の使い方については、Getting Started を参照してください。 Client SDK の使い方については、Reference を参照してください。

クライアントバージョン規則

  • クライアントバージョンは、複数作成できます。

クライアントバージョン名規則

  • プロジェクト内でユニークでなければなりません。
  • 大文字小文字の区別はありません。
  • 使用可能な文字は、英数字(a-z, A-Z, 0-9)、ドット(.)、ハイフン(-)、アンダースコア(_)です。
  • 文字数は、63 文字以内です。

magellan-cli を使ったクライアントバージョンの操作

magellan-cli コマンドラインツールを使ってできるクライアントバージョンの操作は、magellan-cli client_version に集約されています。

どのような操作ができるかは、magellan-cli client_version help とすることで確認することができます。

$ magellan-cli client_version help
Commands:
  magellan-cli client_version list               # client_versions の一覧を表示します
  magellan-cli client_version show [ID]          # IDで指定されたclient_versionの詳細を表示します
  magellan-cli client_version select VERSION     # VERSIONを指定してclient_versionを選択します
  magellan-cli client_version deselect           # client_versionの選択を解除します
  magellan-cli client_version create VERSION     # VERSIONを指定してclient_versionを登録します
  magellan-cli client_version update ATTRIBUTES  # 選択したclient_versionの属性を指定したATTRIBUTESで更新します。ATTRIBUTESにはYAMLのファイル名かJSON文字列を指定可能です
  magellan-cli client_version delete VERSION     # VERSIONを指定してclient_versionを削除します
  magellan-cli client_version help [COMMAND]     # 利用可能なコマンドの一覧か特定のコマンドの説明を表示します

Options:
  -v, [--version], [--no-version]  # バージョンを表示します
  -V, [--verbose], [--no-verbose]  # 追加のログ情報を表示します
  -D, [--dryrun], [--no-dryrun]    # 登録や削除などのシステムには反映させずにアクションを実行します

以下では、クライアントバージョンの登録クライアントバージョンの一覧クライアントバージョンの選択およびクライアントバージョンの削除について、使い方を簡単に紹介します。詳しくは、Reference を参照してください。

クライアントバージョンの登録

クライアントバージョンを登録したいときは、magellan-cli client_version create コマンドを使います。

2.0 という名称のクライアントバージョンを登録したいときは、そのクライアントバージョンでのアクセス先となるステージを選択した状態で、次のように使います。

$ magellan-cli client_version create 2.0
$

実行後、何もメッセージが表示されなければ、クライアントバージョンの登録に成功しています。

クライアントバージョンの一覧

クライアントバージョンの一覧を確認したいときは、magellan-cli client_version list コマンドを使います。

$ magellan-cli client_version list
+---+-----+---------------+---------+------------------+--------+
|   | id  |     stage     | version | url_mapping_yaml | status |
+---+-----+---------------+---------+------------------+--------+
|   | 111 | [ProductA]V20 | 2.0     |                  | 1      |
|   | 110 | [ProductA]V10 | 1.0     |                  | 1      |
+---+-----+---------------+---------+------------------+--------+

Total: 2

行頭の欄は、選択状態を表します。選択されたクライアントバージョンには、* が表示されます。この例では、すべて空欄のため、選択されたクライアントバージョンが 1 つもないことを示しています。

次の例は、1.0 という名称のクライアントバージョンが選択されているときの表示です。

+---+-----+---------------+---------+------------------+--------+
|   | id  |     stage     | version | url_mapping_yaml | status |
+---+-----+---------------+---------+------------------+--------+
|   | 111 | [ProductA]V20 | 2.0     |                  | 1      |
| * | 110 | [ProductA]V10 | 1.0     |                  | 1      |
+---+-----+---------------+---------+------------------+--------+

Total: 2

クライアントバージョンの選択

クライアントバージョンを選択したいときは、magellan-cli client_version select コマンドを使います。

2.0 という名称のクライアントバージョンを選択したいときは、次のように使います。

$ magellan-cli client_version select 2.0

クライアントバージョンの削除

クライアントバージョンを削除したいときは、magellan-cli client_version delete コマンドを使います。

2.0 という名称のクライアントバージョンを削除したいときは、次のように使います。

$ magellan-cli client_version delete 2.0
OK