組織

組織(Organization)は、各種リソースの土台となる(グルーピングする)もので、プロジェクトとチームを管理します。

デプロイ環境全体図

企業で MAGELLAN を利用する場合は、企業単位で 1 つの組織を登録して運用することが考えられます。例えば、上図のように企業名(MyCompany)で組織を登録します。

個人で MAGELLAN を利用する場合は、個人単位で 1 つの組織を登録して運用することが考えられます。例えば、下図のようにニックネーム(MyNickName)で組織を登録します。

デプロイ環境個人利用例

組織規則

  • 組織は、複数登録できます。
  • 組織は、複数のプロジェクトを保有できます。
  • 組織は、複数のチームを保有できます。
  • 組織には、必ず「Owners」というチームが存在します。
    • Owners チームは、組織を作成すると自動で登録されます。
  • 組織は、アカウント登録時に、アカウント名で自動登録されます。

組織名規則

組織を登録するときに命名する組織名は、以下の点に気をつけてください。

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

magellan-cli を使った組織の操作

magellan-cli コマンドラインツールを使ってできる組織の操作は、magellan-cli organization に集約されています。

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

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

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

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

組織の登録

組織を登録したいときは、magellan-cli organization create コマンドを使います。例えば、MyCompany という名称の組織を登録したいときは、次のように使います。

$ magellan-cli organization create MyCompany
$

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

既に、指定した名称が使われていた場合は、Name has already been taken というメッセージが表示されます。この場合は、名称を変えて再度試してください。

$ magellan-cli organization create MyCompany
Name has already been taken

組織の一覧

組織の一覧を確認したいときは、magellan-cli organization list コマンドを使います。

$ magellan-cli organization list
+---+----+-----------+-------+------------+
|   | id |   name    | email | creator_id |
+---+----+-----------+-------+------------+
| * | 22 | MyCompany |       | 30         |
+---+----+-----------+-------+------------+

Total: 1

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

tips用アイコン

ここで表示される組織は、自身が所属している組織のみとなります。

組織の選択

組織を選択したいときは、magellan-cli organization select コマンドを使います。MyCompany という名称の組織を選択したいときは、次のように使います。

$ magellan-cli organization select MyCompany

組織の一覧」で述べたように、magellan-cli を使ったプロジェクトへの操作は、この選択された組織の中で作用します。

例えば、プロジェクトを作成するコマンド magellan-cli project create コマンドは、この選択された組織の中で作用します。

$ magellan-cli project create ProductA

この例では、ProductA という名称のプロジェクトを作成していますが、MyCompany という名称の組織に作られることになります。

組織の選択例 1

もし、別の組織に、ProductA を作りたければ、magellan-cli organization select コマンドを使って、希望する組織を選択してから、magellan-cli project create コマンドを使う必要があります。

$ magellan-cli organization select OtherCompany
$ magellan-cli project create ProductA

組織の選択例 2

組織の削除

組織を削除したいときは、magellan-cli organization delete コマンドを使います。例えば、MyCompany という名称の組織を削除したいときは、次のように使います。

$ magellan-cli organization delete MyCompany
OK

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

tips用アイコン

組織を削除すると、その組織に含まれるすべてのリソース(プロジェクトやステージなど)も削除されます。動作中の Worker も停止後に削除されます。