最初の module をデプロイする

dashboard の /new から、Git の module を plan → apply します。API で同じ流れを 実行したい場合は Git module を始める を 見てください。

1. /new を開く

標準の入口は dashboard の /new です。Git URL を入れると module を読み、必要な 変数と provider を提示します。

外部のアプリからこの画面へ利用者を送ることもできます。

https://takosumi.example.com/install?git=https://github.com/example/app.git&ref=v1.2.0&path=deploy/opentofu

/install は /new の入力欄を埋めるだけです。リンクを開いた時点では何も 作られません。 利用者は内容を見てから自分で承認します。

2. 接続と変数を確認する

module を読むと、使う provider と必要な変数が提示されます。認証情報が必要なら Connection を割り当てます。

3. plan を確認する

計画の内容、つまり「何が変わるか」を確認します。この時点では何も反映されません。

4. apply する

承認して適用します。state・output・監査記録が保存されます。

アプリやサービスに連携ボタンを付ける

自分のアプリに「このサービスを追加」ボタンを置きたい場合、ボタンから /install リンクを開かせます。リンクには Git URL、ref、module path を入れ、 product と return_uri を付けると、完了後にアプリへ戻れます。

https://takosumi.example.com/install
  ?git=https%3A%2F%2Fgit.example.com%2Facme%2Fnotes.git
  &ref=v1.2.3
  &path=deploy%2Fopentofu
  &product=notes-app
  &return_uri=notesapp%3A%2F%2Fconnect

利用者が画面で追加を完了すると、Takosumi は return_uri に作成した host の URL と run_id を付けてアプリへ戻します。組み立ての詳細は App Handoff にあります。

Store に module を並べて、利用者が一覧から選んで追加できるようにもできます (Store API)。

次に読む

• Git module を始める
• App Handoff — /install リンクの組み立て