elastic_beans 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb92ef373018a6f507082e86909372817ddd7042
-  data.tar.gz: 49eb178cbdad8e93930afa6998577588093d7994
+  metadata.gz: 2b231170798c366604081d7d0800c0c332a386d6
+  data.tar.gz: 661c9aca9b2ae4fdc6402cd02c5b3d37c4f62d76
 SHA512:
-  metadata.gz: e8b5a831464781d60d79e18c66c723a361d02c597b1e5cea19ed059e62ab70ce8be4f1a80fa4154d37455b7d4e455e409b833d50ccf198e77c600ca2a7148db9
-  data.tar.gz: eb62d218f9ab435ff4d90beb9e8f209ddedcf289e981cd09302bc4390763a2a7b1c90d9d0acab694f3deeeefc64c6ad15fa98f1eab0f33fc7ea7c305f8d8baed
+  metadata.gz: 71da843ae45cfac1cf6fa2061df76383849d16cdb359c1ff7145975c25042ca8985d7501b2e57d09d2968d4b8b0246cf40f89ef73d98b6a165b4cb15ae17f8fa
+  data.tar.gz: 928d9e71798950eb693d0a9ad4a9ac720ca48e56de71b8cf074d0fd409e2c957119d2dd83fcc6dd8b757ef122e08bda185ff25fad6dacddedcf5db7d327bbfb0

data/README.md

@@ -19,9 +19,10 @@ As the SDK documentation suggests, using environment variables is recommended.
 [configuration]: http://docs.aws.amazon.com/sdk-for-ruby/latest/DeveloperGuide/aws-ruby-sdk-getting-started.html#aws-ruby-sdk-configuration
 
     # Pre-configure the application before creating environments
-    # Rails will not start without DATABASE_URL and SECRET_TOKEN_BASE
-    export DATABASE_URL=mysql2://... SECRET_KEY_BASE=abc123...
-    beans configure -n myapp-networking -a myapp -k KEYPAIR -s SSL_CERTIFICATE_ID [-i IMAGE_ID] [-t INSTANCE_TYPE] [-l LOGGING_HTTP_ENDPOINT]
+    beans configure -n myapp-networking -a myapp \
+      -b SECRET_KEY_BASE -d DATABASE_URL -k KEYPAIR \
+      -p INTERNAL_PUBLIC_KEY -s SSL_CERTIFICATE_ARN \
+      [-i IMAGE_ID] [-t INSTANCE_TYPE] [-l LOGGING_HTTP_ENDPOINT]
 
     # Create a webserver environment with a pretty DNS name at myapp.TLD (managed by Route53)
     beans create -a myapp [-d myapp.TLD] [--tags=Environment:production Team:Unicorn] webserver
@@ -41,25 +42,27 @@ As the SDK documentation suggests, using environment variables is recommended.
     # Set environment variables across all environments
     beans setenv -a myapp REDIS_URL=redis://...
 
-    # Deploy the HEAD git commit to all environments
-    # Creates an application version named after the git ref
+    # Create an application version for the HEAD git commit in the working directory.
+    # Then deploy that version to each running environment.
     beans deploy -a myapp
 
-    # Run one-off tasks
+    # Run one-off tasks and upload logs to the LOGGING_HTTP_ENDPOINT from `configure`
     beans exec -a myapp rake db:migrate
 
     # Update all existing environments and configuration
-    beans configure -n myapp-networking -a myapp [-k KEYPAIR] [-s SSL_CERTIFICATE_ID] [-i IMAGE_ID] [-t INSTANCE_TYPE]
+    beans configure -n myapp-networking -a myapp \
+      [-b SECRET_KEY_BASE] [-d DATABASE_URL] [-k KEYPAIR] \
+      [-p INTERNAL_PUBLIC_KEY] [-s SSL_CERTIFICATE_ARN] \
+      [-i IMAGE_ID] [-t INSTANCE_TYPE] [-l LOGGING_HTTP_ENDPOINT]
 
 ### API
 
-    app = ElasticBeans::Application.new(
-      name: "myapp",
-      cloudformation: Aws::CloudFormation::Client.new,
-      elastic_beanstalk: Aws::ElasticBeanstalk::Client.new,
-      s3: Aws::S3::Client.new,
-    )
-    app.exec_command("rake db:migrate", sqs: Aws::SQS::Client.new)
+Elastic Beans exposes the classes it uses to manage Elastic Beanstalk so you can call them from your own code.
+[Check out the API documentation][api].
+
+[api]: http://www.rubydoc.info/gems/elastic_beans
+
+AWS SDK clients must be passed into Elastic Beans constructors.
 
 ### Periodic tasks
 
@@ -81,6 +84,7 @@ In `config/initializers/elastic_beans.rb`, add the middleware into your stack, b
           name: "myapp",
           cloudformation: Aws::CloudFormation::Client.new,
           elastic_beanstalk: Aws::ElasticBeanstalk::Client.new,
+          s3: Aws::S3::Client.new,
         ),
         sqs: Aws::SQS::Client.new,
         logger: Rails.logger,
@@ -92,6 +96,7 @@ In `config/initializers/elastic_beans.rb`, add the middleware into your stack, b
           name: "myapp",
           cloudformation: Aws::CloudFormation::Client.new,
           elastic_beanstalk: Aws::ElasticBeanstalk::Client.new,
+          s3: Aws::S3::Client.new,
         ),
         sqs: Aws::SQS::Client.new,
         logger: Rails.logger,
@@ -135,6 +140,12 @@ This way they can be computationally expensive without affecting application per
 Additionally, they are not limited to the visibility timeout of an application background job queue.
 Logs are persisted to an HTTPS endpoint upon command completion.
 
+### Persistent configuration
+
+Elastic Beans stores your configuration in configuration templates.
+This means that you can terminate and create an environment and it will remember its setup from before.
+In addition, changes to the configuration will affect existing and future environments.
+
 ### Shared code between environments
 
 A Rails app supports multiple contexts with the same codebase.
@@ -155,7 +166,7 @@ The settings for your application are discovered from the [outputs of these Clou
 
 The networking stack can be shared between many applications, but each application should have its own application stack.
 For example, you might create separate "eb-development" and "eb-production" network stacks.
-Then, create an Elastic Beanstalk application from a stack named "myapp."
+Then, create an Elastic Beanstalk application named "myapp" from a stack named "myapp."
 Finally, you can set it up with beans:
 
     $ beans configure -n eb-development -a myapp ...
@@ -186,19 +197,83 @@ Elastic Beans will use the default names: `aws-elasticbeanstalk-ec2-role` and `a
 ### Application
 
 Your Elastic Beanstalk application must already exist and also be created using CloudFormation.
+The Elastic Beanstalk application name and CloudFormation stack name must be identical.
 Its details will be discovered from the following outputs:
 
 * `ExecQueueUrl`
 * `Worker[Name]QueueUrl`
 
 Where a separate worker environment will be configured for each queue `[Name]` that appears.
-The `Default` name must be present.
+A default worker queue, i.e. `WorkerDefaultQueueUrl`, must exist.
 
 ### Code
 
 Your application must use the [active-elastic-job gem](https://github.com/tawan/active-elastic-job) for background job processing.
 Elastic Beans will set the `DISABLE_SQS_CONSUMER` environment variable appropriately in your environments.
 
+### Known issues and limitations of the pre-release
+
+Elastic Beans still has some rough edges that need to be worked out.
+
+#### Authentication with AWS uses environment variables
+
+Use the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables to authenticate with the AWS SDK.
+
+#### Changes to the configuration in the AWS console are not persistent
+
+Changing configuration in the AWS console will work fine, but if the setting is also saved in a configuration template it will be overwritten the next time you run `beans configure`.
+
+#### Creating multiple environments simultaneously causes sample application to be deployed
+
+Due to a bug in the version-finding code, creating multiple environments simultaneously can cause a sample application to be deployed to one of them (an empty version label).
+
+#### End-to-end encryption requires some custom setup
+
+Currently (pre-1.0), you must set up HTTPS yourself in nginx using an ebextension.
+Use whatever certificate you like to do so, even a self-signed certificate is fine.
+Use the public key from this certificate as the `--public-key` option to `beans configure`.
+
+#### Environment variables are mostly hidden
+
+`beans setenv` sets environment variables in S3, but there's no way to *get* them.
+
+#### Environment variables are not access-controlled
+
+Environment variables are stored in plain-text in S3.
+Anyone with access to the Elastic Beanstalk bucket (for instance, the Elastic Beanstalk instance profile) can read the environment variables.
+
+#### Rate limiting
+
+Running several beans tasks concurrently can cause Elastic Beanstalk rate-limiting on the AWS account.
+
+#### SIGINT causes a stack trace
+
+Sorry `¯\_(ツ)_/¯`
+
+#### Solution stack is hard-coded
+
+If you do not use a custom image, the solution stack will start as a hard-coded value.
+It will also be up to you to update it.
+
+#### Uses default Elastic Beanstalk IAM settings and S3 bucket
+
+Elastic Beans looks for [the default Elastic Beanstalk IAM instance profile and service role][iam].
+As the linked document explains, the easiest way to create them is to create a sample application in the AWS console.
+
+Creating the sample application should also create the default Elastic Beanstalk S3 bucket, which has a name of the form `elasticbeanstalk-REGION-ACCOUNT_ID`.
+Elastic Beans will use this bucket to store application versions and environment variables.
+
+[iam]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts-roles.html
+
+#### Worker environment health check requires some custom setup
+
+Elastic Beanstalk worker environments (aws-sqsd) must use a non-SSL health check.
+Your Rails application must implement this as a middleware (or lower in the stack) before Rails enforces SSL.
+
+#### Worker environment visibility timeout is hard-coded
+
+1800 seconds is the longest it can be.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/exe/beans

@@ -8,27 +8,33 @@ require "elastic_beans/command"
 require "elastic_beans/ui"
 
 class ElasticBeans::CLI < Thor
+  APPLICATION_DESC = "The name of the Elastic Beanstalk application and CloudFormation stack that contains application settings"
+
   class_option :verbose, type: :boolean, aliases: %w(-v)
 
   desc ElasticBeans::Command::Configure::USAGE, ElasticBeans::Command::Configure::DESC
   long_desc ElasticBeans::Command::Configure::LONG_DESC
-  option :application, aliases: %w(-a), required: true
-  option :network, aliases: %w(-n), required: true
-  option :image_id, aliases: %w(-i)
-  option :instance_type, aliases: %w(-t)
-  option :keypair, aliases: %w(-k)
-  option :logging_endpoint, aliases: %w(-l)
-  option :public_key, aliases: %w(-p)
-  option :ssl_certificate_id, aliases: %w(-s)
+  option :application, aliases: %w(-a), required: true, desc: APPLICATION_DESC
+  option :network, aliases: %w(-n), required: true, desc: "The name of the CloudFormation stack that contains networking settings"
+  option :database_url, aliases: %w(-d), desc: "The DATABASE_URL for the Rails application"
+  option :image_id, aliases: %w(-i), desc: "A custom AMI to use instead of the default Ruby Elastic Beanstalk AMI"
+  option :instance_type, aliases: %w(-t), desc: "A default instance type to use for all environments instead of c4.large"
+  option :keypair, aliases: %w(-k), desc: "Required on first run. The EC2 keypair to use for Elastic Beanstalk instances"
+  option :logging_endpoint, aliases: %w(-l), desc: "An HTTP endpoint that can receive logs from one-off commands"
+  option :public_key, aliases: %w(-p), desc: "For end-to-end encryption. The public key of the SSL certificate the ELB will verify to communicate with your Rails app"
+  option :secret_key_base, aliases: %w(-b), desc: "The SECRET_KEY_BASE for the Rails application"
+  option :ssl_certificate_arn, aliases: %w(-s), desc: "The ARN of the SSL server certificate stored in IAM to attach to the ELB"
   def configure
     @verbose = options[:verbose]
     ElasticBeans::Command::Configure.new(
+      database_url: options[:database_url],
       image_id: options[:image_id],
       instance_type: options[:instance_type],
       keypair: options[:keypair],
       logging_endpoint: options[:logging_endpoint],
       public_key: options[:public_key],
-      ssl_certificate_id: options[:ssl_certificate_id],
+      secret_key_base: options[:secret_key_base],
+      ssl_certificate_arn: options[:ssl_certificate_arn],
       application: application(name: options[:application]),
       network: network(stack_name: options[:network]),
       elastic_beanstalk: elastic_beanstalk_client,
@@ -41,10 +47,10 @@ class ElasticBeans::CLI < Thor
 
   desc ElasticBeans::Command::Create::USAGE, ElasticBeans::Command::Create::DESC
   long_desc ElasticBeans::Command::Create::LONG_DESC
-  option :application, aliases: %w(-a), required: true
-  option :dns, aliases: %w(-d)
-  option :queue, aliases: %w(-q)
-  option :tags, type: :hash, default: {}
+  option :application, aliases: %w(-a), required: true, desc: APPLICATION_DESC
+  option :dns, aliases: %w(-d), desc: "A Route53 DNS entry to create or update for a new webserver environment"
+  option :queue, aliases: %w(-q), desc: "The name of the queue a new worker environment should listen to, e.g. `default`"
+  option :tags, type: :hash, default: {}, desc: "EC2 tags to apply to the new environment as a Hash, e.g. `--tags=Environment:development Team:mine`"
   def create(environment_type)
     @verbose = options[:verbose]
     ElasticBeans::Command::Create.new(
@@ -64,7 +70,7 @@ class ElasticBeans::CLI < Thor
 
   desc ElasticBeans::Command::Deploy::USAGE, ElasticBeans::Command::Deploy::DESC
   long_desc ElasticBeans::Command::Deploy::LONG_DESC
-  option :application, aliases: %w(-a), required: true
+  option :application, aliases: %w(-a), required: true, desc: APPLICATION_DESC
   def deploy
     @verbose = options[:verbose]
     ElasticBeans::Command::Deploy.new(
@@ -81,7 +87,7 @@ class ElasticBeans::CLI < Thor
 
   desc ElasticBeans::Command::Exec::USAGE, ElasticBeans::Command::Exec::DESC
   long_desc ElasticBeans::Command::Exec::LONG_DESC
-  option :application, aliases: %w(-a), required: true
+  option :application, aliases: %w(-a), required: true, desc: APPLICATION_DESC
   def exec(*command_parts)
     @verbose = options[:verbose]
     ElasticBeans::Command::Exec.new(
@@ -97,10 +103,10 @@ class ElasticBeans::CLI < Thor
 
   desc ElasticBeans::Command::Scale::USAGE, ElasticBeans::Command::Scale::DESC
   long_desc ElasticBeans::Command::Scale::LONG_DESC
-  option :application, aliases: %w(-a), required: true
-  option :minimum, aliases: %w(-i --min), required: true
-  option :maximum, aliases: %w(-m --max), required: true
-  option :queue, aliases: %w(-q)
+  option :application, aliases: %w(-a), required: true, desc: APPLICATION_DESC
+  option :minimum, aliases: %w(-i --min), required: true, desc: "The minimum number of healthy instances to keep"
+  option :maximum, aliases: %w(-m --max), required: true, desc: "The maximum number of healthy instances to keep"
+  option :queue, aliases: %w(-q), desc: "The name of the queue to identify the worker environment to scale, e.g. `default`"
   def scale(environment_type)
     @verbose = options[:verbose]
     ElasticBeans::Command::Scale.new(
@@ -119,7 +125,7 @@ class ElasticBeans::CLI < Thor
 
   desc ElasticBeans::Command::SetEnv::USAGE, ElasticBeans::Command::SetEnv::DESC
   long_desc ElasticBeans::Command::SetEnv::LONG_DESC
-  option :application, aliases: %w(-a), required: true
+  option :application, aliases: %w(-a), required: true, desc: APPLICATION_DESC
   def setenv(*env_pairs)
     @verbose = options[:verbose]
     ElasticBeans::Command::SetEnv.new(

data/lib/elastic_beans/application.rb

@@ -4,6 +4,9 @@ require "elastic_beans/aws/cloudformation_stack"
 require "elastic_beans/error"
 
 module ElasticBeans
+  # An Elastic Beanstalk application which should exist.
+  #
+  # If the application does not exist, an error will be raised when attempting to access it.
   class Application
     attr_reader :name
 
@@ -14,6 +17,10 @@ module ElasticBeans
       @stack = ElasticBeans::Aws::CloudformationStack.new(name, cloudformation: cloudformation)
     end
 
+    # Returns an ElasticBeans::ApplicationVersion reflecting the deployed version of the application from the
+    # latest-updated environment.
+    #
+    # Ignores terminated or terminating environments.
     def deployed_version
       response = elastic_beanstalk.describe_environments(application_name: name)
       live_environments = response.environments.select { |environment| environment.status !~ /Terminat/ }
@@ -26,6 +33,9 @@ module ElasticBeans
       retry
     end
 
+    # Returns an ElasticBeans::ConfigurationTemplate for each saved configuration of the Elastic Beanstalk application.
+    #
+    # See ElasticBeans::ConfigurationTemplate::new_from_existing for details on determining appropriate types.
     def configuration_templates
       response = elastic_beanstalk.describe_applications(application_names: [name])
       application = response.applications[0]
@@ -46,6 +56,7 @@ module ElasticBeans
       retry
     end
 
+    # Returns the ElasticBeans::EnvVars for this application.
     def env_vars
       unless exists?
         raise MissingApplicationError
@@ -54,6 +65,9 @@ module ElasticBeans
       EnvVars.new(application: self, s3: s3)
     end
 
+    # Returns an ElasticBeans::Environment for each un-terminated environment in the Elastic Beanstalk application.
+    #
+    # See ElasticBeans::Environment::new_from_existing for details on determining appropriate types.
     def environments
       response = elastic_beanstalk.describe_environments(application_name: name)
       live_environments = response.environments.select { |environment| environment.status !~ /Terminat/ }
@@ -69,6 +83,10 @@ module ElasticBeans
       retry
     end
 
+    # Returns the name of the S3 bucket in which to store artifacts for this application.
+    # Looks for the default Elastic Beanstalk bucket, which is of the form +elasticbeanstalk-REGION-ACCOUNT_ID+.
+    #
+    # Raises an error if the bucket cannot be found.
     def bucket_name
       return @bucket_name if @bucket_name
       bucket = s3.list_buckets.buckets.find { |bucket| bucket.name.start_with?("elasticbeanstalk-") }
@@ -78,6 +96,10 @@ module ElasticBeans
       @bucket_name = bucket.name
     end
 
+    # Enqueues a one-off command to be run on the application's +exec+ environment.
+    # Does not wait for action to be taken, but returns immediately after enqueuing the command.
+    #
+    # Raises an error if the exec environment cannot be found.
     def enqueue_command(command, sqs:)
       if environments.none? { |environment| environment.is_a?(Environment::Exec) }
         raise MissingExecEnvironmentError
@@ -93,6 +115,7 @@ module ElasticBeans
       stack.stack_output("ExecQueueUrl")
     end
 
+    # Returns an ElasticBeans::ApplicationVersion for each version of the Elastic Beanstalk application.
     def versions
       response = elastic_beanstalk.describe_application_versions(application_name: name)
       response.application_versions.map { |version| ElasticBeans::ApplicationVersion.new(version.version_label) }
@@ -101,12 +124,15 @@ module ElasticBeans
       retry
     end
 
+    # Returns the +Worker{QUEUE}QueueUrl+ from the application CloudFormation stack.
     def worker_queue_url(queue)
       queue_attribute = queue.to_s.downcase
       queue_attribute[0] = queue_attribute[0].upcase
       stack.stack_output("Worker#{queue_attribute}QueueUrl")
     end
 
+    # Returns the name of each queue discovered in the application CloudFormation stack.
+    # Looks for outputs of the form +Worker{QUEUE}QueueUrl+.
     def worker_queues
       stack.stack_outputs.each_with_object([]) do |(output_key, _), acc|
         match = /\AWorker(?<queue>\w+)QueueUrl\z/.match(output_key)
@@ -133,12 +159,16 @@ module ElasticBeans
       retry
     end
 
+    # :nodoc: all
+    # @!visibility private
     class MissingApplicationError < ElasticBeans::Error
       def message
         "Application `#{@application_name}' does not exist. Please create the Elastic Beanstalk application using a CloudFormation stack."
       end
     end
 
+    # :nodoc: all
+    # @!visibility private
     class MissingBucketError < ElasticBeans::Error
       def message
         "Cannot find the Elastic Beanstalk S3 bucket." \
@@ -146,12 +176,14 @@ module ElasticBeans
       end
     end
 
+    # :nodoc: all
+    # @!visibility private
     class MissingExecEnvironmentError < ElasticBeans::Error
       def message
         <<-MESSAGE
 A one-off command cannot be executed because the "exec" environment does not exist. Please create it:
 
-    #{$0} create -a APPLICATION exec
+    #{command_as_string "-a APPLICATION exec"}
         MESSAGE
       end
     end

data/lib/elastic_beans/application_version.rb

@@ -9,11 +9,18 @@ module ElasticBeans
   class ApplicationVersion
     attr_reader :version_label
 
+    # Create a representation of an existing application version in Elastic Beanstalk.
     def initialize(version_label)
       @version_label = version_label
     end
 
     class << self
+      # Create a new Elastic Beanstalk application version from the HEAD git commit of the given +working_directory+.
+      # Returns immediately if the application version already exists in Elastic Beanstalk.
+      #
+      # Injects helper code from this library to enable the functionality described in the README.
+      #
+      # Raises an error if the application version cannot be processed by Elastic Beanstalk.
       def create(working_directory:, application:, elastic_beanstalk:, s3:)
         version_label = fetch_version_label(working_directory)
         if application.versions.any? { |version| version.version_label == version_label }
@@ -21,7 +28,7 @@ module ElasticBeans
         end
 
         archive_path = File.join(working_directory, ".elasticbeanstalk", "#{version_label}.zip")
-        create_archive(sha: version_label, path: archive_path)
+        create_archive(working_directory: working_directory, sha: version_label, path: archive_path)
         create_application_version(
           path: archive_path,
           version_label: version_label,
@@ -68,9 +75,11 @@ module ElasticBeans
         raise FailedApplicationVersion.new(version_label: version_label, status: status)
       end
 
-      def create_archive(sha:, path:)
+      def create_archive(working_directory:, sha:, path:)
         FileUtils.mkdir_p(File.dirname(path))
-        system("git archive --format=zip -o #{path} #{sha}")
+        Dir.chdir(working_directory) do
+          system("git archive --format=zip -o #{path} #{sha}")
+        end
         unless $?.success?
           raise FailedArchiveError.new(sha: sha, path: path)
         end
@@ -157,6 +166,8 @@ module ElasticBeans
 
     private
 
+    # :nodoc: all
+    # @!visibility private
     class FailedApplicationVersion < ElasticBeans::Error
       include Nesty::NestedError
 
@@ -174,6 +185,8 @@ module ElasticBeans
       end
     end
 
+    # :nodoc: all
+    # @!visibility private
     class FailedArchiveError < ElasticBeans::Error
       def initialize(sha:, path:)
         @sha = sha
@@ -185,6 +198,8 @@ module ElasticBeans
       end
     end
 
+    # :nodoc: all
+    # @!visibility private
     class InvalidVersionWorkingDirectoryError < ElasticBeans::Error
       def initialize(wd:)
         @wd = wd

data/lib/elastic_beans/aws/cloudformation_stack.rb

@@ -2,6 +2,8 @@ require "aws-sdk"
 require "elastic_beans/error"
 
 module ElasticBeans
+  # :nodoc: all
+  # @!visibility private
   module Aws
     class CloudformationStack
       STACK_STATUSES = %w(CREATE_COMPLETE UPDATE_COMPLETE UPDATE_ROLLBACK_COMPLETE)

data/lib/elastic_beans/command/configure.rb

@@ -3,41 +3,41 @@ require "elastic_beans/error/environments_not_ready"
 
 module ElasticBeans
   module Command
+    # :nodoc: all
     class Configure
-      USAGE = "configure -n NETWORK -a APPLICATION [-k KEYPAIR] [-p PUBLIC_KEY] [-s SSL_CERTIFICATE_ID] [-i IMAGE_ID] [-t INSTANCE_TYPE] [-l EXEC_LOGGING_HTTP_ENDPOINT]"
+      USAGE = "configure"
       DESC = "Configure the given Elastic Beanstalk application"
       LONG_DESC = <<-LONG_DESC
 Configure the given Elastic Beanstalk application.
 Creates and updates configuration templates for each possible environment type.
 Updates running environments with the new configuration.
 
-Requires the networking CloudFormation stack and application name.
 Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
-Some environment variables that Rails always requires must be set:
-
-* DATABASE_URL
-* SECRET_KEY_BASE
       LONG_DESC
 
       def initialize(
+        database_url:,
         image_id:,
         instance_type:,
         keypair:,
         logging_endpoint:,
         public_key:,
-        ssl_certificate_id:,
+        secret_key_base:,
+        ssl_certificate_arn:,
         application:,
         network:,
         elastic_beanstalk:,
         iam:,
         ui:
       )
+        @database_url = database_url
         @image_id = image_id
         @instance_type = instance_type
         @keypair = keypair
         @logging_endpoint = logging_endpoint
         @public_key = public_key
-        @ssl_certificate_id = ssl_certificate_id
+        @secret_key_base = secret_key_base
+        @ssl_certificate_arn = ssl_certificate_arn
         @application = application
         @network = network
         @elastic_beanstalk = elastic_beanstalk
@@ -83,7 +83,7 @@ Some environment variables that Rails always requires must be set:
           keypair: keypair,
           iam: iam,
           public_key: public_key,
-          ssl_certificate_id: ssl_certificate_id,
+          ssl_certificate_arn: ssl_certificate_arn,
         )
         progressbar.increment
         progressbar.log("Updating exec configuration template...")
@@ -161,25 +161,19 @@ Some environment variables that Rails always requires must be set:
 
       attr_reader(
         :application,
+        :database_url,
         :image_id,
         :instance_type,
         :keypair,
         :logging_endpoint,
         :network,
         :public_key,
-        :ssl_certificate_id,
+        :secret_key_base,
+        :ssl_certificate_arn,
         :elastic_beanstalk,
         :iam,
         :ui,
       )
-
-      def database_url
-        ENV['DATABASE_URL']
-      end
-
-      def secret_key_base
-        ENV['SECRET_KEY_BASE']
-      end
     end
   end
 end

data/lib/elastic_beans/command/create.rb

@@ -6,14 +6,17 @@ require "elastic_beans/environment/webserver"
 
 module ElasticBeans
   module Command
+    # :nodoc: all
     class Create
-      USAGE = "create -a APPLICATION [-q QUEUE] [-d PRETTY_DNS] ENVIRONMENT_TYPE"
+      USAGE = "create ENVIRONMENT_TYPE"
       DESC = "Create a new environment in Elastic Beanstalk and attach it to relevant resources"
       LONG_DESC = <<-LONG_DESC
-Create a new environment in Elastic Beanstalk and attach it to relevant resources
-The environment type must be one of the recognized types: webserver, worker, or scheduled.
+Create a new environment in Elastic Beanstalk and attach it to relevant resources.
+The environment type must be one of the recognized types: webserver, worker, exec, or scheduled.
+
+A new environment will use the same deployed version as all other environments.
+If this is the first environment, a new version will be created from the HEAD git commit of the working directory.
 
-Requires the Elastic Beanstalk application name.
 Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
       LONG_DESC
 
@@ -133,6 +136,7 @@ Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID an
         raise UnhealthyEnvironmentError.new(environment_name: environment.name)
       end
 
+      # :nodoc: all
       class UnhealthyEnvironmentError < ElasticBeans::Error
         def initialize(environment_name:)
           @environment_name = environment_name

data/lib/elastic_beans/command/deploy.rb

@@ -3,13 +3,13 @@ require "elastic_beans/error/environments_not_ready"
 
 module ElasticBeans
   module Command
+    # :nodoc: all
     class Deploy
-      USAGE = "deploy -a APPLICATION"
+      USAGE = "deploy"
       DESC = "Deploy the HEAD git commit to all environments in Elastic Beanstalk"
       LONG_DESC = <<-LONG_DESC
-Deploy the HEAD git commit to all environments in Elastic Beanstalk.
+Deploy the HEAD git commit of the working directory to all environments in Elastic Beanstalk.
 
-Requires the application name.
 Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
       LONG_DESC
 

data/lib/elastic_beans/command/exec.rb

@@ -2,15 +2,16 @@ require "shellwords"
 
 module ElasticBeans
   module Command
+    # :nodoc: all
     class Exec
-      USAGE = "exec -a APPLICATION rake db:migrate"
+      USAGE = "exec COMMAND STRING"
       DESC = "Run an arbitrary command in the context of your application"
       LONG_DESC = <<-LONG_DESC
 Run an arbitrary command in the context of your application.
 The command is run in an "exec" environment, separate from your webserver or worker environments.
-Upload gzipped output from the command to an HTTP endpoint.
+You must create the exec environment prior to this command being run: `beans create exec -a APPLICATION`.
+Upload output from the command to an HTTP endpoint.
 
-Requires the Elastic Beanstalk application name.
 Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
       LONG_DESC
 

data/lib/elastic_beans/command/scale.rb

@@ -3,13 +3,13 @@ require "elastic_beans/error/environments_not_ready"
 
 module ElasticBeans
   module Command
+    # :nodoc: all
     class Scale
-      USAGE = "scale -a APPLICATION -i MINIMUM -m MAXIMUM ENVIRONMENT"
+      USAGE = "scale ENVIRONMENT_TYPE"
       DESC = "Change the autoscaling minimum and maximum for the given environment"
       LONG_DESC = <<-LONG_DESC
 Change the autoscaling minimum and maximum for the given environment.
 
-Requires the application name.
 Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
       LONG_DESC