<h2 id="%E3%81%BE%E3%81%A8%E3%82%81" data-line="0" class="code-line">
<a class="header-anchor-link" href="#%E3%81%BE%E3%81%A8%E3%82%81" aria-hidden="true"></a> まとめ</h2>
<ul data-line="1" class="code-line">
<li data-line="1" class="code-line">PipeCDのpipedをサクッと動かしたいユーザ向けに、App Runner上でpipedを動かすサンプルをTerraformで作りました。（<em>PipeCD公式ではないです</em>）</li>
</ul>
<p data-line="3" class="code-line"><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__fadb376846803" src="https://embed.zenn.studio/card#zenn-embedded__fadb376846803" data-content="https%3A%2F%2Fgithub.com%2Ft-kikuc%2Fpipecd-iac%2Ftree%2Fmain%2Fpiped-on-apprunner" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://github.com/t-kikuc/pipecd-iac/tree/main/piped-on-apprunner" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://github.com/t-kikuc/pipecd-iac/tree/main/piped-on-apprunner</a></p>
<ul data-line="5" class="code-line">
<li data-line="5" class="code-line">
<p data-line="5" class="code-line">App Runnerでpipedを動かせるようにするために、PipeCDに少し機能追加しました。</p>
</li>
<li data-line="7" class="code-line">
<p data-line="7" class="code-line">注: App Runnerの本来の使い方ではないと思います。</p>
</li>
</ul>
<h2 id="pipecd%E3%81%AE%E5%89%8D%E6%8F%90%E7%9F%A5%E8%AD%98(%E3%81%96%E3%81%A3%E3%81%8F%E3%82%8A)" data-line="9" class="code-line">
<a class="header-anchor-link" href="#pipecd%E3%81%AE%E5%89%8D%E6%8F%90%E7%9F%A5%E8%AD%98(%E3%81%96%E3%81%A3%E3%81%8F%E3%82%8A)" aria-hidden="true"></a> PipeCDの前提知識(ざっくり)</h2>
<h3 id="pipecd%E3%81%A8%E3%81%AF" data-line="11" class="code-line">
<a class="header-anchor-link" href="#pipecd%E3%81%A8%E3%81%AF" aria-hidden="true"></a> PipeCDとは</h3>
<ul data-line="13" class="code-line">
<li data-line="13" class="code-line">
<p data-line="13" class="code-line">OSSのGitOpsツール</p>
</li>
<li data-line="15" class="code-line">
<p data-line="15" class="code-line">現時点でKubernetes/Cloud Run/ECS/Lambda/Terraformへのデプロイが可能</p>
</li>
</ul>
<p data-line="17" class="code-line"><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__d99a2638ec83c" src="https://embed.zenn.studio/card#zenn-embedded__d99a2638ec83c" data-content="https%3A%2F%2Fpipecd.dev%2F" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://pipecd.dev/" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://pipecd.dev/</a></p>
<h3 id="%E5%A4%A7%E3%81%BE%E3%81%8B%E3%81%AA%E3%82%A2%E3%83%BC%E3%82%AD%E3%83%86%E3%82%AF%E3%83%81%E3%83%A3" data-line="19" class="code-line">
<a class="header-anchor-link" href="#%E5%A4%A7%E3%81%BE%E3%81%8B%E3%81%AA%E3%82%A2%E3%83%BC%E3%82%AD%E3%83%86%E3%82%AF%E3%83%81%E3%83%A3" aria-hidden="true"></a> 大まかなアーキテクチャ</h3>
<p data-line="21" class="code-line"><a href="https://pipecd.dev/docs/concepts/" target="_blank" rel="nofollow noopener noreferrer">Concepts | PipeCD</a></p>
<p data-line="23" class="code-line"><img src="https://res.cloudinary.com/zenn/image/fetch/s--sZVGSJqu--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/b13b5224e0d2f8e877d00a67.png%3Fsha%3Da941eac3095423629bd26a869e1782f559294ade" alt="PipeCD's architecture overview" loading="lazy" class="md-img"></p>
<ul data-line="25" class="code-line">
<li data-line="25" class="code-line">
<p data-line="25" class="code-line">piped</p>
<ul data-line="26" class="code-line">
<li data-line="26" class="code-line">Gitリポジトリを継続監視して、変更があれば資産をデプロイするコンポネント</li>
<li data-line="27" class="code-line">piped自体の設定値は、起動時に指定が必要</li>
<li data-line="28" class="code-line">例： どのGitリポジトリを監視するか？</li>
</ul>
</li>
<li data-line="30" class="code-line">
<p data-line="30" class="code-line">Control Plane</p>
<ul data-line="31" class="code-line">
<li data-line="31" class="code-line">pipedから送られてくるデプロイ状況などを管理するコンポネント</li>
<li data-line="32" class="code-line">UIも提供</li>
<li data-line="33" class="code-line">本記事ではほとんど関係ありません。</li>
</ul>
</li>
</ul>
<h2 id="%E8%83%8C%E6%99%AF" data-line="35" class="code-line">
<a class="header-anchor-link" href="#%E8%83%8C%E6%99%AF" aria-hidden="true"></a> 背景</h2>
<ul data-line="37" class="code-line">
<li data-line="37" class="code-line">サーバレスワークロードのユーザにとって、pipedを管理するためだけにECSを構築・管理するのはtoo much
<ul data-line="38" class="code-line">
<li data-line="38" class="code-line">特にVPC、セキュリティグループ、タスク定義あたり</li>
</ul>
</li>
<li data-line="39" class="code-line">-&gt; サーバレスアプリと同様にpipedもサーバレスでサクッと動かしたい！</li>
<li data-line="40" class="code-line">-&gt; しかしpipedは常駐稼働が必要((piped自体はステートレスであることもあり、絶対に落ちてはいけないということではないです))であるため、Lambdaでは動かせない</li>
<li data-line="41" class="code-line">-&gt; App Runnerで動かせたら楽では？？</li>
</ul>
<h2 id="%E6%A7%8B%E6%88%90" data-line="43" class="code-line">
<a class="header-anchor-link" href="#%E6%A7%8B%E6%88%90" aria-hidden="true"></a> 構成</h2>
<ul data-line="45" class="code-line">
<li data-line="45" class="code-line">下記の構成にしました。</li>
</ul>
<p data-line="47" class="code-line"><img src="https://res.cloudinary.com/zenn/image/fetch/s--LdGgQa7q--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/34cf95ab752fcd1ab381a034.png%3Fsha%3D1df84ca55d33f6146380861afb420e78c756a899" loading="lazy" class="md-img"></p>
<ul data-line="49" class="code-line">
<li data-line="49" class="code-line">下記のREADMEに構築手順を記載しています。Terraformです。</li>
</ul>
<p data-line="51" class="code-line"><span class="embed-block zenn-embedded zenn-embedded-github"><iframe id="zenn-embedded__1787b4698d695" src="https://embed.zenn.studio/github#zenn-embedded__1787b4698d695" data-content="https%3A%2F%2Fgithub.com%2Ft-kikuc%2Fpipecd-iac%2Fblob%2Fmain%2Fpiped-on-apprunner%2FREADME.md" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://github.com/t-kikuc/pipecd-iac/blob/main/piped-on-apprunner/README.md" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://github.com/t-kikuc/pipecd-iac/blob/main/piped-on-apprunner/README.md</a></p>
<ul data-line="53" class="code-line">
<li data-line="53" class="code-line">※ 上記サンプルではイメージは<code>piped</code>ではなく<code>launcher</code>を使用していますが、本記事ではあまり重要な違いではないです。
<ul data-line="54" class="code-line">
<li data-line="54" class="code-line">
<code>launcher</code>を使うと、PipeCDのWeb Consoleからpipedのバージョン更新が可能になります。参照: <a href="https://pipecd.dev/docs/user-guide/managing-piped/remote-upgrade-remote-config/" target="_blank" rel="nofollow noopener noreferrer">https://pipecd.dev/docs/user-guide/managing-piped/remote-upgrade-remote-config/</a>
</li>
</ul>
</li>
</ul>
<h2 id="%E4%B8%BB%E3%81%AA%E8%A8%AD%E5%AE%9A%E5%80%A4" data-line="56" class="code-line">
<a class="header-anchor-link" href="#%E4%B8%BB%E3%81%AA%E8%A8%AD%E5%AE%9A%E5%80%A4" aria-hidden="true"></a> 主な設定値</h2>
<p data-line="58" class="code-line">注：　本記事で触れるApp Runnerの仕様は今後変更される可能性があります。</p>
<h3 id="%E3%83%98%E3%83%AB%E3%82%B9%E3%83%81%E3%82%A7%E3%83%83%E3%82%AF" data-line="60" class="code-line">
<a class="header-anchor-link" href="#%E3%83%98%E3%83%AB%E3%82%B9%E3%83%81%E3%82%A7%E3%83%83%E3%82%AF" aria-hidden="true"></a> ヘルスチェック</h3>
<ul data-line="62" class="code-line">
<li data-line="62" class="code-line">pipedはHTTPのヘルスチェック用エンドポイントを公開しているので、そのポート・パスを利用しています。</li>
</ul>
<p data-line="64" class="code-line"><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__cf86e003362ab" src="https://embed.zenn.studio/card#zenn-embedded__cf86e003362ab" data-content="https%3A%2F%2Fpipecd.dev%2Fdocs-v0.49.x%2Fuser-guide%2Fmetrics%2F%23health-checking" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://pipecd.dev/docs-v0.49.x/user-guide/metrics/#health-checking" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://pipecd.dev/docs-v0.49.x/user-guide/metrics/#health-checking</a></p>
<ul data-line="66" class="code-line">
<li data-line="66" class="code-line">下記に比べると凡庸なやり方です。</li>
</ul>
<p data-line="68" class="code-line"><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__374d53de98d7" src="https://embed.zenn.studio/card#zenn-embedded__374d53de98d7" data-content="https%3A%2F%2Fspeakerdeck.com%2Fgotok365%2Frun-non-apps-with-app-runner" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://speakerdeck.com/gotok365/run-non-apps-with-app-runner" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://speakerdeck.com/gotok365/run-non-apps-with-app-runner</a></p>
<h3 id="auto-scaling-configuration" data-line="70" class="code-line">
<a class="header-anchor-link" href="#auto-scaling-configuration" aria-hidden="true"></a> Auto Scaling Configuration</h3>
<ul data-line="71" class="code-line">
<li data-line="71" class="code-line">min=1,max=1に指定しています。
<ul data-line="72" class="code-line">
<li data-line="72" class="code-line">pipedは1台で十分であり、スケールインもスケールアウトもしてほしくないため。</li>
</ul>
</li>
</ul>
<h3 id="%E3%83%8D%E3%83%83%E3%83%88%E3%83%AF%E3%83%BC%E3%82%AF" data-line="74" class="code-line">
<a class="header-anchor-link" href="#%E3%83%8D%E3%83%83%E3%83%88%E3%83%AF%E3%83%BC%E3%82%AF" aria-hidden="true"></a> ネットワーク</h3>
<p data-line="75" class="code-line">Inbound:</p>
<ul data-line="76" class="code-line">
<li data-line="76" class="code-line">pipedはinbound通信不要なので、VPCエンドポイントすら指定しないプライベートにしています。</li>
<li data-line="77" class="code-line">AWSコンソールからだとVPCエンドポイントの指定が必須のようでしたが、Terraformからは未指定で構築できました。</li>
<li data-line="78" class="code-line">ヘルスチェックはApp Runnerサービス内で行われるので、問題なく通ります。</li>
</ul>
<p data-line="80" class="code-line">Outbound:</p>
<ul data-line="81" class="code-line">
<li data-line="81" class="code-line">pipedからPipeCDのControl PlaneやGitリポジトリへのアクセスが必要なので、Public Accessを許可しています。</li>
</ul>
<h3 id="%E9%96%8B%E5%A7%8B%E3%82%B3%E3%83%9E%E3%83%B3%E3%83%89(startcommand)" data-line="83" class="code-line">
<a class="header-anchor-link" href="#%E9%96%8B%E5%A7%8B%E3%82%B3%E3%83%9E%E3%83%B3%E3%83%89(startcommand)" aria-hidden="true"></a> 開始コマンド(StartCommand)</h3>
<ul data-line="85" class="code-line">
<li data-line="85" class="code-line">pipedの起動オプションで、Secrets Managerからpipedのconfigを取得するようにしています。
<ul data-line="86" class="code-line">
<li data-line="86" class="code-line">一番苦労した点です。次の節参照。</li>
</ul>
</li>
</ul>
<h2 id="%E5%AE%9F%E7%8F%BE%E3%81%AB%E3%81%82%E3%81%9F%E3%81%A3%E3%81%A6%E5%BF%85%E8%A6%81%E3%81%A8%E3%81%AA%E3%81%A3%E3%81%9F%E8%BF%BD%E5%8A%A0%E6%A9%9F%E8%83%BD" data-line="88" class="code-line">
<a class="header-anchor-link" href="#%E5%AE%9F%E7%8F%BE%E3%81%AB%E3%81%82%E3%81%9F%E3%81%A3%E3%81%A6%E5%BF%85%E8%A6%81%E3%81%A8%E3%81%AA%E3%81%A3%E3%81%9F%E8%BF%BD%E5%8A%A0%E6%A9%9F%E8%83%BD" aria-hidden="true"></a> 実現にあたって必要となった追加機能</h2>
<h3 id="%E8%BF%BD%E5%8A%A0%E5%89%8D%E3%81%AE%E8%AA%B2%E9%A1%8C" data-line="90" class="code-line">
<a class="header-anchor-link" href="#%E8%BF%BD%E5%8A%A0%E5%89%8D%E3%81%AE%E8%AA%B2%E9%A1%8C" aria-hidden="true"></a> 追加前の課題</h3>
<p data-line="91" class="code-line">PipeCDのv0.46.0時点では、App Runnerでpipedを動かすには下記の通り課題がありました。</p>
<ul data-line="93" class="code-line">
<li data-line="93" class="code-line">
<p data-line="93" class="code-line">pipedのconfigはクレデンシャルを含むため、config全体をGitで管理するのはセキュアではありません。</p>
</li>
<li data-line="94" class="code-line">
<p data-line="94" class="code-line">そのため、ECSでpipedを動かす場合には下記のようになります。(<a href="https://pipecd.dev/docs-v0.45.x/installation/install-piped/installing-on-fargate/" target="_blank" rel="nofollow noopener noreferrer">Installing on ECS Fargate | PipeCD</a>)</p>
<ol data-line="96" class="code-line">
<li data-line="96" class="code-line">Secrets Managerにconfigを保管</li>
<li data-line="97" class="code-line">ECSタスクの起動時にそのconfigを環境変数として取得</li>
<li data-line="98" class="code-line">pipedの起動時にその環境変数の値を使用</li>
</ol>
</li>
<li data-line="100" class="code-line">
<p data-line="100" class="code-line">しかしApp Runnerでは、ECSと同様の方式では成功しませんでした。</p>
<ul data-line="101" class="code-line">
<li data-line="101" class="code-line">理由：　StartCommand内で環境変数が展開されないため。</li>
<li data-line="102" class="code-line">ちなみに StartCommand は CMDの上書きに相当するため、App Runnerのサービス起動時にENTRYPOINTを含む上書きは不可能な模様でした。
<ul data-line="103" class="code-line">
<li data-line="103" class="code-line">ECSではタスク定義側で entryPointと commandの両方を上書き可能</li>
</ul>
</li>
</ul>
</li>
</ul>
<h3 id="%E5%AF%BE%E5%BF%9C" data-line="105" class="code-line">
<a class="header-anchor-link" href="#%E5%AF%BE%E5%BF%9C" aria-hidden="true"></a> 対応</h3>
<ul data-line="107" class="code-line">
<li data-line="107" class="code-line">対応として、piped起動時に、pipedのconfigをSecrets Managerから取得できるようにしました。</li>
</ul>
<p data-line="109" class="code-line"><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__c3a87676c7738" src="https://embed.zenn.studio/card#zenn-embedded__c3a87676c7738" data-content="https%3A%2F%2Fgithub.com%2Fpipe-cd%2Fpipecd%2Fpull%2F4785" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://github.com/pipe-cd/pipecd/pull/4785" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://github.com/pipe-cd/pipecd/pull/4785</a></p>
<ul data-line="111" class="code-line">
<li data-line="111" class="code-line">実装は極めてシンプルなので、特筆事項はありません。</li>
</ul>
<h2 id="%E3%81%8A%E3%82%8F%E3%82%8A%E3%81%AB" data-line="113" class="code-line">
<a class="header-anchor-link" href="#%E3%81%8A%E3%82%8F%E3%82%8A%E3%81%AB" aria-hidden="true"></a> おわりに</h2>
<ul data-line="115" class="code-line">
<li data-line="115" class="code-line">CDKでもつくりたい</li>
<li data-line="116" class="code-line">Control PlaneをTerraformで構築するサンプルは既にあります。</li>
</ul>
<p data-line="118" class="code-line"><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__07cc39e652cc1" src="https://embed.zenn.studio/card#zenn-embedded__07cc39e652cc1" data-content="https%3A%2F%2Fgithub.com%2Fpipe-cd%2Fcontrol-plane-aws-ecs-terraform-demo" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://github.com/pipe-cd/control-plane-aws-ecs-terraform-demo" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://github.com/pipe-cd/control-plane-aws-ecs-terraform-demo</a></p>


【PipeCD】AWS App Runnerでpipedを動か(せるように)した

実現にあたって必要となった追加機能

Discussion