task: OpsWorksスタックにIAMユーザの権限を設定¶

作業の目的 [why]¶

OpsWorksスタック"My Sample Stack (Linux)"にIAMユーザ"opsworks-worker"の権限を設定します。

完了条件/事前条件 [設計者用情報]

完了条件 [after]

主処理は、以下を満たしたときに成功したものとします。

完了条件1: OpsWorksスタック"My Sample Stack (Linux)"に対するIAMユーザ"opsworks-worker"のssh/todo権限が許可されている。

事前条件 [before]

主処理の実施は、以下の状態であることを前提とします。

事前条件1: IAMユーザ"opsworks-worker"が存在する。
事前条件2: OpsWorksスタック"My Sample Stack (Linux)"が存在する。
事前条件3: OpsWorksスタック"My Sample Stack (Linux)"に対するIAMユーザ"opsworks-worker"のssh/todo権限は許可されていない。

前提と異なることが判明した場合、直ちに処理を中止します。

作業対象 [what]¶

OpsWorksサービス

標準時間¶

8分

前提条件¶

作業権限条件 [who]¶

本作業は、以下の作業権限を有する人が行います。

作業権限条件: OpsWorksへの権限

OpsWorksに対してフル権限があること。

作業権限条件: IAMへの権限

IAMのRead権限があること。

作業環境条件 [where]¶

本作業は、以下の作業環境で行います。

作業環境条件1: OSとバージョン

Amazon Linuxの以下のバージョンで動作確認済

コマンド:

cat /etc/issue | head -1

結果(例):

Amazon Linux AMI release 2016.09

作業環境条件2: シェルとバージョン

bashの以下のバージョンで動作確認済

コマンド:

bash --version -v | head -1

結果(例):

GNU bash, バージョン 4.2.46(1)-release (x86_64-redhat-linux-gnu)

作業環境条件3: AWS CLIのバージョン

以下のバージョンで動作確認済

AWS CLI 1.11.117

コマンド:

aws --version

結果(例):

aws-cli/1.11.122 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.5.85

バージョンが古い場合は最新版に更新しましょう。

コマンド:

sudo -H pip install -U awscli

開始条件¶

作業に必要なモノ・情報 [resource]¶

作業開始には、以下が全て揃っていることが必要です。

リソース1: IAMユーザ名

作成するIAMユーザの名称です。
今回は"opsworks-worker"とします。

リソース2: OpsWorksスタック名

作成するOpsWorksスタックの名称です。
今回は"My Sample Stack (Linux)"とします。

作業開始 [when]¶

以下を全て満たしているとき、作業を開始します。

開始の指示があった場合。

タスクの実施¶

0. パラメータの指定¶

まず変数の確認をします。

変数の確認:

cat << ETX

  AWS_DEFAULT_PROFILE: (0.1) ${AWS_DEFAULT_PROFILE}
  AWS_DEFAULT_REGION:  (0.2) ${AWS_DEFAULT_REGION}
  IAM_USER_NAME:       (0.3) ${IAM_USER_NAME}
  OPSW_STACK_NAME:     (0.4) ${OPSW_STACK_NAME}

ETX

結果(例):

AWS_DEFAULT_PROFILE: (0.1) <OpsWorksのフル権限を許可されたプロファイル>
AWS_DEFAULT_REGION:  (0.2) ap-northeast-1
IAM_USER_NAME:       (0.3) opsworks-worker
OPSW_STACK_NAME:     (0.4) My Sample Stack (Linux)

変数が入っていない、適切でない場合は、それぞれの手順番号について作業を行います。

0.a. プロファイルの指定¶

プロファイルの一覧を確認します。

コマンド:

cat ~/.aws/credentials \
 | grep '\[' \
 | sed 's/\[//g' | sed 's/\]//g'

結果(例):

iamFull-prjz-mbpr13
<OpsWorksのフル権限を許可されたプロファイル>

変数の設定:

export AWS_DEFAULT_PROFILE='<OpsWorksのフル権限を許可されたプロファイル>'

0.b. リージョンの指定¶

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.3. IAMユーザ名の決定¶

IAMユーザ名を指定します。

変数の設定:

IAM_USER_NAME='opsworks-worker'

0.4. OpsWorksスタック名の決定¶

OpsWorksスタック名を決めます。

変数の設定:

OPSW_STACK_NAME='My Sample Stack (Linux)'

再確認¶

設定されている変数の内容を再確認します。

変数の確認:

cat << ETX

  AWS_DEFAULT_PROFILE: (0.1) ${AWS_DEFAULT_PROFILE}
  AWS_DEFAULT_REGION:  (0.2) ${AWS_DEFAULT_REGION}
  IAM_USER_NAME:       (0.3) ${IAM_USER_NAME}
  OPSW_STACK_NAME:     (0.4) ${OPSW_STACK_NAME}

ETX

結果(例):

AWS_DEFAULT_PROFILE: (0.1) <OpsWorksのフル権限を許可されたプロファイル>
AWS_DEFAULT_REGION:  (0.2) ap-northeast-1
IAM_USER_NAME:       (0.3) opsworks-worker
OPSW_STACK_NAME:     (0.4) My Sample Stack (Linux)

1. 前処理¶

1.1. 状態確認に必要な情報の取得¶

OpsWorksスタックIDの取得

コマンド:

OPSW_STACK_ID=$( \
  aws opsworks describe-stacks \
    --query "Stacks[?Name ==\`${OPSW_STACK_NAME}\`].StackId" \
    --output text \
) \
  && echo ${OPSW_STACK_ID}

結果(例):

xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

IAMユーザのARN取得

コマンド:

IAM_USER_ARN=$( \
  aws iam get-user \
    --user-name ${IAM_USER_NAME} \
    --query "User.Arn" \
    --output text \
) \
  && echo ${IAM_USER_ARN}

結果(例):

arn:aws:iam::XXXXXXXXXXXX:user/opsworks-worker

1.2. 処理対象の状態確認¶

主処理の実施は、以下の状態であることを前提とします。

前提と異なることが判明した場合、直ちに処理を中止します。

事前条件1: IAMユーザ"opsworks-worker"が存在する。

「IAMユーザ"opsworks-worker"が存在する。」ことを確認します。

コマンド:

aws iam get-user \
  --user-name ${IAM_USER_NAME} \
  --query "User.UserName"

結果(例):

"opsworks-worker"

事前条件2: OpsWorksスタック"My Sample Stack (Linux)"が存在する。

「OpsWorksスタック"My Sample Stack (Linux)"が存在する。」ことを確認します。

コマンド:

aws opsworks describe-stacks \
  --query "Stacks[?Name ==\`${OPSW_STACK_NAME}\`].Name"

結果(例):

{
    "My Sample Stack (Linux)"
}

事前条件3: OpsWorksスタック"My Sample Stack (Linux)"に対するIAMユーザ"opsworks-worker"のssh/todo権限は許可されていない。

「OpsWorksスタック"My Sample Stack (Linux)"に対するIAMユーザ"opsworks-worker"のssh/todo権限は許可されていない。」ことを確認します。

コマンド:

aws opsworks describe-permissions \
  --iam-user-arn ${IAM_USER_ARN} \
  --stack-id ${OPSW_STACK_ID}

結果(例):

{
  "Permissions": [
    {
        "StackId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "IamUserArn": "arn:aws:iam::XXXXXXXXXXXX:user/opsworks-worker",
        "Level": "iam_only",
        "AllowSudo": false,
        "AllowSsh": false
    }
  ]
}

"AllowSudo"と"AllowSsh"がfalseになっていることを確認します。

2. 主処理¶

OpsWorksパーミッションの設定¶

変数の確認:

cat << ETX

  OPSW_STACK_ID: ${OPSW_STACK_ID}
  IAM_USER_ARN:  ${IAM_USER_ARN}

ETX

コマンド:

aws opsworks set-permission \
  --stack-id ${OPSW_STACK_ID} \
  --iam-user-arn ${IAM_USER_ARN} \
  --allow-ssh \
  --allow-sudo

結果(例):

(出力なし)

3. 後処理¶

完了条件の確認¶

主処理は、以下を満たしたときに成功したものとします。

完了条件1: OpsWorksスタック"My Sample Stack (Linux)"に対するIAMユーザ"opsworks-worker"のssh/todo権限が許可されている。

「OpsWorksスタック"My Sample Stack (Linux)"に対するIAMユーザ"opsworks-worker"のssh/todo権限が許可されている。」ことを確認します。

コマンド:

aws opsworks describe-permissions \
  --iam-user-arn ${IAM_USER_ARN} \
  --stack-id ${OPSW_STACK_ID}

結果(例):

{
  "Permissions": [
    {
        "StackId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "IamUserArn": "arn:aws:iam::XXXXXXXXXXXX:user/opsworks-worker",
        "Level": "iam_only",
        "AllowSudo": true,
        "AllowSsh": true
    }
  ]
}

"AllowSudo"と"AllowSsh"がtrueになっていることを確認します。

handson: opsworks (aws: intro)

task: OpsWorksスタックにIAMユーザの権限を設定¶

作業の目的 [why]¶

作業対象 [what]¶

標準時間¶

前提条件¶

作業権限条件 [who]¶

作業環境条件 [where]¶

開始条件¶

作業に必要なモノ・情報 [resource]¶

作業開始 [when]¶

タスクの実施¶

0. パラメータの指定¶

0.a. プロファイルの指定¶

0.b. リージョンの指定¶

0.3. IAMユーザ名の決定¶

0.4. OpsWorksスタック名の決定¶

再確認¶

1. 前処理¶

1.1. 状態確認に必要な情報の取得¶

1.2. 処理対象の状態確認¶

2. 主処理¶

OpsWorksパーミッションの設定¶

3. 後処理¶

完了条件の確認¶

完了¶