Merge pull request #271 from codeforjapan/develop

ayuki-joto · web-flow · commit 05e178bd1506 · 2021-08-07T02:02:35.000+09:00
update some Development Implements
diff --git a/.cloudformation/cloud_front.yml b/.cloudformation/cloud_front.yml
diff --git a/.cloudformation/vpc_subnets.yml b/.cloudformation/vpc_subnets.yml
@@ -0,0 +1,116 @@
+Parameters:
+  AppEnvironment:
+    Description: Type of app environment.
+    Type: String
+    Default: staging
+    AllowedValues:
+      - staging
+      - production
+
+Resources:
+  PublicVPC:
+    Type: 'AWS::EC2::VPC'
+    Properties:
+      CidrBlock: 172.31.0.0/16
+      EnableDnsHostnames: true
+      EnableDnsSupport: true
+      Tags:
+        - Key: Name
+          Value: !Sub ${AppEnvironment}-decidim-vpc
+  PublicSubnet1:
+    Type: 'AWS::EC2::Subnet'
+    Properties:
+      VpcId: !Ref PublicVPC
+      AvailabilityZone:
+        Fn::Select:
+         - 0
+         - Fn::GetAZs: ""
+      CidrBlock: 172.31.0.0/24
+      MapPublicIpOnLaunch: true
+      Tags:
+        - Key: Name
+          Value: !Sub ${AppEnvironment}-decidim-subnet1
+  PublicSubnet2:
+    Type: 'AWS::EC2::Subnet'
+    Properties:
+      AvailabilityZone:
+        Fn::Select:
+         - 1
+         - Fn::GetAZs: ""
+      VpcId: !Ref PublicVPC
+      CidrBlock: 172.31.1.0/24
+      MapPublicIpOnLaunch: true
+      Tags:
+        - Key: Name
+          Value: !Sub ${AppEnvironment}-decidim-subnet2
+  PublicSubnet3:
+    Type: 'AWS::EC2::Subnet'
+    Properties:
+      AvailabilityZone:
+        Fn::Select:
+         - 2
+         - Fn::GetAZs: ""
+      VpcId: !Ref PublicVPC
+      CidrBlock: 172.31.2.0/24
+      MapPublicIpOnLaunch: true
+      Tags:
+        - Key: Name
+          Value: !Sub ${AppEnvironment}-decidim-subnet3
+  InternetGateway:
+    Type: 'AWS::EC2::InternetGateway'
+    Properties:
+      Tags:
+        - Key: Name
+          Value: !Sub ${AppEnvironment}-decidim-internet-gateway
+  GatewayToInternet:
+    Type: 'AWS::EC2::VPCGatewayAttachment'
+    Properties:
+      VpcId: !Ref PublicVPC
+      InternetGatewayId: !Ref InternetGateway
+  PublicRouteTable:
+    Type: 'AWS::EC2::RouteTable'
+    Properties:
+      VpcId: !Ref PublicVPC
+  PublicRoute:
+    Type: 'AWS::EC2::Route'
+    DependsOn: GatewayToInternet
+    Properties:
+      RouteTableId: !Ref PublicRouteTable
+      DestinationCidrBlock: 0.0.0.0/0
+      GatewayId: !Ref InternetGateway
+  PublicSubnet1RouteTableAssociation:
+    Type: 'AWS::EC2::SubnetRouteTableAssociation'
+    Properties:
+      SubnetId: !Ref PublicSubnet1
+      RouteTableId: !Ref PublicRouteTable
+  PublicSubnet2RouteTableAssociation:
+    Type: 'AWS::EC2::SubnetRouteTableAssociation'
+    Properties:
+      SubnetId: !Ref PublicSubnet2
+      RouteTableId: !Ref PublicRouteTable
+  PublicSubnet3RouteTableAssociation:
+    Type: 'AWS::EC2::SubnetRouteTableAssociation'
+    Properties:
+      SubnetId: !Ref PublicSubnet3
+      RouteTableId: !Ref PublicRouteTable
+Outputs:
+  PublicVPCID:
+    Description: VPC ID
+    Value: !Ref "PublicVPC"
+    Export:
+      Name: BeanstalkPublicVPCID
+  PublicSubnet1ID:
+    Description: Public Subnet A ID
+    Value: !Ref "PublicSubnet1"
+    Export:
+      Name: BeanstalkPublicVPCSubnet1ID
+  PublicSubnet2ID:
+    Description: Public Subnet B ID
+    Value: !Ref "PublicSubnet2"
+    Export:
+      Name: BeanstalkPublicVPCSubnet2ID
+  PublicSubnet3ID:
+    Description: Public Subnet C ID
+    Value: !Ref "PublicSubnet3"
+    Export:
+      Name: BeanstalkPublicVPCSubnet3ID
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -119,7 +119,7 @@ jobs:
           ECR_REPOSITORY: ${{ secrets.AWS_ECR_REPO_NAME }}
         run: |
           cd deployments
-          cp ${EB_ENVIRONMENT_NAME}/00_options.config .ebextensions/00_options.config
+          cp ${EB_ENVIRONMENT_NAME}/*.config .ebextensions/
           sed -i -e "s|{RepositoryName}|$ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG|g" docker-compose.yml
           sed -i -e "s|{EBEnvironment}|$EB_ENVIRONMENT_NAME|g" docker-compose.yml
           eb deploy ${EB_ENVIRONMENT_NAME} --timeout=20 --process
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Change Log
 
+## [v0.23.0-2021-06-22](https://github.com/codeforjapan/decidim-cfj/releases/tag/v0.23.0-2021-06-22)
+
+### Developer improvements
+
+- update ecr lifecycle policy to expire old tag [#243](https://github.com/codeforjapan/decidim-cfj/pull/243)
+- enabled auto eb platform update on staging [#242](https://github.com/codeforjapan/decidim-cfj/pull/242)
+- decrease sidekiq worker 6 -> 3 [#244](https://github.com/codeforjapan/decidim-cfj/pull/244)
+- add sidkiq&nginx docker image on eb [#235](https://github.com/codeforjapan/decidim-cfj/pull/235)
+- Add Changelog (CHANGELOG.md) [#238](https://github.com/codeforjapan/decidim-cfj/pull/238)
+
 ## [v0.23.0-2021-5-31](https://github.com/codeforjapan/decidim-cfj/releases/tag/v0.23.0-2021-5-31)
 
 ### Fixed
diff --git a/DEPLOYMENT.md b/DEPLOYMENT.md
@@ -13,10 +13,18 @@ production: [deployments/production](deployments/production)
 
 急ぎで、GUIで変更することはあると思います。しかし、GUIだけ変更してソースコードを変更しないと、デプロイの際に戻って事故の原因になります。なので、ソースコードに反映してください。
 
-現状、認証情報等の非公開情報の設定方法が検討中なので、環境変数だけはGUIから設定してください。
-
 GUIの設定とコードの書き方は、[公式](https://docs.aws.amazon.com/ja_jp/elasticbeanstalk/latest/dg/command-options-general.html#command-options-general-elasticbeanstalkapplicationenvironment)を参考にしてください。
 
+環境変数は環境別に設定する値だけ、[deployments/production/00_env_options.config](deployments/production/00_env_options.config) or [deployments/staging/00_env_options.config](deployments/staging/00_env_options.config)に記載して下さい。
+
+秘密鍵などのSSM経由で参照される値は、デプロイ時に動的に展開されます。
+
+```
+{{resolve:ssm:ssmのパラメータの名前:バージョン}}
+```
+
+https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/dynamic-references.html
+
 # GitHubからデプロイ
 
 ワークフローの設定：[.github/workflows/deploy.yml](.github/workflows/deploy.yml)
@@ -100,12 +108,12 @@ bundle install
 ```bash
 cd deployments
 
-// production
-cp deployments/production/00_options.config .ebextensions/00_options.config
-// staging(台数とかログの保持期間が小さい)
-cp deployments/staging/00_options.config .ebextensions/00_options.config
+# production
+cp production/*.config .ebextensions/
+# staging(台数とかログの保持期間が小さい)
+cp staging/*.config .ebextensions/
 
-eb create production
+eb create production --process
 ```
 
 最後エラーで終わるがOK
@@ -143,9 +151,7 @@ Elastic Beanstalk のインスタンスをAレコードとして割り当てる
 
 sidekiqの設定をする必要はありません。dockerでデプロイされています。
 
-stagingはcloud formationで作成しています。
-
-[.cloudformation/elastic_cache.yml](.cloudformation/elastic_cache.yml)
+stagingはcloud formationで作成しています。 [./INFRA.md###redis](./INFRA.md###redis)
 
 ## 10. S3 の設定をする
 
diff --git a/INFRA.md b/INFRA.md
@@ -0,0 +1,58 @@
+# Cloud Formation の使い方
+
+AWS の code as a infrastructureサービスCloud Formationで、インフラストラクチャを構築しています。
+
+コードに落とすとこで、レビューやバージョン管理が可能。またAWSコンソール上で、手動での変更検知などAWSに最適化されています。
+
+これにより、本番とstagingの環境を簡単に揃えられます。
+
+テンプレートファイルは、[./cloudformation](./cloudformation)にまとめます。1テンプレートに多くのリソースを含むと、変更が大きくなるので分割して作成してください。
+
+## VPC & Subnets
+
+下記を参考に作成しています。VPC 1つ、public Subnet 3です。
+https://github.com/awsdocs/elastic-beanstalk-samples/blob/main/cfn-templates/vpc-public.yaml
+
+### template file
+
+[.cloudformation/vpc_subnets.yml](.cloudformation/vpc_subnets.yml)
+
+### Stack Name
+
+- staging-decidim-app-cloud-front
+
+## redis
+
+シンプルに本体を作成するだけです。サブネットグループ等は現状手動作成となります。
+
+### template file
+
+[.cloudformation/elastic_cache.yml](.cloudformation/elastic_cache.yml)
+
+### Stack Name
+
+- staging-decidim-redis
+
+## cloud Front
+
+キャッシュポリシーとクラウドフロント本体を作成します。
+
+### template file
+
+[.cloudformation/cloud_front.yml] (.cloudformation/cloud_front.yml)
+
+### Stack Name
+
+- staging-decidim-app-cloud-front
+
+## ECR
+
+staging用と本番は同じレポジトリです。Dockerイメージのタグで区別します。
+
+### template file
+
+[.cloudformation/ecr.yml](.cloudformation/ecr.yml)
+
+### Stack Name
+
+- decidim-cfj-ecr-repository
diff --git a/config/environments/production.rb b/config/environments/production.rb
@@ -73,7 +73,7 @@
 
   # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
   # the I18n.default_locale when a translation cannot be found).
-  config.i18n.fallbacks = true
+  config.i18n.fallbacks = [:ja, :en]
 
   # Send deprecation notices to registered listeners.
   config.active_support.deprecation = :notify
diff --git a/config/locales/ja.yml b/config/locales/ja.yml
@@ -73,6 +73,9 @@ ja:
           connect_your_account_html: "<strong>%{organization}</strong> にログインしてアカウントに接続します"
     endorsement_buttons_cell:
       already_endorsed: 支持済み
+    errors:
+      not_found:
+        content_doesnt_exist: このアドレスは正しくないか削除されています。
     events:
       comments:
         comment_by_followed_user:
@@ -84,6 +87,13 @@ ja:
           email_outro: '"%{resource_title}" 、またはその参加者をフォローしているためこの通知を受け取りました。前のリンクからフォローを解除することができます。'
           email_subject: "%{author_name} から %{resource_title} に対して新しいコメントがあります"
           notification_title: <a href="%{author_path}">%{author_name} %{author_nickname}</a> から <a href="%{resource_path}">%{resource_title} に対して新しいコメントがあります</a>
+      debates:
+        debate_closed:
+          follower:
+            email_intro: '「%{resource_title}」のディベートは終了しました。そのページから結論を読むことができます。'
+            email_outro: '%{resource_title} をフォローしているため、この通知を受け取りました。前のリンクから通知の受信を停止することができます。'
+            email_subject: '「%{resource_title}」のディベートは終了しました'
+            notification_title: <a href="%{resource_path}">%{resource_title}</a> のディベートは終了しました。
       gamification:
         badge_earned:
           email_outro: サイトでの活動によって、この通知を受け取りました。
diff --git a/config/newrelic.yml b/config/newrelic.yml
@@ -29,6 +29,8 @@ common: &default_settings
 
   log_file_path: STDOUT
 
+  monitor_mode: false
+
 
 # Environment-specific settings are in this section.
 # RAILS_ENV or RACK_ENV (as appropriate) is used to determine the environment.
@@ -40,11 +42,11 @@ development:
 test:
   <<: *default_settings
   # It doesn't make sense to report to New Relic from automated test runs.
-  monitor_mode: false
 
 staging:
   <<: *default_settings
   app_name: <%= ENV["NEW_RELIC_APP_NAME"] %> (Staging)
 
 production:
   <<: *default_settings
+  monitor_mode: true
diff --git a/deployments/.ebextensions/02_common_options.config b/deployments/.ebextensions/02_common_options.config
@@ -12,7 +12,7 @@ option_settings:
   "aws:autoscaling:trigger":
     LowerThreshold: 30
     MeasureName: CPUUtilization
-    Statistic: Maximum
+    Statistic: Average
     Unit: Percent
     UpperThreshold: 60
   "aws:elasticbeanstalk:environment":
diff --git a/deployments/docker-compose.yml b/deployments/docker-compose.yml
@@ -22,15 +22,15 @@ services:
     volumes:
       - static-public:/app/public
     environment:
-      NEW_RELIC_APP_NAME: decidem-app({EBEnvironment})
+      NEW_RELIC_APP_NAME: decidim-app({EBEnvironment})
     env_file:
       - .env
 
   sidekiq:
     image: "{RepositoryName}"
     command: bundle exec sidekiq -C /app/config/sidekiq.yml
     environment:
-      NEW_RELIC_APP_NAME: decidem-sidekiq({EBEnvironment})
+      NEW_RELIC_APP_NAME: decidim-sidekiq({EBEnvironment})
     env_file:
       - .env
 
diff --git a/deployments/production/00_env_options.config b/deployments/production/00_env_options.config
@@ -0,0 +1,17 @@
+option_settings:
+  "aws:elasticbeanstalk:application:environment":
+    AWS_ACCESS_KEY_ID: "{{resolve:ssm:/decidim-cfj/production/AWS_ACCESS_KEY_ID:1}}"
+    AWS_SECRET_ACCESS_KEY: "{{resolve:ssm:/decidim-cfj/production/AWS_SECRET_ACCESS_KEY:1}}"
+    REDIS_URL: "{{resolve:ssm:/decidim-cfj/production/REDIS_URL:1}}"
+    RDS_DB_NAME: "{{resolve:ssm:/decidim-cfj/production/RDS_DB_NAME:1}}"
+    RDS_HOSTNAME: "{{resolve:ssm:/decidim-cfj/production/RDS_HOSTNAME:1}}"
+    RDS_USERNAME: "{{resolve:ssm:/decidim-cfj/production/RDS_USERNAME:1}}"
+    RDS_PASSWORD: "{{resolve:ssm:/decidim-cfj/production/RDS_PASSWORD:1}}"
+    SECRET_KEY_BASE: "{{resolve:ssm:/decidim-cfj/production/SECRET_KEY_BASE:1}}"
+    NEW_RELIC_LICENSE_KEY: "{{resolve:ssm:/decidim-cfj/production/NEW_RELIC_LICENSE_KEY:1}}"
+    SMTP_USERNAME: "{{resolve:ssm:/decidim-cfj/production/SMTP_USERNAME:1}}"
+    SMTP_PASSWORD: "{{resolve:ssm:/decidim-cfj/production/SMTP_PASSWORD:1}}"
+    SMTP_ADDRESS: email-smtp.us-east-1.amazonaws.com
+    SMTP_DOMAIN: diycities.jp
+    AWS_BUCKET_NAME: cfj-decidim
+    RAILS_SKIP_MIGRATIONS: false
diff --git a/deployments/staging/00_env_options.config b/deployments/staging/00_env_options.config
@@ -0,0 +1,17 @@
+option_settings:
+  "aws:elasticbeanstalk:application:environment":
+    AWS_ACCESS_KEY_ID: "{{resolve:ssm:/decidim-cfj/staging/AWS_ACCESS_KEY_ID:1}}"
+    AWS_SECRET_ACCESS_KEY: "{{resolve:ssm:/decidim-cfj/staging/AWS_SECRET_ACCESS_KEY:1}}"
+    NEW_RELIC_AGENT_ENABLED: false
+    REDIS_URL: "{{resolve:ssm:/decidim-cfj/staging/REDIS_URL:1}}"
+    RDS_DB_NAME: "{{resolve:ssm:/decidim-cfj/staging/RDS_DB_NAME:2}}"
+    RDS_HOSTNAME: "{{resolve:ssm:/decidim-cfj/staging/RDS_HOSTNAME:1}}"
+    RDS_USERNAME: "{{resolve:ssm:/decidim-cfj/staging/RDS_USERNAME:1}}"
+    RDS_PASSWORD: "{{resolve:ssm:/decidim-cfj/staging/RDS_PASSWORD:1}}"
+    SECRET_KEY_BASE: "{{resolve:ssm:/decidim-cfj/staging/SECRET_KEY_BASE:1}}"
+    SMTP_USERNAME: "{{resolve:ssm:/decidim-cfj/production/SMTP_USERNAME:1}}"
+    SMTP_PASSWORD: "{{resolve:ssm:/decidim-cfj/production/SMTP_PASSWORD:1}}"
+    SMTP_ADDRESS: email-smtp.us-east-1.amazonaws.com
+    SMTP_DOMAIN: diycities.jp
+    AWS_BUCKET_NAME: staging-cfj-decidim
+    RAILS_SKIP_MIGRATIONS: false
diff --git a/deployments/staging/00_options.config b/deployments/staging/00_options.config
@@ -3,7 +3,10 @@ option_settings:
     MinSize: 1
     MaxSize: 2
   "aws:ec2:instances":
+    EnableSpot: true
     InstanceTypes: t2.small
+    SpotFleetOnDemandBase: 0
+    SpotMaxPrice: 0.1
   "aws:elasticbeanstalk:cloudwatch:logs":
     StreamLogs: true
     DeleteOnTerminate: true
diff --git a/ebextensions_sample/04_options.config.sample b/ebextensions_sample/04_options.config.sample
