Kapsule Orbit プロジェクト設定

Orbit プロジェクトのすべての設定はSettings タブにあり、一般情報、ビルドとデプロイ、セキュリティ、通知、統合、使用制限、デプロイ自動化、ネットワーク、監視性、共有、および下部の危険ゾーンにグループ化されています。

Settings の場所

Orbit を開き、プロジェクトをクリックして、プロジェクトタブストリップで Settings を選択します。このページではプロジェクト名、ビルドコマンド、Git 統合の設定について説明していますが、実際の機能はそれ以上です。

このガイドはマップです。独自の記事がある場合は、リンクされており繰り返されません。

一般

Project info には URL スラッグ、作成日、接続されたリポジトリ、本番 URL が表示され、プロジェクトの Name と Description を変更できます。

Git には Production branch があります。このブランチへのプッシュは本番デプロイをトリガーします。

Status badge は、ライブデプロイステータスの SVG に URL、markdown、HTML のコピーボタンを提供し、README に貼り付ける準備ができています。Orbit での README の表示 を参照してください。

Public status page はステータスページの設定にリンクします。Orbit Status Page を参照してください。

ビルドとデプロイ

Build settings は、Orbit が自動検出し上書きできる 5 つのフィールドです：インストールコマンド、ビルドコマンド、出力ディレクトリ、ルートディレクトリ、Node.js バージョン。フィールドを空白のままにすると、検出された値が保持されます。詳細は ビルドコマンドと出力ディレクトリの設定 を参照してください。

Runtime には理解する価値のある 4 つのスイッチがあります：

• Server mode は、各デプロイ後にスタートコマンドを実行するためにビルドマシンを生かし続けます。静的ファイルをエクスポートするのではなくサーバーでレンダリングするものに必須です。
• Branch previews は、本番またはステージングではないすべてのブランチプッシュの環境を自動的に作成し、各々は branch-*.kaps.run の下の独自の URL 上にあります。Branch Previews を参照してください。
• Auto-rollback on failure は、デプロイが失敗した場合、最後の正常な本番デプロイを復元します。
• Scheduled rebuild は、毎時から週単位で本番をリビルドします。これはコンテンツ管理サイトで git プッシュなしで更新が必要な場合に適しています。

Build auto-retry は、ネットワーク問題やタイムアウトなどのインフラストラクチャエラーで失敗したビルドを最大 3 回まで再度キューに入れます。コードエラーは再試行しないため、壊れたビルドをマスクすることはできません。

Ignored paths と Branch ignore patterns は不要なビルドを停止します：変更がデプロイすべきではないファイルのグロブパターン、および dependabot/* などのトリガーすべきではないブランチ。

Git tag deploys は、タグプッシュを本番デプロイに変える タグパターンを設定します。Orbit Releases を参照してください。

デプロイ自動化と保護

Deploy protection には 2 つのゲートがあります：Require approval for production はプッシュでトリガーされた本番デプロイを一時停止してから誰かが承認するまで待機し、Require staging success before production は本番をステージングが同じコミットを正常にデプロイするまで保持します。

CI required checks は独自の CI でデプロイをゲートします。GitHub ではジョブ名をリストし、すべてが成功する必要があります。GitLab では空でない値はパイプライン全体を待ちます。CI 障害はデプロイをキャンセルします。

Deploy freeze schedule は承認されたウィンドウ外でプッシュがトリガーされたデプロイをブロックします。週末または UTC 時間範囲です。手動デプロイとデプロイフックは影響を受けません。

Branch protection は、必須の外部チェックが成功し、オプションで人間が承認されるまで、一致するブランチ上のデプロイをブロックするグロブパターンルールを追加します。

Auto-promote staging は、設定された時間数ヘルス障害がなく、スモークテストが成功したら、ステージングを本番に自動的に昇格します。

これらすべては Orbit Deployment Pipeline タブの 1 つのビューにまとめられています。

ヘルスと品質ゲート

Health check は、各本番デプロイの後に選択したパスを取得します。15 秒以内の 2xx 以外の応答は、前の正常なデプロイを復元します。

Smoke tests は、各デプロイ成功後に最大 10 個のコンマ区切りパスに対して GET リクエストを実行し、成功または失敗を記録します。auto-rollback と組み合わせると、失敗したスモークテストはデプロイをロールバックします。

Performance budgets は、しきい値を超えるビルドに警告するか失敗させます：MB 単位の総アーティファクトサイズ、グロブで一致する kB 単位の個別ファイルサイズ、または秒単位のビルド時間。各予算は警告またはビルド失敗のいずれかに設定されます。

ステージング

ステージングは独自のカードセット取得します：staging branch、パスワード付きの access protection、IPv4 アドレスと CIDR 範囲を 1 行に 1 つずつ受け入れる IP allowlist、失敗時の auto-rollback on failure、ステージングが本番環境変数を lower priority で継承するかどうか、およびインストール、ビルド、出力、ルートディレクトリの build overrides。

パスワードと IP allowlist は、公開されることを意図していないステージング環境に設定する 2 つのものです。両方を空白のままにすると、ステージング URL は誰でもアクセスできます。

ネットワーク

Custom domains は本番環境のドメインを追加して検証し、証明書プロビジョニングを含みます。Adding a Custom Domain to Orbit を参照してください。

Redirects and rewrites はサービスの前に適用されるパスベースのルールで、順番に試され、最初のマッチが優先されます。リダイレクトはブラウザを 301 または 302 で新しい URL に送ります。リダイレクト書き換えは異なるパスを URL 変更なしで静かにサービスします。パターンは完全一致、ワイルドカード、名前付きパラメータとスプラットをサポートします。Orbit のリダイレクトと書き換え を参照してください。

Response headers は一致するパスにカスタム HTTP ヘッダーを適用します。HSTS、CSP、no-embed、no-sniff、referrer ポリシー、CORS のプリセットが付いています。マッチングルールはすべて適用され、同じキーの場合は後のエントリが前のエントリを上書きします。

Skew protection は、新しいデプロイがライブになった後、保持ウィンドウストレージに古いビルドアーティファクトを保持するため、前のバージョンを読み込んだ訪問者は 404 を取得するのではなく、そのアセットをフェッチできます。

The config store はデプロイがランタイムで読み取る キー/値設定を保持し、機能フラグと再デプロイなしで変更される設定に使用されます。これはここではなくStorage で管理され、無料です：読み取り料金も書き込み料金もありません。値は平文で保存されるため、シークレットを入れないでください。プロジェクトあたり最大 100 エントリ、キーは最大 200 文字、値は最大 4096 です。毎晩すべてのエントリのスナップショットを取得し、すべてのプランで 30 晩保持するため、削除したエントリを戻すことができます：Snapshots and restore を参照してください。

使用と制限

Build usage はこのプロジェクトが実行したビルドを表示します。

Spending cap は最大月額超過支出を設定し、プラン割り当てを超えるビルド分とバンド幅超過をカバーします。最小値は US$6.32 で、最大値は US$6,315.79 です。アラートは 50% と 80% で発火し、100% でサービスはキャップを上げるまで一時停止します。Orbit Spending Cap を参照してください。

Build spending cap は個別のより粗いリミット：月間総ビルド分の上限で、この後新しいビルドはキューに入らなくなり、次の月またはキャップを上げるまで続きます。

Artifact retention は環境ごとに保持する成功したビルドアーティファクトの数を設定します。古いものは毎日削除され、現在のライブデプロイは制限に関係なく常に保持されます。

Preview expiry は 7、14、30、60 日後、またはプレビュー環境を一時停止します。一時停止されたプレビューのストレージは 24 時間以内に回収されます。

Artifact size alert はビルドアーティファクトが設定したサイズを超えたときにメールを送信します。

通知、統合、および監視性

Deploy email notifications には 3 つの設定があります：すべてのデプロイ、失敗のみ、またはオフ。notification webhook URL を一緒に設定できます。各成功または失敗で投稿します。

Notification channels はより豊かなバージョンで、イベント単位の選択、配信履歴、テストボタンが付いています。完全な webhook 制御は独自のタブにあります：Orbit Webhooks を参照してください。

Deploy hooks は、何かがそれに POST したときにデプロイをトリガーするシークレット URL を作成します。Triggering Deployments Via Deploy Hooks を参照してください。

Log drains は各デプロイの後、ビルドログを監視性プラットフォームに送ります。Datadog、Logtail、Axiom、New Relic、またはカスタム webhook の組み込みサポートがあり、オプションで 1 つの環境にフィルタリングされます。

Web Analytics は Core Web Vitals 収集スニペットを提供します。Orbit Web Vitals を参照してください。

Cron triggers は選択した環境への HTTP リクエストをスケジュールし、プロジェクトあたり最大 10 個です。より大きい本番のみバージョンは独自のタブにあります：Orbit Cron Jobs を参照してください。

共有とチーム

Team は 3 つのロールで協力者を管理します：admin、developer、viewer。

Share links は、外部レビューアが パスワードまたはアカウントなしで環境を表示できるように、一時的なパスワードレスリンクを生成します。各リンクは 1 時間、24 時間、7 日で期限切れに、または決して期限切れにしないことができ、訪問数を表示します。いつでも 1 つを取り消します。

Deployment group はこのプロジェクトをグループに参加させるため、関連プロジェクトは一緒にデプロイし、オプションでブランチでフィルタリングされます。

Clone environment と Clone project は設定を複製します。プロジェクトのクローンはビルド設定、環境設定、非シークレット環境変数をコピーします。シークレットはコピーされません。

危険ゾーン

Clear build cache はすべての環境でキャッシュされた依存関係を削除するため、次のデプロイはスクラッチから完全インストールを実行します。元に戻すことはできませんが、キャッシュは次のビルドで自身をリビルドします。

Transfer project はプロジェクトを別の Kapsule アカウントに移動します。Transferring an Orbit Project を参照してください。

Archive project は直ちにトラフィックの提供を停止します。Orbit リストから 30 日以内に復元可能で、その後は完全に削除されます。

次にどこへ行くか

• Orbit Deployment Pipeline はすべての設定の効果を 1 つのビューで確認します。
• Shared Environment Variable Groups プロジェクト全体で使用される値。
• Orbit Plan Limits プランの許容内容。