Railway

RailwayはOAuthで接続します。Continue to Railwayをクリックし、Railwayで読み取りアクセスを認可すると、同期が始まった状態でリダイレクトされて戻ります。トークンは保存前に暗号化され、エージェントが目にすることはありません。

Polylaneはプロジェクト、環境、サービス、デプロイメント、ボリューム、ドメイン、TCPプロキシを検出します。サービスのメトリクスはチャートと異常検出に使われます。変数名はクラウドをまたぐリンクのために同期されます。変数の値が読み取られることはありません。一時的な（プルリクエストの）環境はスキップされます。

デプロイとアラートのWebhook

Railwayは通知ルールを通じてデプロイメントの状態変化と使用量アラートを送信します。通知ルールをPolylaneに向けると、失敗またはクラッシュしたデプロイでアラートが上がり、次の成功したデプロイでそのアラートが解決し、再同期がスケジュールされます。

1. PolylaneのクラウドアカウントのSettingsページからWebhook URLをコピーします（RailwayのワークスペースIDで終わります）。
2. Railwayで、ワークスペースのNotifications設定を開き、そのURLを指すWebhookルールを追加します。
3. 必要なDeploymentイベントを選びます。Deployment.deployed、Deployment.failed、Deployment.crashed、Deployment.oom_killedがアラートのフローを網羅します（Railwayの成功イベントはDeployment.deployedです。Deployment.successはありません）。
4. VolumeAlert.resolvedとMonitor.resolvedを含むVolumeAlertとMonitorイベントを追加すると、ボリュームとモニターのアラートがPolylaneで自動的に開閉されます。

トラブルシューティング

認可が失敗する、またはキャンセルされる

• ワークスペースにアクセスできるアカウントでRailwayにサインインしていることを確認してください。
• Continue to Railwayからやり直してください。認可リンクは数分間しか有効ではありません。

リソースが見つからない

• Railwayがすべてを同期するには数分かかることがあります。
• 一時的な（プルリクエストの）環境は同期されません。
• アカウントヘッダーから手動のSyncを実行して更新してください。

接続解除

Polylaneでアカウントを接続解除し、次にRailwayのアカウント設定でOAuthの許可を取り消し、通知ルールを作成していた場合はそれも削除します。

Railwayの接続にブラウザーは必要ありません。コンソールが呼び出すのと同じエンドポイントがCIジョブに収まります。認証済みのPOSTを1回行うと、接続が作成され、最初の同期が始まります。

前提条件

• cloud_accounts:writeとcloud_accounts:readスコープを持つPolylane APIキー。APIキーとOAuthを参照してください。
• ws_で始まるワークスペースID。同じキーでGET /v1/workspacesから読み取ります。
• ワークスペース設定から取得したRailwayのワークスペーストークン。コンソールのOAuthフローにはブラウザーが必要ですが、ワークスペーストークンには不要です。

接続を作成する

curl -X POST https://api.polylane.com/v1/cloud_accounts \
  -H "x-api-key: $POLYLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "railway",
    "workspaceId": "ws_0abc123",
    "token": "<railway-workspace-token>"
  }'

1回の呼び出しで、トークンが到達できるすべてのRailwayワークスペースが接続されます。1つだけを接続するには、任意のrailwayWorkspaceIdを渡します。

応答は接続されたものを一覧し、最初の同期はすでに実行中です。フローの残りが読む2つのフィールドに絞ると次のとおりです。

{
  "success": true,
  "result": {
    "provider": "railway",
    "accounts": [{ "id": "acc_34gky74ibc92h8t2efn8csrh", "status": "syncing" }],
    "failures": []
  }
}

すでに接続されているアカウントはaccountsではなくfailuresに入るため、呼び出しを繰り返しても接続が重複することはありません。

最初の同期を待つ

返された各アカウントをidでポーリングし、statusがreadyになるまで待ちます（登録時はnew、リソースが流れ込んでいる間はsyncingです）。

until [ "$(curl -s "https://api.polylane.com/v1/cloud_accounts/$WORKSPACE_ID/$ACCOUNT_ID" \
  -H "x-api-key: $POLYLANE_API_KEY" | jq -r '.result.status')" = "ready" ]; do
  sleep 15
done

失敗した接続がジョブを止めたままにするのではなく失敗させるように、ループに期限を設けてください。アカウントがreadyになると、そのリソースはトポロジーにあり、Polylaneは最初のチェックを開始しています。

APIから接続解除する

接続を削除すると、すべての同期とチェックが停止し、Polylaneが保持していた認証情報が削除されます。この呼び出しにはcloud_accounts:deleteスコープが必要です。

curl -X DELETE "https://api.polylane.com/v1/cloud_accounts/$WORKSPACE_ID/$ACCOUNT_ID" \
  -H "x-api-key: $POLYLANE_API_KEY"

次に、下のDisconnectで説明されているとおり、プロバイダー側でRailwayの認証情報を取り消します。