<h1 id="%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB">
<a class="header-anchor-link" href="#%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB" aria-hidden="true"></a> はじめに</h1>
<p>2021年3月、実行中のコンテナに入ることができる「ECS Exec」がリリースされました。<br>
これがリリースされるまで、ECSでコンテナに入る方法としては、</p>
<ul>
<li>ECS on EC2
<ul>
<li>EC2にsshした後に<code>docker exec</code>する</li>
</ul>
</li>
<li>ECS on Fargate
<ul>
<li>そもそもできない（Session Managerを使った非公式な方法は除く）</li>
</ul>
</li>
</ul>
<p>といった状況だったため、このリリースでECS（特にFargate）での<strong>デバッグ</strong>や<strong>トラブルシューティング</strong>が一気に楽になりました。</p>
<div class="code-block-container"><pre><code>aws ecs execute-command --task [タスクID] ... --command '/bin/bash'
</code></pre></div><p><br></p>
<p>ただ、人間欲深い生き物でして、実際に<code>aws ecs execute-command</code>を使い始めると、今度は、</p>
<ul>
<li>タスクIDをマネコン等で調べるのが手間なので対話形式で選択したい</li>
<li>ECSとローカル間でファイルをコピーしたい（scpしたい）</li>
</ul>
<p>などの欲が新たに発生してしまいます。</p>
<p>「探せばそういうことができるツールがあるんじゃないの」とも思いましたが、現存するECS系ツールはデプロイツールとしての役割を担うものが主で、これらの機能（特にscp）を持つツールは見つけられませんでした。</p>
<p>そこで今回、<strong>ECSのデバッグやトラブルシューティングに特化したCLIツール</strong>を作りました。</p>
<p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__a938adc919874" src="https://embed.zenn.studio/card#zenn-embedded__a938adc919874" data-content="https%3A%2F%2Fgithub.com%2Fyukiarrr%2Fecsk" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://github.com/yukiarrr/ecsk" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://github.com/yukiarrr/ecsk</a></p>
<h1 id="%E6%A9%9F%E8%83%BD%E7%B4%B9%E4%BB%8B">
<a class="header-anchor-link" href="#%E6%A9%9F%E8%83%BD%E7%B4%B9%E4%BB%8B" aria-hidden="true"></a> 機能紹介</h1>
<p><img src="https://storage.googleapis.com/zenn-user-upload/eb7538aa5cf9d6ca6dff93bd.gif" alt="ecsk" loading="lazy" class="md-img"></p>
<p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__5bc79eafd4fcf" src="https://embed.zenn.studio/card#zenn-embedded__5bc79eafd4fcf" data-content="https%3A%2F%2Fgithub.com%2Fyukiarrr%2Fecsk" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://github.com/yukiarrr/ecsk" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://github.com/yukiarrr/ecsk</a></p>
<p>今回作成した<strong>ecsk</strong>では、デバッグ・トラブルシューティング時に欲しくなる機能はもれなく突っ込んでいます。</p>
<ul>
<li>
<strong>クラスタ、タスクIDなどのリソースを対話形式で選択可能</strong>
<ul>
<li>タスクIDなどコマンドを実行する上で必要なリソースを指定しなくても、リソース一覧で選択肢が提示されるため、マネコン等で調べる必要がありません</li>
<li>ecskに実装されているコマンドは全て、対話形式で選択可能です</li>
<li>類似した機能を持つツール
<ul>
<li><a href="https://github.com/tedsmitt/ecsgo" target="_blank" rel="nofollow noopener noreferrer">ecsgo</a></li>
</ul>
</li>
</ul>
</li>
<li>
<strong>scpのようにECSとローカル間でファイルをコピー</strong>
<ul>
<li>双方向にファイル、ディレクトリをコピーできます</li>
<li>現状、これと同じ機能を持つツールは他で見つけられませんでした</li>
</ul>
</li>
<li>
<strong>1コマンドでタスクを実行しログを流す</strong>
<ul>
<li>AWS CLIで同じことをしようとすると、<code>aws ecs run-task</code>して<code>aws ecs wait</code>でRUNNINGになるまで待機して<code>aws logs tail</code>する、といった手順が必要となりますが、それが1コマンドで完結できます</li>
<li>類似した機能を持つツール
<ul>
<li>
<a href="https://github.com/buildkite/ecs-run-task" target="_blank" rel="nofollow noopener noreferrer">ecs-run-task</a>, <a href="https://github.com/dalen/ecs-run" target="_blank" rel="nofollow noopener noreferrer">ecs-run</a>
</li>
</ul>
</li>
</ul>
</li>
<li>
<strong><code>docker logs</code>のように既存タスクのログを表示</strong>
<ul>
<li>
<a href="https://github.com/knqyf263/utern" target="_blank" rel="nofollow noopener noreferrer">utern</a>を利用させていただいるため、タスクのログをコンテナごとにカラー分けして表示できます</li>
<li>類似した機能を持つツール
<ul>
<li><a href="https://github.com/aws/amazon-ecs-cli" target="_blank" rel="nofollow noopener noreferrer">amazon-ecs-cli</a></li>
</ul>
</li>
</ul>
</li>
<li>
<strong>インストールが簡単</strong>
<ul>
<li>Go製なので、<a href="https://github.com/yukiarrr/ecsk/releases" target="_blank" rel="nofollow noopener noreferrer">Releases</a>からバイナリをダウンロードするだけです</li>
<li>Macの方は、brewコマンド一つでインストール可能です</li>
</ul>
</li>
</ul>
<h1 id="%E3%82%B3%E3%83%9E%E3%83%B3%E3%83%89%E4%BE%8B">
<a class="header-anchor-link" href="#%E3%82%B3%E3%83%9E%E3%83%B3%E3%83%89%E4%BE%8B" aria-hidden="true"></a> コマンド例</h1>
<p>ここでは、よく使うコマンドを紹介します。<br>
詳しいフラグについては、<code>ecsk [コマンド] --help</code>を実行して確認してください。</p>
<h3 id="ecsk-run">
<a class="header-anchor-link" href="#ecsk-run" aria-hidden="true"></a> <code>ecsk run</code>
</h3>
<div class="code-block-container"><pre><code>ecsk run
</code></pre></div><p>フラグを一切指定しない場合は、対話形式でタスク情報を選択した後、<code>docker run</code>と同じようにタスクが起動し終了するまでログが流れ続けます。<br>
<br></p>
<div class="code-block-container"><pre><code>ecsk run -e -i --rm -c [コンテナ名] -- /bin/bash
</code></pre></div><p>タスクを起動させた後、<code>execute-command</code>で指定したコマンドを実行します。<br>
合わせて<code>--rm</code>を指定することで、セッション終了時に自動でタスクが終了するため、踏み台サーバーのように運用することが可能になります。<br>
<br></p>
<div class="code-block-container"><pre><code>ecsk run -d
</code></pre></div><p>対話形式でタスク情報を選択した後、タスクの開始・終了を待たずにコマンドを終了させます。</p>
<h3 id="ecsk-exec">
<a class="header-anchor-link" href="#ecsk-exec" aria-hidden="true"></a> <code>ecsk exec</code>
</h3>
<div class="code-block-container"><pre><code>ecsk exec -i -- /bin/bash
</code></pre></div><p>対話形式でタスク・コンテナを選択し、コマンドを実行します。</p>
<h3 id="ecsk-cp">
<a class="header-anchor-link" href="#ecsk-cp" aria-hidden="true"></a> <code>ecsk cp</code>
</h3>
<div class="code-block-container"><pre><code>ecsk cp ./ [コンテナ名]:/etc/nginx/
</code></pre></div><p>対話形式でタスクを選択し、ローカルからECSへファイルをコピーします。<br>
内部的にはS3 Bucketを使用してファイルを転送しているので、タスクロールに該当Bucketのアクセス許可を追加する必要があります（詳しくは<a href="https://github.com/yukiarrr/ecsk/blob/main/README.ja.md#ecsk-cp%E3%82%92%E4%BD%BF%E3%81%86%E5%A0%B4%E5%90%88" target="_blank" rel="nofollow noopener noreferrer">README</a>参照）。</p>
<p>なお、コンテナも対話形式で選択する場合は、<code>ecsk cp ./ :/etc/nginx/</code>としてください。<br>
<br></p>
<div class="code-block-container"><pre><code>ecsk cp [コンテナ名]:/var/log/nginx/access.log ./
</code></pre></div><p>ECSからローカルにファイルをコピーします。</p>
<h3 id="ecsk-logs">
<a class="header-anchor-link" href="#ecsk-logs" aria-hidden="true"></a> <code>ecsk logs</code>
</h3>
<div class="code-block-container"><pre><code>ecsk logs
</code></pre></div><p>対話形式でタスクを選択し、ログを表示します。<br>
このタスクは複数指定することができます。</p>
<p>なお、ログ表示は<a href="https://github.com/knqyf263/utern" target="_blank" rel="nofollow noopener noreferrer">utern</a>を利用させていただいています。</p>
<p><img src="https://storage.googleapis.com/zenn-user-upload/fe15695e06030109eca28e27.png" alt="ecsk-logs" loading="lazy" class="md-img"></p>
<h3 id="ecsk-stop">
<a class="header-anchor-link" href="#ecsk-stop" aria-hidden="true"></a> <code>ecsk stop</code>
</h3>
<div class="code-block-container"><pre><code>ecsk stop
</code></pre></div><p>対話形式でタスクを選択し、終了します。<br>
こちらも複数指定可能です。</p>
<h3 id="ecsk-describe">
<a class="header-anchor-link" href="#ecsk-describe" aria-hidden="true"></a> <code>ecsk describe</code>
</h3>
<div class="code-block-container"><pre><code>ecsk describe
</code></pre></div><p>対話形式でタスクを選択し、詳細情報を表示します。<br>
また、タスク一覧を確認する用途としても利用できます。</p>
<p><img src="https://storage.googleapis.com/zenn-user-upload/3c5311fcd035a540f36a230d.png" alt="ecsk-describe" loading="lazy" class="md-img"></p>
<h1 id="%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">
<a class="header-anchor-link" href="#%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB" aria-hidden="true"></a> インストール</h1>
<h2 id="macos">
<a class="header-anchor-link" href="#macos" aria-hidden="true"></a> MacOS</h2>
<div class="code-block-container"><pre><code>brew install yukiarrr/tap/ecsk
</code></pre></div><h2 id="linux">
<a class="header-anchor-link" href="#linux" aria-hidden="true"></a> Linux</h2>
<div class="code-block-container"><pre><code>wget https://github.com/yukiarrr/ecsk/releases/download/v0.6.1/ecsk_Linux_x86_64.tar.gz
tar zxvf ecsk_Linux_x86_64.tar.gz
chmod +x ./ecsk
sudo mv ./ecsk /usr/local/bin/ecsk
</code></pre></div><h2 id="windows">
<a class="header-anchor-link" href="#windows" aria-hidden="true"></a> Windows</h2>
<p><a href="https://github.com/yukiarrr/ecsk/releases" target="_blank" rel="nofollow noopener noreferrer">Releases</a>からダウンロードしてください。</p>
<h1 id="%E3%81%BE%E3%81%A8%E3%82%81">
<a class="header-anchor-link" href="#%E3%81%BE%E3%81%A8%E3%82%81" aria-hidden="true"></a> まとめ</h1>
<p>ecskはコンテナ（タスク）を取り扱うことに長けているので、</p>
<ul>
<li>ECSサービスやタスク定義の管理 → AWS CDKやCopilot、Terraformなどを使用</li>
<li>デバッグやトラブルシューティング → <strong>ecsk</strong>を使用 😁</li>
</ul>
<p>などの利用を想定しています。</p>
<p>基本手元でのみ使う便利ツールで、AWS CDKやCopilotのように一度導入したら取り替えが難しいものでもないので、気楽に試していただければと思います。</p>
<p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__011847e7ce1bd" src="https://embed.zenn.studio/card#zenn-embedded__011847e7ce1bd" data-content="https%3A%2F%2Fgithub.com%2Fyukiarrr%2Fecsk" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://github.com/yukiarrr/ecsk" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://github.com/yukiarrr/ecsk</a></p>


ECSとローカル間でファイルをコピーしたり、対話形式でrun-taskやexecできるデバッグ特化のCLIツールを作りました

takayuki

<p>普段業務でECSを使っており「これすごく便利じゃん！」とこちらのツールを使ってみたのですが、<br>
どうやら Windows だと一部？使えない機能があるみたいです。</p>
<p>取り急ぎ ecsk cp は <code>The remote path must be absolute. Try "ecsk cp --help".</code> と出てエラーになります。<br style="display:none">
<span class="embed-block zenn-embedded zenn-embedded-github"><iframe id="zenn-embedded__913ba0fb366f4" src="https://embed.zenn.studio/github#zenn-embedded__913ba0fb366f4" data-content="https%3A%2F%2Fgithub.com%2Fyukiarrr%2Fecsk%2Fblob%2Fmain%2Fpkg%2Fcmd%2Fcp.go%23L123" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://github.com/yukiarrr/ecsk/blob/main/pkg/cmd/cp.go#L123" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://github.com/yukiarrr/ecsk/blob/main/pkg/cmd/cp.go#L123</a><br style="display:none">
Gitのソースコードを見るに cp.go の <code>filepath.IsAbs(src[1])</code> が Windowsの絶対パス形式で判断しちゃうため、ECS(Linux系のコンテナ)の送り元（送り先）パスが <code>C:\\hogehoge</code> みたいな形式になっていない！と理不尽な怒られ方をしてしまうようです。</p>
<p>ちなみに、MACで動かす分には全く問題無いのでMACユーザー間では重宝させていただいております。<br>
ありがとうございます！</p>


Discussion