Skip to content

Latest commit

 

History

History
192 lines (125 loc) · 8 KB

DEPLOYMENT.md

File metadata and controls

192 lines (125 loc) · 8 KB
Raw

aws環境の設定はAWS CDKのコードで管理されています。

インスタンスタイプやオートスケールの設定が違うため、stagingとproductionで一部ファイルが別です。それ以外の共通の設定は同じファイルを使っているので気を付けて下さい。

staging: config/staging production: config/production

デプロイの際に上記の設定ファイルを元にデプロイが実行されます。コードでの設定がある場合、インフラも含め反映されます。

急ぎで、GUIで変更することはあると思います。しかし、GUIだけ変更してソースコードを変更しないと、デプロイの際に戻って事故の原因になります。なので、ソースコードに反映してください。

秘密鍵などのSSM経由で参照される値は、デプロイ時に動的に展開されます。

GitHubからデプロイ

ワークフローの設定：.github/workflows/deploy.yml デプロイの基本設定: decidim-cfj-cdk

  1. ECRにログイン
  2. Dockerコンテナをbuild
  3. short commit hashを含む環境ごとのタグで、ECRにDockerイメージをpush
  4. ECSに該当のイメージを指定してデプロイ

Dockerイメージのタグ例: staging-dfasfste

[デプロイされる環境名]-[commit-hash]

GitHubに必要な環境変数

  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY
  • AWS_ECR_REPO_NAME

デプロイ手順

production

mainブランチに新しい feat: もしくは、fix:のprefixがついたcommitが追加された際に release pleaseがリリース用のPRを作成します。 このリリース用のPRをマージすると、リリースタグが自動で採番され、リリースされます

staging

mainブランチにpushすると自動でデプロイされます。

切り戻し

staging

revertしてmainブランチにpushしてください。

production

deploy同様の手順

CfJ Decidim AWS への Install（cdk 編）

検証環境構築手順

0. decidim-cfj-cdkのリポジトリの準備

手元に decidim-cfj-cdkのリポジトリをクローンし、以下の作業は全てそのディレクトリ以下で行う

1. AWS (Amazon Web Services) へのアクセスする準備

1-1. config/dev.json の作成

dev.json ファイルを作成し、config ディレクトリ下に配置。

1-2. credentials fileの作成

設定ファイルと認証情報ファイルの設定を参考に、credentialsファイルを作成する。

今回は、~/.aws/credentialsに以下のようprofileがdecidimになるよう作成。（違う名前にした場合、以下読み変えが必要です。）

[decidim]
aws_access_key_id=YOUR_ACCESS_KEY
aws_secret_access_key=YOUR_SECRET_ACCESS_KEY

2. SESの設定

Amazon Simple Email Service を設定するや、Setup emailを参考に、AWS SESの準備を行う。

2-1. dev.json を編集する

dev.jsonの’smtpDomain’を用意したドメインに書き換える。

3. パラメータストアに環境変数を登録する

3-1 シークレットの作成

AWS Systems Manager のパラメータストアで以下のようなパラメータを手動で作成する。

  /decidim-cfj/${props.stage}/AWS_ACCESS_KEY_ID
  /decidim-cfj/${props.stage}/AWS_SECRET_ACCESS_KEY
  /decidim-cfj/${props.stage}/AWS_CLOUD_FRONT_END_POINT
  /decidim-cfj/${props.stage}/RDS_DB_NAME
  /decidim-cfj/${props.stage}/RDS_USERNAME
  /decidim-cfj/${props.stage}/RDS_PASSWORD
  /decidim-cfj/${props.stage}/SECRET_KEY_BASE
  /decidim-cfj/${props.stage}/NEW_RELIC_LICENSE_KEY
  /decidim-cfj/${props.stage}/SMTP_ADDRESS
  /decidim-cfj/${props.stage}/SMTP_USERNAME
  /decidim-cfj/${props.stage}/SLACK_API_TOKEN

4. ECRの準備

4-1 プライベートリポジトリを作成する

プライベートリポジトリを作成する を参考に AWS ECRのリポジトリを用意する。

4-2 用意したリポジトリにdecidim の docker imageをpushする

手元の環境で、decidim-cfjのdocker imageをbuildし、 Docker イメージをプッシュするを参考に buildしたdocker imageを用意したリポジトリにpushする。

4-3 tagをexportする

4-2でpushしたdockerイメージのタグをexportする

$ export IMAGE_TAG=先ほどpushしたimage tag

5. 証明書の準備

5-1 任意のドメインをroute53に用意し、aws certificate managerで証明書を発行する

証明書を発行して管理するを参考に証明書を発行、Arnをメモする

5-2 dev.json を編集する

dev.jsonの’certificates’部分にメモしたArnに書き換える。

6. デプロイ

6-1. cdk bootstrap の実行

使用するリージョンごとに一回実行する必要がある。2回目以降は不要。

$ npx cdk --context stage=dev tag=${IMAGE_TAG} --profile decidim bootstrap

6-2. デプロイ前の差分確認

どんなリソースが作成されるのかを確認できる。

$ npx cdk --context stage=dev tag=${IMAGE_TAG} --profile decidim diff

6-3. デプロイ実行

$ npx cdk --context stage=dev tag=${IMAGE_TAG} --profile decidim deploy --all  --require-approval never

上記コマンドが成功すれば、デプロイは成功です。

6-4. デプロイ確認

devdecidimStack とCloudFormationのスタック一覧から検索し、以下のように各StackにCREATE_COMPLETEが表示されていることを確認してください。

7. 初回デプロイ

7.1 環境へのアクセス

$ aws ecs execute-command --region ap-northeast-1 --cluster devDecidimCluster --task ${タスク名} --container appContainer --interactive --command "/bin/bash" --profile decidim

7.2 migrateとseedの実行

$ ./bin/rails db:migrate
$ ./bin/rails db:seed SEED=true

7.3 環境へのアクセス

dev-decidim-alb-origin.${指定したドメイン}で管理画面にアクセス

8. 別のドメインを追加する場合

cloudfrontの代替ドメイン名に対象のドメインを追加

cloudfrontの管理画面に行き作成したcloudfrontの管理画面で代替ドメインに追加したいドメインを加えて保存する

decidimの管理画面にアクセスし、対象の組織にドメインを設定する

設定したい組織にドメインを設定して、対象のドメインいアクセスする

手順を変えるとエラーでアクセスに失敗します。

seedの実行について

decidimではproduction環境のseedは以下のenvをつけて実行する必要があります SEED=true bundle exec rake db:seed