1. DBインスタンスの作成 (PostgreSQL: Single-AZ)¶

作業の目的 [why]¶

DBインスタンス"dbinstance-handson-cli"を作成します。

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

完了条件 [after]

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

完了条件1: DBインスタンス"dbinstance-handson-cli"が存在する。
完了条件2: DBインスタンス"dbinstance-handson-cli"がSingleAZで動作している。

事前条件 [before]

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

事前条件1: DBインスタンス"dbinstance-handson-cli"が存在しない。
事前条件2: DBサブネットグループ"dbsubnet-handson-cli"が存在する。
事前条件3: VPC"vpc-handson-cli"が存在する。
事前条件4: VPC"vpc-handson-cli"にセキュリティグループ"db-handson-cli"が存在する。

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

作業対象 [what]¶

RDSサービス

標準時間¶

8分

前提条件¶

作業権限条件 [who]¶

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

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

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

作業環境条件 [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.14.24

コマンド:

aws --version

結果(例):

aws-cli/1.14.28 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.8.32

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

コマンド:

sudo -H pip install -U awscli

開始条件¶

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

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

リソース1: DBインスタンス名

作成するDBインスタンスの名称です。
今回は"dbinstance-handson-cli"とします。

リソース2: VPC名

DBサブネットグループに属するサブネット、セキュリティグループの存在するVPCの名称です。
今回は"vpc-handson-cli"とします。

リソース3: DBサブネットグループ名

作成するDBサブネットグループの名称です。
今回は"dbsubnet-handson-cli"とします。

リソース4: セキュリティーグループ名

作成するDBインスタンスが利用するセキュリティーグループの名称です。
今回は"db-handson-cli"とします。

リソース5: DBエンジンの決定

作成するDBインスタンスが利用するの名称です。
今回は"postgres"とします。

リソース6: DBインスタンスクラス

作成するインスタンスが利用するインスタンスのクラス名です。
今回は"db.t2.micro"とします。

リソース7: ストレージサイズ

作成するDBインスタンスが利用するストレージのサイズです。
今回は"5"とします。

リソース8: マスタユーザ名

インスタンスに作成するマスタユーザの名称です。
今回は"pgadmin"とします。

リソース9: マスタパスワード

インスタンスに作成するマスタユーザのパスワードです。
今回は"#dbPass123"とします。

リソース10: データベース名

インスタンスに作成するデフォルトデータベースの名称です。
今回は"handsonCLI"とします。
データベース名には、英数字のみが利用できます。

作業開始 [when]¶

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

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

タスクの実施¶

0. パラメータの指定¶

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

変数の確認:

cat << ETX

  # 0.a. AWS_DEFAULT_PROFILE:"<RDSのフル権限を許可されたプロファイル>"
         AWS_DEFAULT_PROFILE="${AWS_DEFAULT_PROFILE}"
  # 0.b. AWS_DEFAULT_REGION:"ap-northeast-1"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. RDS_INSTANCE_IDENT:"dbinstance-handson-cli"
         RDS_INSTANCE_IDENT="${RDS_INSTANCE_IDENT}"
  # 0.2. VPC_TAG_NAME:"vpc-handson-cli"
         VPC_TAG_NAME="${VPC_TAG_NAME}"
  # 0.3. RDS_SUBNET_GROUP_NAME:"dbsubnet-handson-cli"
         RDS_SUBNET_GROUP_NAME="${RDS_SUBNET_GROUP_NAME}"
  # 0.4. VPC_SG_NAME:"db-handson-cli"
         VPC_SG_NAME="${VPC_SG_NAME}"
  # 0.5. RDS_ENGINE_NAME:"postgres"
         RDS_ENGINE_NAME="${RDS_ENGINE_NAME}"
  # 0.6. RDS_INSTANCE_CLASS:"db.t2.micro"
         RDS_INSTANCE_CLASS="${RDS_INSTANCE_CLASS}"
  # 0.7. RDS_STORAGE_SIZE:"5"
         RDS_STORAGE_SIZE="${RDS_STORAGE_SIZE}"
  # 0.8. RDS_USER_NAME:"pgadmin"
         RDS_USER_NAME="${RDS_USER_NAME}"
  # 0.9. RDS_USER_PASS:"#dbPass123"
         RDS_USER_PASS="${RDS_USER_PASS}"
  # 0.10. RDS_DB_NAME:"handsonCLI"
          RDS_DB_NAME="${RDS_DB_NAME}"

ETX

下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号について作業を行います。

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

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

コマンド:

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

結果(例):

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

変数の設定:

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

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

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. DBインスタンス名¶

作成するDBインスタンスの名を指定します。

変数の設定:

RDS_INSTANCE_IDENT='dbinstance-handson-cli'

0.2 VPC名¶

VPC名を指定します。

変数の設定:

VPC_TAG_NAME='vpc-handson-cli'

0.3. DBサブネットグループ名の指定¶

DBサブネットグループ名を指定します。

変数の設定:

RDS_SUBNET_GROUP_NAME='dbsubnet-handson-cli'

0.4. セキュリティーグループ名¶

セキュリティーグループ名を指定します。

変数の設定:

VPC_SG_NAME='db-handson-cli'

0.5. DBエンジンの決定¶

DBインスタンス名を指定します。

変数の設定:

RDS_ENGINE_NAME='postgres'

0.6. DBインスタンスクラス¶

インスタンスクラスを指定します。

変数の設定:

RDS_INSTANCE_CLASS='db.t2.micro'

0.7. ストレージサイズ¶

ストレージサイズを指定します。

変数の設定:

RDS_STORAGE_SIZE='5'

0.8. マスタユーザ名¶

マスタユーザ名を指定します。

変数の設定:

RDS_USER_NAME='pgadmin'

0.9. マスタパスワード¶

マスタユーザのパスワードを指定します。

変数の設定:

RDS_USER_PASS='#dbPass123'

0.10. データベース名¶

デフォルトデータベース名を指定します。

変数の設定:

RDS_DB_NAME="handsonCLI"

データベース名には、英数字以外の文字は利用できません。

再確認¶

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

変数の確認:

cat << ETX

  # 0.a. AWS_DEFAULT_PROFILE:"<RDSのフル権限を許可されたプロファイル>"
         AWS_DEFAULT_PROFILE="${AWS_DEFAULT_PROFILE}"
  # 0.b. AWS_DEFAULT_REGION:"ap-northeast-1"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. RDS_INSTANCE_IDENT:"dbinstance-handson-cli"
         RDS_INSTANCE_IDENT="${RDS_INSTANCE_IDENT}"
  # 0.2. VPC_TAG_NAME:"vpc-handson-cli"
         VPC_TAG_NAME="${VPC_TAG_NAME}"
  # 0.3. RDS_SUBNET_GROUP_NAME:"dbsubnet-handson-cli"
         RDS_SUBNET_GROUP_NAME="${RDS_SUBNET_GROUP_NAME}"
  # 0.4. VPC_SG_NAME:"db-handson-cli"
         VPC_SG_NAME="${VPC_SG_NAME}"
  # 0.5. RDS_ENGINE_NAME:"postgres"
         RDS_ENGINE_NAME="${RDS_ENGINE_NAME}"
  # 0.6. RDS_INSTANCE_CLASS:"db.t2.micro"
         RDS_INSTANCE_CLASS="${RDS_INSTANCE_CLASS}"
  # 0.7. RDS_STORAGE_SIZE:"5"
         RDS_STORAGE_SIZE="${RDS_STORAGE_SIZE}"
  # 0.8. RDS_USER_NAME:"pgadmin"
         RDS_USER_NAME="${RDS_USER_NAME}"
  # 0.9. RDS_USER_PASS:"#dbPass123"
         RDS_USER_PASS="${RDS_USER_PASS}"
  # 0.10. RDS_DB_NAME:"handsonCLI"
          RDS_DB_NAME="${RDS_DB_NAME}"

ETX

1. 前処理¶

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

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

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

事前条件1: DBインスタンス"dbinstance-handson-cli"が存在しない。

「DBインスタンス"dbinstance-handson-cli"が存在しない。」ことを確認します。

コマンド:

aws rds describe-db-instances \
  --query "DBInstances[?DBInstanceIdentifier == \`${RDS_INSTANCE_IDENT}\`].DBInstanceIdentifier"

結果(例):

[]

事前条件2: DBサブネットグループ"dbsubnet-handson-cli"が存在する。

「DBサブネットグループ"dbsubnet-handson-cli"が存在する。」ことを確認します。

コマンド:

aws rds describe-db-subnet-groups \
  --query "DBSubnetGroups[?DBSubnetGroupName == \`${RDS_SUBNET_GROUP_NAME}\`].DBSubnetGroupName"

結果(例):

[
  dbsubnet-handson-cli
]

事前条件3: VPC"vpc-handson-cli"が存在する。

「VPC"vpc-handson-cli"が存在する。」ことを確認します。

変数の設定:

EC2_TAG_KEY='Name'

コマンド:

aws ec2 describe-vpcs \
  --filters Name=tag:${EC2_TAG_KEY},Values=${VPC_TAG_NAME}  \
  --query "Vpcs[].Tags[].Value"

結果(例):

[
  "vpc-handson-cli"
]

VPC IDを取得します。

コマンド:

VPC_ID=$( \
  aws ec2 describe-vpcs \
    --filters Name=tag:${EC2_TAG_KEY},Values=${VPC_TAG_NAME}  \
    --query 'Vpcs[].VpcId' \
    --output text \
) \
  && echo ${VPC_ID}

結果(例):

vpc-xxxxxxxx

事前条件4: VPC"vpc-handson-cli"にセキュリティグループ"db-handson-cli"が存在する。

「VPC"vpc-handson-cli"にセキュリティグループ"db-handson-cli"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-security-groups \
  --filter Name=vpc-id,Values=${VPC_ID} \
    Name=group-name,Values=${VPC_SG_NAME} \
  --query 'SecurityGroups[].GroupName'

結果(例):

[
  "db-handson-cli"
]

1.2. 主処理に必要な情報の取得¶

セキュリティグループIDの取得

セキュリティグループIDを取得します。

コマンド:

VPC_SG_ID=$( \
  aws ec2 describe-security-groups \
    --filter Name=vpc-id,Values=${VPC_ID} \
      Name=group-name,Values=${VPC_SG_NAME} \
    --query "SecurityGroups[].GroupId" \
    --output text \
) \
  && echo ${VPC_SG_ID}

結果(例):

sg-xxxxxxxx

セキュリティグループの配列への追加

変数の設定:

ARRAY_VPC_SG_IDS="${VPC_SG_ID} ${ARRAY_VPC_SG_ID}" \
  && echo ${ARRAY_VPC_SG_IDS}

結果(例):

sg-xxxxxxxx

2. 主処理¶

DBインスタンスの作成¶

変数の確認:

cat << ETX

  # RDS_INSTANCE_IDENT:"dbinstance-handson-cli"
    RDS_INSTANCE_IDENT="${RDS_INSTANCE_IDENT}"
  # RDS_INSTANCE_CLASS:"db.t2.micro"
    RDS_INSTANCE_CLASS="${RDS_INSTANCE_CLASS}"
  # RDS_ENGINE_NAME:"postgres"
    RDS_ENGINE_NAME="${RDS_ENGINE_NAME}"
  # RDS_DB_NAME:"handsonCLI"
    RDS_DB_NAME="${RDS_DB_NAME}"
  # RDS_STORAGE_SIZE:"5"
    RDS_STORAGE_SIZE="${RDS_STORAGE_SIZE}"
  # RDS_USER_NAME:"pgadmin"
    RDS_USER_NAME="${RDS_USER_NAME}"
  # RDS_USER_PASS:"#dbPass123"
    RDS_USER_PASS="${RDS_USER_PASS}"
  # RDS_SUBNET_GROUP_NAME:"dbsubnet-handson-cli"
    RDS_SUBNET_GROUP_NAME="${RDS_SUBNET_GROUP_NAME}"
  # ARRAY_VPC_SG_IDS:"sg-xxxxxxxx"
    ARRAY_VPC_SG_IDS="${ARRAY_VPC_SG_IDS}"

ETX

コマンド:

aws rds create-db-instance \
  --db-instance-identifier ${RDS_INSTANCE_IDENT} \
  --db-instance-class ${RDS_INSTANCE_CLASS} \
  --engine ${RDS_ENGINE_NAME} \
  --db-name ${RDS_DB_NAME} \
  --allocated-storage ${RDS_STORAGE_SIZE} \
  --master-username ${RDS_USER_NAME} \
  --master-user-password ${RDS_USER_PASS} \
  --db-subnet-group-name ${RDS_SUBNET_GROUP_NAME} \
  --vpc-security-group-ids ${ARRAY_VPC_SG_IDS}

結果(例):

{
  "DBInstance": {
    "PubliclyAccessible": false,
    "MasterUsername": "pgadmin",
    "MonitoringInterval": 0,
    "LicenseModel": "postgresql-license",
    "VpcSecurityGroups": [
        {
            "Status": "active",
            "VpcSecurityGroupId": "sg-xxxxxxxx"
        }
    ],
    "CopyTagsToSnapshot": false,
    "OptionGroupMemberships": [
        {
            "Status": "in-sync",
            "OptionGroupName": "default:postgres-9-5"
        }
    ],
    "PendingModifiedValues": {
        "MasterUserPassword": "****"
    },
    "Engine": "postgres",
    "MultiAZ": false,
    "DBSecurityGroups": [],
    "DBParameterGroups": [
        {
            "DBParameterGroupName": "default.postgres9.5",
            "ParameterApplyStatus": "in-sync"
        }
    ],
    "AutoMinorVersionUpgrade": true,
    "PreferredBackupWindow": "19:06-19:36",
    "DBSubnetGroup": {
        "Subnets": [
            {
                "SubnetStatus": "Active",
                "SubnetIdentifier": "subnet-xxxxxxxx",
                "SubnetAvailabilityZone": {
                    "Name": "ap-northeast-1a"
                }
            },
            {
                "SubnetStatus": "Active",
                "SubnetIdentifier": "subnet-xxxxxxxx",
                "SubnetAvailabilityZone": {
                    "Name": "ap-northeast-1c"
                }
            }
        ],
        "DBSubnetGroupName": "dbsubnet-handson-cli",
        "VpcId": "vpc-xxxxxxxx",
        "DBSubnetGroupDescription": "PostgreSQL Redmine",
        "SubnetGroupStatus": "Complete"
    },
    "ReadReplicaDBInstanceIdentifiers": [],
    "AllocatedStorage": 5,
    "DBInstanceArn": "arn:aws:rds:ap-northeast-1:XXXXXXXXXXXX:db:dbinstance-handson-cli",
    "BackupRetentionPeriod": 1,
    "DBName": "handsonCLI",
    "PreferredMaintenanceWindow": "tue:13:00-tue:13:30",
    "DBInstanceStatus": "creating",
    "EngineVersion": "9.5.4",
    "DomainMemberships": [],
    "StorageType": "standard",
    "DbiResourceId": "db-7ZOMGTEKHCZNLIFRXB3TOTR2XQ",
    "CACertificateIdentifier": "rds-ca-2015",
    "StorageEncrypted": false,
    "DBInstanceClass": "db.t2.micro",
    "DbInstancePort": 0,
    "DBInstanceIdentifier": "dbinstance-handson-cli"
  }
}

3. 後処理¶

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

DBインスタンスの状態確認

コマンド:

RDS_INSTANCE_STATUS=$( \
  aws rds describe-db-instances \
    --db-instance-identifier ${RDS_INSTANCE_IDENT} \
    --query 'DBInstances[].DBInstanceStatus' \
    --output text \
  ) \
    && echo ${RDS_INSTANCE_STATUS}

結果(例):

available

3.2. 完了条件の確認¶

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

完了条件1: DBインスタンス"dbinstance-handson-cli"が存在する。

「DBインスタンス"dbinstance-handson-cli"が存在する。」ことを確認します。

コマンド:

aws rds describe-db-instances \
  --query "DBInstances[?DBInstanceIdentifier == \`${RDS_INSTANCE_IDENT}\`].DBInstanceIdentifier"

結果(例):

[
  "dbinstance-handson-cli"
]

完了条件2: DBインスタンス"dbinstance-handson-cli"がSingleAZで動作している。

「DBインスタンス"dbinstance-handson-cli"がSingleAZで動作している。」ことを確認します。

コマンド:

aws rds describe-db-instances \
  --db-instance-identifier ${RDS_INSTANCE_IDENT} \
  --query 'DBInstances[].MultiAZ'

結果(例):

[
  false
]

3.3. 後処理に必要な作業¶

エンドポイントの確認

コマンド:

RDS_INSTANCE_ENDPOINT=$( \
  aws rds describe-db-instances \
    --db-instance-identifier ${RDS_INSTANCE_IDENT} \
    --query 'DBInstances[].Endpoint.Address' \
    --output text \
) \
  && echo ${RDS_INSTANCE_ENDPOINT}

結果(例):

dbinstance-handson-cli-ap-northeast-1.xxxxxxxxxxxx.ap-northeast-1rds.amazonaws.com

handson: CDP (rds postgresql)

1. DBインスタンスの作成 (PostgreSQL: Single-AZ)¶

作業の目的 [why]¶

作業対象 [what]¶

標準時間¶

前提条件¶

作業権限条件 [who]¶

作業環境条件 [where]¶

開始条件¶

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

作業開始 [when]¶

タスクの実施¶

0. パラメータの指定¶

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

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

0.1. DBインスタンス名¶

0.2 VPC名¶

0.3. DBサブネットグループ名の指定¶

0.4. セキュリティーグループ名¶

0.5. DBエンジンの決定¶

0.6. DBインスタンスクラス¶

0.7. ストレージサイズ¶

0.8. マスタユーザ名¶

0.9. マスタパスワード¶

0.10. データベース名¶

再確認¶

1. 前処理¶

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

1.2. 主処理に必要な情報の取得¶

2. 主処理¶

DBインスタンスの作成¶

3. 後処理¶

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

3.2. 完了条件の確認¶

3.3. 後処理に必要な作業¶

完了¶