capistrano-exfel 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29182346107c7a5c7bcaabf4698dbb6c84dda129
-  data.tar.gz: c0291a197ccb9aa843dd3869dc9ef9ad790865bf
+  metadata.gz: ac8d8376221fd414caea1a171e504075556f32cc
+  data.tar.gz: d9429c9efd767346e59382e5d8148d1f5cbd43a5
 SHA512:
-  metadata.gz: d97ad3f520a63a0447ce58b14bcd746ec87a942b1c6891b3a89391cafd1feea638084bdda1a7d283b22ff0c43e4e9ddb6617ebef4f9094cfa37fdfc5213182a7
-  data.tar.gz: f17164547d6601a7f4f9367af96eb8f55e5bcb73cfcd3a7cdfa6bb8f7ce0ba3c29bf54452f28542000a657f3600dbcdfbbab4effd03c3e5569c1c03e8f2be8f1
+  metadata.gz: 59c1cfb6de84e62176ad49aa96146da98047248d526238226b107ad4b735571e84f794b78dd2894da66cd1d17418d9269ee60b5b040dee8bf0f9a3ea39ab8d00
+  data.tar.gz: f46b46e8aaee29436f38bdc6e10052bb4cd4d234ecd9cd14c6febb585265d30c4042f6aee6f86b0e35522f22500c4c1a8f49fb5f512baf2f99009955babf859a

data/README.md

@@ -1,14 +1,18 @@
 # Capistrano::Exfel
 
-TODO: Write a gem description
+Deploys Ruby on Rails 4 Applications in EXFEL VMs using Capistrano3 throw username/password authentication.
+The standard EXFEL VMs consist of Scientific Linux 6 with Apache.
+Installation of Phusion Passenger and RVM are also required to this gem.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add these lines to your application's Gemfile:
 
-```ruby
-gem 'capistrano-exfel'
-```
+    # Use Capistrano for deployment
+    gem 'capistrano', '~> 3.4.0'
+    gem 'capistrano-rails', '~> 1.1.2'
+    gem 'capistrano-rvm', '~> 0.1.2'
+    gem 'capistrano-exfel', '~> 0.0.1'
 
 And then execute:
 
@@ -20,11 +24,81 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Add this line to your `Capfile`:
+
+    # Load Capistrano Exfel Scientific Linux 6 tasks
+    require 'capistrano/exfel/sl6'
+
+This gem will reuse `capistrano-rails` and `capistrano-rvm` tasks to build the following tasks:
+
+    # Task 'application:deploy_first_time' deploys an application for the first time in the configured server(s).
+    # This task besides deploying the application also make all the necessary configurations
+    # Description: Re-deploys existent Application in the configured server(s):
+    cap application:deploy
+
+    # Task 'application:deploy' deploys a new version of the application in the configured server(s)
+    # Description: Configures Apache and deploys the Application for the first time in the configured server(s)
+    # with the right permissions:
+    cap application:deploy_first_time
+
+    # Description: 'Restarts the application, including reloading server cache'
+    cap application:restart
+
+    # Description: 'Re-deploys apache configuration files and restart it'
+    cap application:reconfigure_apache
+
+    # Description: 'Shows variables values generated without deploying anything'
+    cap application:show_variables
+
+    #
+    # See all the additional available tasks using the command:
+    cap -T
+
+The most important configurable options and their defaults:options can be added to the `deploy.rb` file:
+
+    # Set username and password
+    set :username, ask('username', 'maial') # If not specified will present current user
+    set :password, ask('password', nil, echo: false) # If not specified will ask for it
+
+    # Application Name
+    set :app_name, 'my_app_name' # If not specified will ask for it
+
+    # Set application related information
+    # set :app_domain, 'https://in.xfel.eu/'
+    # set :app_name_uri, 'my_app_uri'
+
+    # Set git repository information
+    set :repo_url, 'exflgit:/data/git/calibration' # 'git@example.com:me/my_repo.git'
+
+    # Default branch is :master
+    # ask :branch, proc { `git rev-parse --abbrev-ref HEAD`.chomp }.call
+
+    # Default value for :scm is :git
+    # set :scm, :git
+
+    # Default value for :format is :pretty
+    # set :format, :pretty
+
+    # Default value for :log_level is :debug
+    # set :log_level, :info
+
+    # Default value for :linked_files is []
+    # set :linked_files, %w(config/database.yml config/secrets.yml)
+
+    # Default value for linked_dirs is []
+    # set :linked_dirs, %w(bin log tmp/pids tmp/cache tmp/sockets vendor/bundle public/system)
+
+    # Default value for keep_releases is 5
+    # set :keep_releases, 5
+
+    # RVM related information
+    # set :rvm_type, :system
+    set :rvm_ruby_version, '2.1.5' # If not specified will ask for it
+    # set :rvm_roles, [:app, :web]
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/capistrano-exfel/fork )
+1. Fork it ( https://github.com/luismaia/capistrano-exfel/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/capistrano/exfel/version.rb

@@ -1,6 +1,6 @@
 module Capistrano
   # Capistrano::Exfel version information
   module Exfel
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

data/lib/capistrano/tasks/application.rake

@@ -1,73 +1,40 @@
-####################################################################################################
-#
-# Capistrano Important Tasks
-#
-#####################################################################################################
-#
-# See all available tasks
-# cap -T
-
-# To deploy a new server with capistrano execute:
-# cap [development|test|production] application:deploy_first_time
-
-# To deploy the application, including assets compilation:
-# cap [development|test|production] application:deploy
-
-# To restart the application, including reloading server cache:
-# cap [development|test|production] application:restart
-
-####################################################################################################
-#
-# Capistrano Internal Tasks
-#
-#####################################################################################################
-#
-# To execute db seed (can only be executed once... to add default roles and users):
-# cap [development|test|production] db:seed
-
-# To restart Apache:
-# cap [development|test|production] deploy:restart_apache
-
-# To execute rake commands:
-# cap [development|test|production] util:runrake task=secret
-
 # XFEL application specific tasks
 namespace :application do
-  # Task 'application:deploy' deploys a new version of the application in the specified server
-  desc 'Re-deploy existent Application in the specified server'
-  task :deploy do
+  # Task 'application:deploy_first_time' deploys an application for the first time in the configured server(s).
+  # This task besides deploying the application also make all the necessary configurations
+  desc 'Configures Apache and deploys the Application for the first time in the configured server(s) '/
+         'with the right permissions'
+  task :deploy_first_time do
     on roles(:app, :web) do
       info '#' * 100
-      info '#' * 10 + ' => Start subsequents times deploy...'
+      info '#' * 10 + ' => Start Application first time deployment...'
       info '#' * 100
 
-      # This is advisable to kill users cookies after the upgrade.
-      # The consequence is that users will be logged out automatically from the Application after the upgrade.
-      # This is important to avoid errors with old validity_token in forms
-      invoke 'secrets:update_app_secret'
-
+      invoke 'app_home:create_all'
+      invoke 'database:configure_mysql'
+      invoke 'secrets:configure'
+      invoke 'apache:configure_and_start'
+      invoke 'apache:check_write_permissions'
       invoke :deploy
+      invoke 'app_home:correct_shared_permissions'
       invoke 'application:restart'
     end
   end
 
-  # Task 'application:deploy_first_time' deploys an application for the first time in the specified server.
-  # This task besides deploying the application also make all the necessary configurations
-  desc 'Deploy Application for the first time in the specified server'
-  task :deploy_first_time do
+  # Task 'application:deploy' deploys a new version of the application in the configured server(s)
+  desc 'Re-deploys existent Application in the configured server(s)'
+  task :deploy do
     on roles(:app, :web) do
       info '#' * 100
-      info '#' * 10 + ' => Start first time deploy...'
+      info '#' * 10 + ' => Start Application re-deployment...'
       info '#' * 100
 
-      invoke 'app_home:create_all'
-      invoke 'haproxy:configure_and_start' # This should go to Puppet
-      invoke 'database:configure_mysql'
-      invoke 'secrets:configure'
-      invoke 'apache:configure_and_start'
-      invoke 'apache:check_write_permissions'
+      # This is advisable to kill users cookies after the upgrade.
+      # The consequence is that users will be logged out automatically from the Application after the upgrade.
+      # This is important to avoid errors with old validity_token in forms
+      invoke 'secrets:update_app_secret'
+
       invoke :deploy
-      invoke 'app_home:correct_shared_permissions'
       invoke 'application:restart'
     end
   end
@@ -80,13 +47,13 @@ namespace :application do
     invoke 'app_home:deploy_success_msg'
   end
 
-  desc 'Restarts the application, including reloading server cache'
+  desc 'Re-deploys apache configuration files and restart it'
   task :reconfigure_apache do
     invoke 'apache:configure'
     invoke 'application:restart'
   end
 
-  desc 'Show variables values without deploying'
+  desc 'Shows variables values generated without deploying anything'
   task :show_variables do
     on roles(:app, :web) do
       info '#' * 100
@@ -203,7 +170,7 @@ namespace :load do
 
     # RVM related information
     set :rvm_type, -> { :system }
-    # set :rvm_ruby_version, '2.1.2'
+    set :rvm_ruby_version, -> { ask('Please specify the Ruby version (i.e. 2.1.5)', '') }
     set :rvm_roles, [:app, :web]
     # set :rvm_custom_path, '~/.myveryownrvm'  # only needed if not detected
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-exfel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Luis Maia