プロジェクト

プロジェクト(Project)は、ステージ(Stage)を管理します。

デプロイ環境

典型的な利用例としては、開発する製品(サービス)の種類ごとに、プロジェクトを登録します。さらに、同一製品のバージョンごとに、プロジェクトを分ける方法もありますが、後述するステージを活用することで、別バージョンも一つのプロジェクトで管理することができます。

プロジェクト規則

  • プロジェクトは、複数登録できます。
  • プロジェクトは、複数のステージを保有できます。
  • プロジェクトは、アカウント登録時に自動登録されます。
    • 登録先の組織は、アカウント登録時に自動登録された組織です。
    • プロジェクト名は、DefaultProject1 です。
  • プロジェクトは、組織数が 0 がのときに、アカウント名と同名の組織を登録すると、プロジェクト名 DefaultProject1 で自動登録されます。

tips用アイコン

Trial プラン制限事項

制限事項 制限内容
登録できるプロジェクト数 1

プロジェクト名規則

  • 組織内でユニークでなければなりません。
  • 大文字小文字の区別はありません。
  • 使用可能な文字は、英数字(a-z, A-Z, 0-9)です。
    • ただし、先頭に使用できる文字は、英字(a-z, A-Z)のみです。
  • 文字数は、63 文字以内です。

magellan-cli を使ったプロジェクト操作

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

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

$ magellan-cli project help
Commands:
  magellan-cli project list               # projects の一覧を表示します
  magellan-cli project show [ID]          # IDで指定されたprojectの詳細を表示します
  magellan-cli project select NAME        # NAMEを指定してprojectを選択します
  magellan-cli project deselect           # projectの選択を解除します
  magellan-cli project delete NAME        # NAMEを指定してprojectを削除します
  magellan-cli project update ATTRIBUTES  # 選択したprojectの属性を指定したATTRIBUTESで更新します
  magellan-cli project create NAME        # NAMEを指定してprojectを登録します
  magellan-cli project help [COMMAND]     # 利用可能なコマンドの一覧か特定のコマンドの説明を表示します

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

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

プロジェクトの登録

プロジェクトを登録したいときは、magellan-cli project create コマンドを使います。例えば、ProductA という名称のプロジェクトを登録したいときは、次のように使います。

$ magellan-cli project create ProductA

実行後、何もメッセージが表示されなければ、プロジェクトの登録に成功しています。

プロジェクトの一覧

プロジェクトの一覧を確認したいときは、magellan-cli project list コマンドを使います。

$ magellan-cli project list
+---+----+--------------+----------+----------+--------------------+----------------------------------+
|   | id | organization |   name   | icon_url |    consumer_key    |         consumer_secret          |
+---+----+--------------+----------+----------+--------------------+----------------------------------+
| * | 12 | MyCompany    | ProductA |          | MyCompany.ProductA | ******************************** |
+---+----+--------------+----------+----------+--------------------+----------------------------------+

Total: 1

行頭についている * は、その行が示すプロジェクトが選択状態であることを表します。この例では、ProductA というプロジェクトが選択されていることを表します。magellan-cli を使ったステージやクライアントバージョンへの操作は、この選択されたプロジェクトの中で作用します。詳しくは、「プロジェクトの選択」を参照してください。

コンシューマ・キー(consumer_key)とコンシューマ・シークレット(consumer_secret)は、このプロジェクト(上で動く Worker)にアクセスするクライアントプログラムが認証を受ける際に必要となる情報です。外部に漏れることのないように注意してください。

tips用アイコン

ここで表示されるプロジェクトは、選択している組織内のプロジェクトとなります。

プロジェクトの選択

プロジェクトを選択したいときは、magellan-cli project select コマンドを使います。ProductA という名称のプロジェクトを選択したいときは、次のように使います。

$ magellan-cli project select ProductA

プロジェクトの一覧」で述べたように、magellan-cli を使ったステージやクライアントバージョンへの操作は、この選択されたプロジェクトの中で作用します。

例えば、ステージを登録するコマンド magellan-cli stage create コマンドは、この選択されたプロジェクトの中で作用します。

$ magellan-cli stage create V10

この例では、V10 という名称のステージを登録していますが、ProductA という名称のプロジェクトに登録されます。

プロジェクトの選択例 1

もし、別のプロジェクトに、V10 を作りたければ、magellan-cli project select コマンドを使って、希望するプロジェクトを選択してから、magellan-cli stage create コマンドを使う必要があります。

$ magellan-cli project select ProductB
$ magellan-cli stage create V10

プロジェクトの選択例 2

プロジェクトの削除

プロジェクトを削除したいときは、magellan-cli project delete コマンドを使います。例えば、ProductA という名称のプロジェクトを削除したいときは、次のように使います。

$ magellan-cli project delete ProductA
OK

組織の削除に成功した場合は、OK のメッセージが表示されます。

tips用アイコン

プロジェクトを削除すると、そのプロジェクトに含まれるすべてのリソース(ステージ、クライアントバージョンおよび Worker)も削除されます。動作中の Worker も停止後に削除されます。