elastic_beans 0.13.0.alpha6 → 0.13.0.alpha7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 664c74c9be1710fc97174af435e1cc4e67db6c06
-  data.tar.gz: eb6e2d1028c9a5ca81d0ec6295dd127255f567a5
+  metadata.gz: 6c7e6af10b562bf1ca2c47b499c962479c25f260
+  data.tar.gz: cb958914d9f2d97153369addbef09dff743d5d32
 SHA512:
-  metadata.gz: 7890ae4cbe0d96b740cc3348425ce17a49e64766023a2693977198c3f34948803fbf1dd8e7d6fc4bfd779ee0405daabbe5d1dd1fc11fc2eb24f8061af13233ca
-  data.tar.gz: dd413fc4e2ffb0b9a74da493fc87918352cc24d643d58491d3cedefd3625bd19ab19f8903b3cd66fc19c2cb24e26fd52448912af5bcaa02cfd8568664f733f0c
+  metadata.gz: 16acb819c121eb984ae73eacf7b77ead3ff936b6e66eddaf8e1147e99ecf6cfb16abaf4e09fe402194e2f39e84edb3f146ea91f53667ddabfafb149a5675a22d
+  data.tar.gz: 70655c6345593c2fd1b4efcacd93713205a4556c2fa6e9ef077b9e71a0d5a8a4355beb8faa05f5a2021cd99c52839014e4100589d399ef4ebd29734c62e8ec8f

data/README.md

@@ -29,7 +29,8 @@ As the SDK documentation suggests, using environment variables is recommended.
       [-o 'OPTION_SETTING_NAMESPACE/OPTION_NAME=VALUE'...]
     beans setenv -a myapp \
       DATABASE_URL=mysql2://db.example.com:3306/myapp \
-      SECRET_KEY_BASE=abc123
+      SECRET_KEY_BASE=abc123 \
+      REDIS_URL=redis://...
 
     # 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
@@ -46,14 +47,11 @@ As the SDK documentation suggests, using environment variables is recommended.
     # Create a periodic task scheduler using cron.yaml
     beans create -a myapp scheduler
 
-    # Set environment variables across all environments
-    beans setenv -a myapp REDIS_URL=redis://...
-
     # 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 in the execution environment created earlier
     beans exec rake db:migrate -a myapp
 
     # SSH to an instance for debugging, tunneling through a bastion instance to reach the private network
@@ -101,10 +99,21 @@ In `config/initializers/elastic_beans.rb`, add the middleware into your stack, b
 ### Periodic tasks
 
 Elastic Beanstalk [supports periodic tasks][periodic] by sending a POST request to an endpoint of your application.
-Elastic Beans includes a middleware that can convert specially-crafted paths into commands and enqueue them for execution. "Specially-crafted" meaning with /exec at the front, as the cron.yaml section below explains. The middleware only accepts localhost requests from `aws-sqsd`.
+Create a periodic scheduler environment to enqueue tasks:
+
+    beans create -a myapp scheduler
+
+This environment will enqueue the commands from `cron.yaml`.
 
 [periodic]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features-managing-env-tiers.html#worker-periodictasks
 
+The [active-elastic-job gem](https://github.com/tawan/active-elastic-job#set-up-periodic-tasks-cron-jobs) supports executing background jobs as periodic tasks at a special endpoint.
+This approach will work fine as long [as your jobs can execute within the time allotted by nginx and SQS](https://medium.com/one-medical-engineering/elastic-beanstalk-one-off-and-periodic-tasks-752bbae841ae#3d23).
+
+If you need more time, Elastic Beans includes a middleware that can convert specially-crafted paths into commands and enqueue them for execution just like `beans exec`.
+"Specially-crafted" meaning with /exec at the front, as the cron.yaml section below explains.
+The middleware only accepts localhost requests from `aws-sqsd`.
+
 In `config/initializers/elastic_beans.rb`, add the middleware into your stack, below forcing HTTPS (`aws-sqsd` does not use HTTPS):
 
     require "elastic_beans/rack/exec"
@@ -141,12 +150,6 @@ In `cron.yaml`, name the full command to be run and use `/exec` as the `url`:
     - name: rake myapp:mytask[arg1,arg2]
       url: "/exec"
 
-Then create a periodic scheduler environment using `cron.yaml`:
-
-    beans create -a myapp scheduler
-
-This environment will enqueue the commands from `cron.yaml` for the `exec` environment to run.
-
 ## What elastic_beans does differently than awsebcli
 
 ### Cleanup of old versions
@@ -256,7 +259,7 @@ Make sure that its redrive policy allows such inspection before considering a me
 ### 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.
+Elastic Beans will set the `PROCESS_ACTIVE_ELASTIC_JOBS` environment variable appropriately in your environments.
 
 ### Known issues and limitations of the pre-release
 

data/lib/elastic_beans/configuration_template/base.rb

@@ -51,7 +51,7 @@ module ElasticBeans
           template_option_setting(template: template, namespace: "aws:elasticbeanstalk:command", option_name: "BatchSize", default: "1", new_settings: option_settings),
           template_option_setting(template: template, namespace: "aws:elasticbeanstalk:command", option_name: "BatchSizeType", default: "Fixed", new_settings: option_settings),
           template_option_setting(template: template, namespace: "aws:elasticbeanstalk:command", option_name: "DeploymentPolicy", default: "Rolling", new_settings: option_settings),
-          template_option_setting(template: template, namespace: "aws:elasticbeanstalk:application:environment", option_name: "DISABLE_SQS_CONSUMER", default: "true", new_settings: option_settings),
+          template_option_setting(template: template, namespace: "aws:elasticbeanstalk:application:environment", option_name: "PROCESS_ACTIVE_ELASTIC_JOBS", default: "true", new_settings: option_settings),
           template_option_setting(template: template, namespace: "aws:elasticbeanstalk:application:environment", option_name: "ELASTIC_BEANS_ENV_VARS", default: config_path, new_settings: option_settings),
           template_option_setting(template: template, namespace: "aws:elasticbeanstalk:environment", option_name: "ServiceRole", default: "aws-elasticbeanstalk-service-role", new_settings: option_settings),
           template_option_setting(template: template, namespace: "aws:elasticbeanstalk:healthreporting:system", option_name: "SystemType", default: "enhanced", new_settings: option_settings),

data/lib/elastic_beans/configuration_template/exec.rb

@@ -15,7 +15,7 @@ module ElasticBeans
       def build_option_settings(option_settings: [], **_)
         super + [
           template_option_setting(namespace: "aws:elasticbeanstalk:application", option_name: "Application Healthcheck URL", default: "HTTP:80/", new_settings: option_settings),
-          template_option_setting(namespace: "aws:elasticbeanstalk:application:environment", option_name: "DISABLE_SQS_CONSUMER", override: "false", new_settings: option_settings),
+          template_option_setting(namespace: "aws:elasticbeanstalk:application:environment", option_name: "PROCESS_ACTIVE_ELASTIC_JOBS", override: "false", new_settings: option_settings),
           template_option_setting(namespace: "aws:elasticbeanstalk:application:environment", option_name: "ELASTIC_BEANS_EXEC_QUEUE_URL", override: application.exec_queue_url, new_settings: option_settings),
           template_option_setting(namespace: "aws:elasticbeanstalk:application:environment", option_name: "RAILS_SKIP_MIGRATIONS", default: "true", new_settings: option_settings),
         ]

data/lib/elastic_beans/configuration_template/scheduler.rb

@@ -14,7 +14,7 @@ module ElasticBeans
       def build_option_settings(option_settings: [], **_)
         super + [
           template_option_setting(namespace: "aws:elasticbeanstalk:application", option_name: "Application Healthcheck URL", default: "HTTP:80/", new_settings: option_settings),
-          template_option_setting(namespace: "aws:elasticbeanstalk:application:environment", option_name: "DISABLE_SQS_CONSUMER", override: "false", new_settings: option_settings),
+          template_option_setting(namespace: "aws:elasticbeanstalk:application:environment", option_name: "PROCESS_ACTIVE_ELASTIC_JOBS", override: "false", new_settings: option_settings),
           template_option_setting(namespace: "aws:elasticbeanstalk:application:environment", option_name: "RAILS_SKIP_MIGRATIONS", default: "true", new_settings: option_settings),
         ]
       end

data/lib/elastic_beans/configuration_template/worker.rb

@@ -27,7 +27,7 @@ module ElasticBeans
       def build_option_settings(option_settings: [], **_)
         super + [
           template_option_setting(namespace: "aws:elasticbeanstalk:application", option_name: "Application Healthcheck URL", default: "HTTP:80/", new_settings: option_settings),
-          template_option_setting(namespace: "aws:elasticbeanstalk:application:environment", option_name: "DISABLE_SQS_CONSUMER", override: "false", new_settings: option_settings),
+          template_option_setting(namespace: "aws:elasticbeanstalk:application:environment", option_name: "PROCESS_ACTIVE_ELASTIC_JOBS", override: "false", new_settings: option_settings),
           template_option_setting(namespace: "aws:elasticbeanstalk:application:environment", option_name: "RAILS_SKIP_MIGRATIONS", default: "true", new_settings: option_settings),
           template_option_setting(namespace: "aws:elasticbeanstalk:sqsd", option_name: "InactivityTimeout", default: "1800", new_settings: option_settings),
           template_option_setting(namespace: "aws:elasticbeanstalk:sqsd", option_name: "MaxRetries", default: "10", new_settings: option_settings),

data/lib/elastic_beans/rack/exec.rb

@@ -59,8 +59,8 @@ module ElasticBeans
       end
 
       def enabled?
-        worker_disabled = ENV['DISABLE_SQS_CONSUMER'] || 'false'
-        worker_disabled == 'false'
+        worker_enabled = ENV['PROCESS_ACTIVE_ELASTIC_JOBS']
+        worker_enabled == 'true'
       end
     end
   end

data/lib/elastic_beans/rack/health_check.rb

@@ -31,8 +31,8 @@ module ElasticBeans
       attr_reader :app, :logger
 
       def enabled?
-        worker_disabled = ENV['DISABLE_SQS_CONSUMER'] || 'false'
-        worker_disabled == 'false'
+        worker_enabled = ENV['PROCESS_ACTIVE_ELASTIC_JOBS']
+        worker_enabled == 'true'
       end
 
       def health_request?(request)

data/lib/elastic_beans/version.rb

@@ -1,3 +1,3 @@
 module ElasticBeans
-  VERSION = "0.13.0.alpha6"
+  VERSION = "0.13.0.alpha7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elastic_beans
 version: !ruby/object:Gem::Version
-  version: 0.13.0.alpha6
+  version: 0.13.0.alpha7
 platform: ruby
 authors:
 - Adam Stegman