一键连接 AWS ECS 的脚本

背景

最近参与的一个项目，需要经常地进入 AWS ECS 的 Fargate 服务中的容器中。

使用 awscli 的 ECS Exec 可以非常方便地连接到运行中的容器。

其大概的原理如下图所示：

ECS Exec 把 SSM Agent 绑定到容器，从而可以通过 Systems Manager （SSM）的会话管理器（Session Manager）访问容器。

所以执行该命令，除了需要安装 AWS CLI 之外，还需要安装 session-manager-plugin。

对于团队里的一部分成员来说，安装这些工具还是比较麻烦的，所以我写了一个脚本，可以一键连接到 ECS 的容器中。

脚本

#!/bin/bash -eu

# check if aws-cli is installed
if ! type aws >/dev/null 2>&1; then
    echo "aws-cli is not installed"
    echo "installing aws-cli...."
    brew install awscli
    echo "aws-cli is installed successfully. please set your credentials by 'aws configure' command"
fi

# check if session-manager-plugin is installed
if ! type session-manager-plugin >/dev/null 2>&1; then
    echo "session-manager-plugin is not installed"
    echo "installing session-manager-plugin...."
    # Download and unzip the Session Manager plugin installer
    mkdir -p $HOME/session-manager-plugin/bin
    curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/mac/sessionmanager-bundle.zip" -o "$HOME/session-manager-plugin/bin/sessionmanager-bundle.zip"
    unzip -d $HOME/session-manager-plugin/bin $HOME/session-manager-plugin/bin/sessionmanager-bundle.zip
    sudo $HOME/session-manager-plugin/bin/install -i /usr/local/sessionmanagerplugin -b /usr/local/bin/session-manager-plugin

    echo "session-manager-plugin is installed successfully."
fi

# set your container name and cluster name
container_name="your-container-name"
cluster_name="your-ecs-cluster-name"

# 执行脚本时，使用 `--profile` 指定的 AWS 配置文件
aws_profile="default"
while [ "$#" -gt 0 ]; do
    case "$1" in
    --profile=*)
        aws_profile="${1#*=}"
        ;;
    *)
        # exit when unknown option is specified
        echo "未知のオプション: $1"
        exit 1
        ;;
    esac
    shift
done
echo "aws_profile: $aws_profile"

# fetch task arn
task_arn=$(aws ecs list-tasks \
    --profile "$aws_profile" \
    --cluster $cluster_name \
    --desired-status RUNNING \
    --query 'taskArns[0]' \
    --output text)

# spit task id from task arn
task_id=$(echo "$task_arn" | awk -F/ '{print $NF}')
echo "task_id: $task_id"

# enter container with session manager
aws ecs execute-command \
    --profile "$aws_profile" \
    --cluster $cluster_name \
    --task "$task_id" \
    --container $container_name \
    --command "/bin/sh" \
    --interactive

使用方法

将上述脚本保存为 connect-to-aws-ecs.sh 文件
执行 chmod +x connect-to-aws-ecs.sh 赋予脚本执行权限
修改脚本中的 container_name 和 cluster_name 为你自己的值
执行 ./connect-to-aws-ecs.sh 即可连接到 ECS 的容器中

Reference

使用 ECS Exec 访问 Fargate 上的容器

Amazon ECS Exec を使ってみる