ufo 5.0.7 → 6.0.0

data/docs/utils/test-aws-api-access.rb

@@ -1,11 +0,0 @@
-# usage 'ruby s3-cert-chain-test.rb'
-# see: https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/quick-start-guide.html
-
-require 'aws-sdk-s3' # v2: require 'aws-sdk'
-#Aws.use_bundled_cert!
-
-s3 = Aws::S3::Resource.new(region: 'us-east-1')
-
-s3.buckets.limit(50).each do |b|
-  puts "#{b.name}"
-end

data/docs/utils/update-cert-chains.sh

@@ -1,11 +0,0 @@
-#!/bin/bash
-
-cert_file=$(ruby -ropenssl -e 'puts OpenSSL::X509::DEFAULT_CERT_FILE' 2>/dev/null)
-echo 'What is the uri to your organizations root certificate chain?'
-read -p 'org_root_chain: ' org_root_chain
-echo "$org_root_chain"
-curl "$org_root_chain" -o org_chain.txt
-cat org_chain.txt >> "$cert_file"
-mkdir -p "${cert_file%/*}"
-security find-certificate -a -p /Library/Keychains/System.keychain > "$cert_file"
-security find-certificate -a -p /System/Library/Keychains/SystemRootCertificates.keychain >> "$cert_file"

data/lib/template/.env

@@ -1,3 +0,0 @@
-# fine to have comment in this file
-ADMIN_PASSWORD=secret
-DATABASE_URL=mysql2://user:pass@domain.com:3306/dbname # comment can be at the end too

data/lib/template/.secrets

@@ -1,5 +0,0 @@
-# Example starter secrets file. Be sure that the SSM parameters or Secrets exist.
-# Docs: https://ufoships.com/docs/secrets/
-#
-# NAME1=SSM:parameter_name
-# NAME2=SECRETSMANAGER:secret_name-AbCdEf

data/lib/template/.ufo/iam_roles/execution_role.rb

@@ -1,7 +0,0 @@
-# Example starter execution role. Add the iam role permissions that the host needs here:
-#
-# More docs: https://ufoships.com/docs/iam-roles/
-#
-managed_iam_policy("AmazonSSMReadOnlyAccess")
-managed_iam_policy("SecretsManagerReadWrite")
-managed_iam_policy("service-role/AmazonECSTaskExecutionRolePolicy")

data/lib/template/.ufo/iam_roles/task_role.rb

@@ -1,21 +0,0 @@
-# Example starter task role. Add the iam role permissions that the container needs here:
-#
-# More docs: https://ufoships.com/docs/iam-roles/
-#
-# Examples:
-#
-# iam_policy("AmazonS3ReadOnlyAccess",
-#   Action: [
-#     "s3:Get*",
-#     "s3:List*"
-#   ],
-#   Effect: "Allow",
-#   Resource: "*"
-# )
-# iam_policy("CloudwatchWrite",
-#   Action: [
-#     "cloudwatch:PutMetricData",
-#   ],
-#   Effect: "Allow",
-#   Resource: "*"
-# )

data/lib/template/.ufo/params.yml.tt

@@ -1,27 +0,0 @@
-# These params are passsed to the corresponding aws-sdk ecs client methods.
-# AWS Docs example: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ECS/Client.html#run_task-instance_method
-#
-# The network helper provides access to the .ufo/settings/network/[PROFILE].yml
-#
-# More docs: http://ufoships.com/docs/params/
-
-# ufo task calls run_tasks.
-#
-# ufo task will assign these values appropriately based on the task
-# definition being ran. So generally you should you can leave these settings
-# alone.
-#
-# If it's a Fargate task definition, ufo task automatically adds the
-# network_configuration and launch_type: FARGATE
-# If it's a EC2 task definition with awsvpc network mode, ufo task
-# automatically adds the network_configuration and security groups using
-# the security groups from .ufo/settings/network/default.yml.
-#
-# run_task:
-#   # network_configuration is required for FARGATE
-#   network_configuration:
-#     awsvpc_configuration:
-#       subnets: <%%= network[:ecs_subnets].inspect %> # required
-#       security_groups: <%%= network[:ecs_security_groups].inspect %>
-#       # for fargate use: assign_public_ip: ENABLED
-#       # assign_public_ip: ENABLED # accepts ENABLED, DISABLED

data/lib/template/.ufo/settings/cfn/default.yml.tt

@@ -1,72 +0,0 @@
----
-# Options allow you to customize any resources that ufo creates with
-# CloudFormation. These options are inserting into the generated template.
-# More info: https://ufoships.com/docs/customize-cloudformation
-
-Elb:
-  Scheme: internet-facing
-
-# https://docs.aws.amazon.com/fr_fr/elasticloadbalancing/latest/APIReference/API_CreateTargetGroup.html
-#
-# When using SSL with network elb, the target group protocol is usually http still
-# unless you also handle SSL termination at the app level.
-TargetGroup:
-  Port: 80 # only used with ECS if awsvpc mode
-  # Protocol: TCP # valid values - application elb: HTTP HTTPS, network elb: TCP
-                  # ufo sets defaults in cloudformation template
-                  #   application elb: HTTP
-                  #   network elb: TCP
-                  # so we can keep this commented out, unless we need HTTPS at the app level
-  # Health check settings are supported by application load balancer only:
-  # HealthCheckPath: /up # health check
-  HealthCheckIntervalSeconds: 10 # default: 30. Network ELB can only take 10 or 30
-  HealthyThresholdCount: 2
-  UnhealthyThresholdCount: 2 # default: 10
-  # HealthCheckProtocol: HTTP # HTTP or HTTPS
-  # HealthCheckPort: traffic-port
-  TargetGroupAttributes:
-  - Key: deregistration_delay.timeout_seconds
-    Value: 10
-
-# https://docs.aws.amazon.com/fr_fr/elasticloadbalancing/latest/APIReference/API_CreateListener.html
-#
-# This is the default listener and normally should listen to port 80.
-Listener:
-  Port: 80
-  # For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocol is TCP.
-  # Protocol: TCP # valid values - application elb: HTTP HTTPS, network elb: TCP, TLS
-                  # ufo sets these defaults:
-                  #   application elb: HTTP  # unless port is 443
-                  #   application elb: HTTPS # if port is 443
-                  #   network elb: TCP  # unless port is 443
-                  #   network elb: TLS  # if port is 443
-                  # Can keep protocol commented out,
-                  # unless need to override the defaults.
-  # If using the listener to handle SSL
-  # Certificates:
-  # - CertificateArn: arn:aws:acm:us-east-1:111111111111:certificate/11111111-2222-3333-4444-555555555555
-
-# An optional second listener can be created.
-# If HTTPS and SSL is required then the listener_ssl config is what you should use.
-#   Application ELBs support SSL termination.
-#   Network load balancers do not and must pass the request through to the app
-#   to handle SSL termination.
-#
-# ufo creates an ssl listener when listener_ssl is set.
-# ListenerSsl:
-#   Port: 443
-#   # Certificates:
-#   # - CertificateArn: arn:aws:acm:us-east-1:111111111111:certificate/11111111-2222-3333-4444-555555555555
-#   # Protocol: TCP # valid values - application elb: HTTP HTTPS, network elb: TCP, TLS
-#                   # ufo handles setting the defaults:
-#                   #   application elb: HTTPS
-#                   #   network elb: TLS
-
-# Configure dns to automatically be associated with the ELB dns name.
-# Note, the route53 record set for the domain name must already exist.
-# The {stack_name} variable gets replaced with the name of the CloudFormation stack name.
-# Example: {stack_name} => demo-web
-# Dns:
-#   Name: "{stack_name}.yourdomain."
-#   HostedZoneName: yourdomain. # dont forget the trailing period
-#   TTL: '60' # ttl has special upcase casing

data/lib/template/.ufo/settings/network/default.yml.tt

@@ -1,26 +0,0 @@
----
-vpc: <%= @options[:vpc_id] %>
-ecs_subnets: # required: at least 2 subnets
-<% @options[:ecs_subnets].each do |subnet| -%>
-  - <%= subnet %>
-<% end -%>
-elb_subnets: # defaults to same subnets as ecs_subnets when not set
-<% @options[:elb_subnets].each do |subnet| -%>
-  - <%= subnet %>
-<% end -%>
-
-# Optional additional existing security group ids to add on top of the ones created by ufo.
-# elb_security_groups:
-#   - sg-aaa
-# ecs_security_groups:
-#   - sg-bbb
-#   - sg-ccc
-
-# Also supports extra security groups specific to each ECS service
-# ecs_security_groups:
-#   demo-web:
-#   - sg-bbb
-#   - sg-ccc
-#   demo-worker:
-#   - sg-bbb
-#   - sg-ccc

data/lib/template/.ufo/settings.yml.tt

@@ -1,26 +0,0 @@
-# More info: http://ufoships.com/docs/ufo-settings/
-# The base config is treated special. It gets included the other environments automatically.
-# Yaml also directly supports merging with & and <<* syntax but doing it automatically
-# for a cleaner syntax.
-base:
-  image: <%= @image %>
-  # clean_keep: 30
-  # ecr_keep: 30
-  # network_profile: default # .ufo/settings/network/default.yml file
-  # cfn_profile: default # .ufo/settings/cfn/default.yml file
-  # If you want to have prettier name set for the ECS service name
-  # There are some cavaets with this. Updating properties on resources that require
-  # replacment might not work. For example, adding and removing a load balancer.
-  # In these cases, you must delete the entire ecs service and recreate it.
-  stack_naming: append_ufo_env # new default setting in ufo v5.0.6
-  auto_camelize: false         # new default setting in ufo v5
-
-development:
-  # cluster: development
-  # The aws_profile tightly binds UFO_ENV to AWS_PROFILE and vice-versa.
-  # aws_profile: dev_profile
-
-production:
-  # cluster: production
-  # The aws_profile tightly binds UFO_ENV to AWS_PROFILE and vice-versa.
-  # aws_profile: prod_profile

data/lib/template/.ufo/task_definitions.rb.tt

@@ -1,61 +0,0 @@
-# There some built-in helpers that are automatically available in this file.
-#
-# Some of helpers get data from the Dockerfile and some are from other places.
-# Here's a summary of the some helpers:
-#
-#   helper.full_image_name 
-#   helper.dockerfile_port
-#   helper.env_vars(text)
-#   helper.env_file(path)
-#   helper.current_region
-#
-# More info: http://ufoships.com/docs/helpers/
-#
-<% source_name = @options[:launch_type] == "fargate" ? "fargate" : "main" -%>
-task_definition "<%= @app %>-web" do
-  source "<%= source_name %>" # will use ufo/templates/<%= source_name %>.json.erb
-  variables(
-    family: task_definition_name,
-    name: "web",
-    container_port: helper.dockerfile_port,
-    # Comment out awslogs_* if you do not want logs to be sent to CloudWatch.
-    # Strongly recommended to use CloudWatch/centralized logging.
-    # Ufo automatically creates the log group as part of deployment.
-    #
-    # More info on awslogs settings: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html
-    # The log stream takes the following format:
-    #   prefix-name/container-name/ecs-task-id
-    # Here's an exmaple when you specify the prefix of "demo"
-    #   demo/web/209e93b4-5523-4496-9a27-662fd151eb78
-    awslogs_group: ["ecs/<%= @app %>-web", Ufo.env_extra].compact.join('-'),
-    awslogs_stream_prefix: "<%= @app %>",
-    awslogs_region: helper.current_region,
-    # command: ["bin/web"] # IMPORTANT: change or create a bin/web file
-  )
-end
-
-task_definition "<%= @app %>-worker" do
-  source "<%= source_name %>" # will use ufo/templates/<%= source_name %>.json.erb
-  variables(
-    family: task_definition_name,
-    name: "worker",
-    # Comment out awslogs_* if you do not want logs to be sent to CloudWatch.
-    awslogs_group: ["ecs/<%= @app %>-worker", Ufo.env_extra].compact.join('-'),
-    awslogs_stream_prefix: "<%= @app %>",
-    awslogs_region: helper.current_region,
-    # command: ["bin/worker"] # IMPORTANT: change or create a bin/worker file
-  )
-end
-
-task_definition "<%= @app %>-clock" do
-  source "<%= source_name %>" # will use ufo/templates/<%= source_name %>.json.erb
-  variables(
-    family: task_definition_name,
-    name: "clock",
-    # Comment out awslogs_* if you do not want logs to be sent to CloudWatch.
-    awslogs_group: ["ecs/<%= @app %>-clock", Ufo.env_extra].compact.join('-'),
-    awslogs_stream_prefix: "<%= @app %>",
-    awslogs_region: helper.current_region,
-    # command: ["bin/clock"] # IMPORTANT: change or create a bin/clock file
-  )
-end

data/lib/template/.ufo/templates/fargate.json.erb

@@ -1,39 +0,0 @@
-{
-  "family": "<%= @family %>",
-  "requiresCompatibilities": ["FARGATE"],
-  "networkMode": "awsvpc",
-  "cpu": "<%= @cpu %>",
-  "memory": "<%= @memory %>",
-  "containerDefinitions": [
-    {
-      "name": "<%= @name %>",
-      "image": "<%= @image %>",
-      <% if @container_port %>
-      "portMappings": [
-        {
-          "containerPort": <%= @container_port %>,
-          "protocol": "tcp"
-        }
-      ],
-      <% end %>
-      "command": <%= @command.to_json %>,
-      <% if @environment %>
-      "environment": <%= @environment.to_json %>,
-      <% end %>
-      <% if @secrets %>
-      "secrets": <%= @secrets.to_json %>,
-      <% end %>
-      <% if @awslogs_group %>
-      "logConfiguration": {
-        "logDriver": "awslogs",
-        "options": {
-          "awslogs-group": "<%= @awslogs_group %>",
-          "awslogs-region": "<%= @awslogs_region || 'us-east-1' %>",
-          "awslogs-stream-prefix": "<%= @awslogs_stream_prefix %>"
-        }
-      },
-      <% end %>
-      "essential": true
-    }
-  ]
-}

data/lib/template/.ufo/templates/main.json.erb

@@ -1,43 +0,0 @@
-{
-  "family": "<%= @family %>",
-  "networkMode": "awsvpc",
-  "containerDefinitions": [
-    {
-      "name": "<%= @name %>",
-      "image": "<%= @image %>",
-      "cpu": <%= @cpu %>,
-      <% if @memory %>
-      "memory": <%= @memory %>,
-      <% end %>
-      <% if @memory_reservation %>
-      "memoryReservation": <%= @memory_reservation %>,
-      <% end %>
-      <% if @container_port %>
-      "portMappings": [
-        {
-          "containerPort": <%= @container_port %>,
-          "protocol": "tcp"
-        }
-      ],
-      <% end %>
-      "command": <%= @command.to_json %>,
-      <% if @environment %>
-      "environment": <%= @environment.to_json %>,
-      <% end %>
-      <% if @secrets %>
-      "secrets": <%= @secrets.to_json %>,
-      <% end %>
-      <% if @awslogs_group %>
-      "logConfiguration": {
-        "logDriver": "awslogs",
-        "options": {
-          "awslogs-group": "<%= @awslogs_group %>",
-          "awslogs-region": "<%= @awslogs_region || 'us-east-1' %>",
-          "awslogs-stream-prefix": "<%= @awslogs_stream_prefix %>"
-        }
-      },
-      <% end %>
-      "essential": true
-    }
-  ]
-}

data/lib/template/.ufo/variables/base.rb.tt

@@ -1,19 +0,0 @@
-# Example ufo/variables/base.rb
-# More info on how variables work: http://ufoships.com/docs/variables/
-@image = helper.full_image_name # includes the git sha tongueroo/demo-ufo:ufo-[sha].
-@environment = helper.env_file(".env")
-@secrets = helper.secrets_file(".secrets")
-<% if @options[:launch_type] == "fargate" -%>
-# Ensure that the cpu and memory values are a supported combination by Fargate.
-# More info: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-cpu-memory-error.html"
-<% end -%>
-@cpu = 256
-@memory = 512
-@memory_reservation = 512
-
-<% if @execution_role_arn_input -%>
-@execution_role_arn = "<%= @execution_role_arn_input %>"
-<% else -%>
-# required for fargate
-# @execution_role_arn = "..."
-<% end -%>

data/lib/template/.ufo/variables/development.rb

@@ -1,8 +0,0 @@
-# Example ufo/variables/development.rb
-# More info on how variables work: http://ufoships.com/docs/variables/
-@cpu = 256
-# Refer to https://github.com/tongueroo/ufo/issues/87 as to why the += is used
-@environment += helper.env_vars(%Q[
-  RAILS_ENV=development
-  SECRET_KEY_BASE=secret
-])

data/lib/template/.ufo/variables/production.rb

@@ -1,7 +0,0 @@
-# Example ufo/variables/production.rb
-# More info on how variables work: http://ufoships.com/docs/variables/
-@cpu = 256
-@environment += helper.env_vars(%Q[
-  RAILS_ENV=production
-  SECRET_KEY_BASE=secret
-])

data/lib/template/Dockerfile

@@ -1,15 +0,0 @@
-FROM ruby:2.5.1
-
-WORKDIR /app
-ADD Gemfile /app/Gemfile
-ADD Gemfile.lock /app/Gemfile.lock
-RUN bundle install --system
-
-ADD . /app
-RUN bundle install --system
-
-EXPOSE 4567
-
-# If you do not have a bin/web wrapper file, create one or update this command
-RUN chmod a+x bin/web
-CMD ["bin/web"]

data/lib/template/bin/deploy.tt

@@ -1,7 +0,0 @@
-#!/bin/bash
-
-# Generated starter bin/deploy script example.
-# Meant to be overridden.
-
-# Only build one docker image and deploys it to multiple ECS services
-ufo ships <%= @app %>-{web,clock,worker}

data/lib/ufo/apps/cfn_map.rb

@@ -1,70 +0,0 @@
-class Ufo::Apps
-  class CfnMap
-    extend Memoist
-    include Ufo::Stack::Helper
-
-    def initialize(options = {})
-      @options = options
-      @cluster = @options[:cluster] || default_cluster(options[:service])
-      @map = {}
-    end
-
-    # Example:
-    #   {"development-demo-web-Ecs-1L3WUTJFFM5JV"=>"demo-web"}
-    def map
-      return @map if @populated
-
-      populate_map!
-      @populated = true
-      @map
-    end
-
-    def summaries
-      filter = %w[
-        UPDATE_COMPLETE
-        CREATE_COMPLETE
-        UPDATE_ROLLBACK_COMPLETE
-        UPDATE_IN_PROGRESS
-        UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
-        UPDATE_ROLLBACK_IN_PROGRESS
-        UPDATE_ROLLBACK_FAILED
-        UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
-        REVIEW_IN_PROGRESS
-      ]
-
-      summaries = []
-      next_token = true
-      while next_token
-        resp = cloudformation.list_stacks(stack_status_filter: filter)
-        summaries += resp.stack_summaries
-        next_token = resp.next_token
-      end
-
-      # look for stacks that beling that ufo create
-      summaries.select do |s|
-        s.template_description =~ /Ufo ECS stack/
-      end
-    end
-    memoize :summaries
-
-    def populate_map!
-      threads = []
-      summaries.each do |summary|
-        threads << Thread.new do
-          resp = cloudformation.describe_stack_resources(stack_name: summary.stack_name)
-          ecs_resource = resp.stack_resources.find do |resource|
-            resource.logical_resource_id == "Ecs"
-          end
-          # Example: "PhysicalResourceId": "arn:aws:ecs:us-east-1:111111111111:service/dev-demo-web-Ecs-1HRL8Y9F4D1CR"
-          ecs_service_name = ecs_resource.physical_resource_id.split('/').last
-          @map[ecs_service_name] = stack_name_to_service_name(summary.stack_name)
-        end
-      end
-      threads.map(&:join)
-    end
-
-    def stack_name_to_service_name(stack_name)
-      stack_name.sub("#{@cluster}-",'')
-    end
-  end
-end

data/lib/ufo/apps/cluster.rb

@@ -1,24 +0,0 @@
-class Ufo::Apps
-  class Cluster
-    def self.all
-      new.all
-    end
-
-    def all
-      Ufo.check_ufo_project!
-      clusters = if settings[:service_cluster]
-        settings[:service_cluster].values
-      elsif settings[:cluster]
-        settings[:cluster]
-      else
-        Ufo.env
-      end
-      [clusters].flatten.compact
-    end
-
-  private
-    def settings
-      @settings ||= Ufo.settings
-    end
-  end
-end

data/lib/ufo/apps/service.rb

@@ -1,56 +0,0 @@
-class Ufo::Apps
-  class Service
-    extend Memoist
-
-    def initialize(service, options)
-      @service = service
-      @options = options
-    end
-
-    def to_a
-      [name, task_definition, running, launch_type, ufo?]
-    end
-
-    def task_definition
-      @service["task_definition"].split('/').last
-    end
-
-    def launch_type
-      @service["launch_type"]
-    end
-
-    def cfn_map
-      @cfn_map ||= CfnMap.new(@options).map
-    end
-
-    def ufo?
-      yes = !!cfn_map[@service["service_name"]]
-      yes ? "yes" : "no"
-    end
-
-    def name
-      actual_service_name = @service["service_name"]
-      pretty_name = cfn_map[actual_service_name]
-      if pretty_name
-        "#{actual_service_name} (#{pretty_name})"
-      else
-        actual_service_name
-      end
-    end
-
-    def running
-      @service["running_count"]
-    end
-
-    def dns
-      return 'dns' if ENV['TEST']
-      elb = info.load_balancer(@service)
-      elb.dns_name if elb
-    end
-
-    def info
-      Ufo::Info.new(@service)
-    end
-    memoize :info
-  end
-end

data/lib/ufo/apps.rb

@@ -1,56 +0,0 @@
-require 'text-table'
-
-module Ufo
-  class Apps
-    extend Memoist
-    include Stack::Helper
-
-    def initialize(options)
-      @options = options
-      @clusters = @options[:cluster] || @options[:clusters]
-      @clusters = [@clusters].flatten.compact
-      if @clusters.empty?
-        @clusters = Cluster.all
-      end
-    end
-
-    def list_all
-      @clusters.each do |cluster|
-        list(cluster)
-      end
-    end
-
-    def list(cluster)
-      begin
-        resp = ecs.list_services(cluster: cluster)
-      rescue Aws::ECS::Errors::ClusterNotFoundException => e
-        puts "ECS cluster #{cluster.color(:green)} not found."
-        return
-      end
-      arns = resp.service_arns.sort
-
-      puts "Listing ECS services in the #{cluster.color(:green)} cluster."
-      if arns.empty?
-        puts "No ECS services found in the #{cluster.color(:green)} cluster."
-        return
-      end
-
-      resp = ecs.describe_services(services: arns, cluster: cluster)
-      display_info(resp)
-    end
-
-    def display_info(resp)
-      table = Text::Table.new
-      table.head = ["Service Name", "Task Definition", "Running", "Launch type", "Ufo?"]
-      resp["services"].each do |s|
-        table.rows << service_info(s)
-      end
-      puts table unless ENV['TEST']
-    end
-
-    # for specs
-    def service_info(s)
-      Service.new(s, @options).to_a
-    end
-  end
-end

data/lib/ufo/aws_service.rb

@@ -1,36 +0,0 @@
-require "aws-sdk-cloudformation"
-require "aws-sdk-cloudwatchlogs"
-require "aws-sdk-ec2"
-require "aws-sdk-ecr"
-require "aws-sdk-ecs"
-require "aws-sdk-elasticloadbalancingv2"
-
-require "aws_mfa_secure/ext/aws" # add MFA support
-
-module Ufo
-  module AwsService
-    def cloudformation
-      @cloudformation ||= Aws::CloudFormation::Client.new
-    end
-
-    def cloudwatchlogs
-      @cloudwatchlogs ||= Aws::CloudWatchLogs::Client.new
-    end
-
-    def ec2
-      @ec2 ||= Aws::EC2::Client.new
-    end
-
-    def ecr
-      @ecr ||= Aws::ECR::Client.new
-    end
-
-    def ecs
-      @ecs ||= Aws::ECS::Client.new
-    end
-
-    def elb
-      @elb ||= Aws::ElasticLoadBalancingV2::Client.new
-    end
-  end
-end