
## 寫在前面

在雲端服務一定會遇到的是機器的擴展(scale out)與縮編(scale in)的問題，如果一個AutoScaling Group觸發了機器的成長時肯定是無法靠手動
的方式來安裝機器，所以必須要透過全資動畫的方式進行，這時候我一開始的想法是在AutoScaling發生的時候觸法Jenkins的Job來安裝系統，
但這有個問題是我整個aws的服務都必須依賴在Jenkins上，後來同事指導了一個做法只需要透過AWS的設定就可以自動裝機了！

## User Data

一直以來都沒從還沒注意過AWS在建立EC2或是在Launch template介面上的`user data`，user data中的指令AWS會在我們EC2開機的過程中為我們執行
如此一來就可以不需要依賴任何一個工具就可以完成茲動畫的作業了。

![create instance 的 user data](ec2-provisioned-self-install/ec2-create-instance.png)

![launch template 的 user data](ec2-provisioned-self-install/launch-template.png)

```sh
#!/bin/bash -xe
aws s3 cp s3://{{your s3 bucket}}/main.sh main.sh --region {{your region}}
bash main.sh
```

> 在我同事的指點中，他建議在user data中不要放置帶多的指令碼而是用來下載入口指令碼與執行入口指令碼的內容就好

### main.sh

在入口腳本中一個很重要的事情是辨識機器需要安裝哪些東西以及要做哪些事情，但不太想讓user data有太多的版本避免團隊成員中複製時出錯，
所以在EC2的Tag中做了一些手腳，依照EC2 Tag的設定安裝不同的軟體

在取得EC2 Tag時其實需要先做很多事情，首先要先取得EC2 instance Id...但取的EC2 Instance Id前要先取得Region....
然後發現有個的API endpoint，這API endpoint 主要是取得主機的相關資料，然侯回傳的是一個Json的資料格式

在shell 操作Json的資料格式，不外乎就是jq這個套件了...所以我的入口腳本第一件事就是安裝jq，接下來才是去取得EC2 instance的資料

當有了instance id與region時就可以取得Tag資訊了

> EC2的Tag
> 1. Service: 設定機器主要承載的服務類型
> 2. Docker: 是否為這台機器安裝docker

```sh
#!/bin/bash -xe

exec > >(tee /var/log/user-data.log|logger -t user-data -s 2>/dev/console) 2>&1
sudo yum install -y jq
sudo apt-get install -y jq

REGION=`curl -s http://169.254.169.254/latest/dynamic/instance-identity/document | jq .region -r`
aws s3 cp s3://ec2-initial-script/functions.sh ./functions.sh --region ap-northeast-1
source ./functions.sh
log "Start setup script"

log "EC2 Instance Process" "Region:" $REGION
EC2_INSTANCE_ID=`curl -s http://169.254.169.254/latest/dynamic/instance-identity/document | jq .instanceId -r`
log "EC2 instance Id: ${EC2_INSTANCE_ID}"
TAGS="$(aws ec2 describe-tags --filter "Name=resource-id,Values=${EC2_INSTANCE_ID}" --region ${REGION})"

log "DOCKER Process"
DOCKER=`echo $TAGS | jq -r '.Tag[] | select(.Key == "Docker").Value'`
log "DOCKER Install ${DOCKER}"

if [[ "$DOCKER" == "yes" ]]; then
    log "DOCKER Install ... "
    sudo yum update -y
    sudo amazon-linux-extras install docker -y
    sudo service docker start
    sudo usermod -a -G docker ec2-user
    sudo systemctl restart docker
    log "DOCKER Install Successfully"

    log "DOCKER-COMPOSE Install ... "
    sudo curl -L "https://github.com/docker/compose/releases/download/1.25.0/docker-compose-$(uname -s)-$(uname -m)" \
              -o /usr/local/bin/docker-compose
    sudo chmod +x /usr/local/bin/docker-compose
    sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
    sudo systemctl enable docker
    log "DOCKER-COMPOSE Install Successfully "
fi;

SERVICE=`echo $TAGS | jq -r '.Tag[] | select(.Key == "Service").Value'`
log "Download ${SERVICE}.sh"
aws s3 cp s3://{{s3 bucket}}/$SERVICE/install.sh /install.sh

log "Execute ${SERVICE} script"
bash install.sh "${TAGS}" "${REGION}" "${EC2_INSTANCE_ID}"

log "End scripting"
```
### install.sh

user data只負責下載與執行入口腳本在入口腳本中還要執行服務腳本，服務腳本是用來安裝application的！
在入口腳本中會用EC2的Service Tag到S3 Bucket下載對應的install.sh來安裝與設定application所需要的設定

#### ECS的安裝腳本

```sh
#!/bin/bash -xe

source ./functions.sh
TAGS=$1
REGION=$2
INSTANCE=$3

log "ECS Install ... "

ECS_CLUSTER=`echo $TAGS | jq -r '.Tag[] | select(.Key == "ECS:cluster").Value'`
sudo mkdir /etc/ecs
cat << EOF > /etc/ecs/ecs.config
ECS_DATADIR=/data
ECS_ENABLE_TASK_IAM_ROLE=true
ECS_ENABLE_TASK_IAM_ROLE_NETWORK_HOST=true
ECS_LOGFILE=/log/ecs-agent.log
ECS_AVAILABLE_LOGGING_DRIVERS=["json-file","awslogs"]
ECS_LOGLEVEL=info
ECS_CLUSTER=$ECS_CLUSTER
EOF

docker run -d --name ecs-agent \
    --detach=true \
    --restart=always \
    --volume=/var/run:/var/run \
    --volume=/var/log/ecs/:/log \
    --volume=/var/lib/ecs/data:/data \
    --volume=/etc/ecs:/etc/ecs \
    --net=host \
    --env-file=/etc/ecs/ecs.config \
    --log-driver json-file \
    --log-opt max-size=100m \
    amazon/amazon-ecs-agent:latest

log "ECS Install Successfully "
```

### 總結

使用user data可以做到系統自動化而且還不需要依賴任何的工具，不過在使用這樣的方式時需要對整個OS, shell script（如果用windows就得對powershell熟悉）
以及對aws cli有足夠的能力才有機會做出這樣的腳本，有了這樣的腳本才能做到100％的自動化。
在目前已經做到完整的自動化的部署模式，我們團隊的CI server, Staging環境每天下班後自動關機上班前會自動開機並且安裝整個application
在production的環境裡，自動化擴展時Windows的機器約莫15分鐘，Linux的機器約莫5~7分鐘就能設定完成並且服務

> 在AWS的Image中只設定了預先裝好IIS的Windows機器，此目的是為了節省安裝IIS的時間成本讓機器可以更快的上線服務減少支出
> 其他Linux的機器都只有選擇AWS Linux2的image，並沒有特別做任何設定
>
> windows的機器在AWS開機使用T3.Medium的速度一般來說都在15分鐘左右完成

### EC2 instance 的相關時間估算

| Target         | Script  | 請求機器    | 移交機器    | Provisioned | Health check | 上線時間      |
|----------------|---------|---------|---------|-------------|--------------|-----------|
| Windows Server | 3~5 min | 1.5 min | 7~9 min | 5 min       | 1.5min       | 15~22 min |
| Linux Server   | 3~5 min | 1.5 min | 5~7 min | 3 min       | 1.5min       | 9~13 min  |

## 相關連結

[JQ github page](https://stedolan.github.io/jq/)


在雲端服務一定會遇到的是機器的擴展(scale out)與縮編(scale in)的問題，如果一個AutoScaling Group觸發了機器的成長時肯定是無法靠手動 的方式來安裝機器，所以必須要透過全資動畫的方式進行，這時候我一開始的想法是在AutoScaling發生的時候觸法Jenkins的Job來安裝系統， 但這有個問題是我整個aws的服務都必須依賴在Jenkins上，後來同事指導了一個做法只需要透過AWS的設定就可以自動裝機了！

如何讓AWS EC2開機後就能上線