gargor 0.0.1 → 0.0.2

data/Gemfile

@@ -3,6 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in gargor.gemspec
 gemspec
 
-require 'json'
-require 'jsonpath'
+gem 'json'
+gem 'jsonpath'
 

data/README.md

@@ -12,7 +12,7 @@ Ruby 1.9以降が必要です
 
 1. 現在のChefの設定ファイル(JSON)から個体を一つ作ります。
 2. 残りの個体を突然変異により作ります。
-3. 各個体に対し、負荷試験を実施し、適応値を算出します。
+3. 各個体に対し負荷試験(Chefによる配備→攻撃)を実施し、適応値を算出します。
 4. 現世代の個体群に対して、エリートと残りを交叉および突然変異により次世代の個体群をつくります。
 5. 次世代の個体群を現世代として`3.`に戻ります。これを指定した世代分実施します。
 6. 最後に最も高い適応値の個体をサーバに配備して終了します
@@ -20,12 +20,97 @@ Ruby 1.9以降が必要です
 ## 使い方
 
     $ gargor [dsl-file]
-    
 
-    `dsl-file`を省略した場合は、カレントディレクトリの`gargor.rb`を探します。
+`gargor`の設定情報は、内部DSLによりに以下のように記述します。
 
-    dsl-fileの書き方は、添付の`doc/sample.rb`を御覧ください
-    
+```ruby
+# 世代数: 1以上を指定してください
+max_generations 10
+
+# 個体数: 1世代あたりの個体数
+population 10
+
+# エリート: 世代交代の時に適応値の高い個体をそのまま次世代に引き継ぐ数
+elite 1
+
+# 突然変異の確率: "0.01"で"1%"
+mutation 0.01
+
+# ターゲットをChefで料理するコマンド %sには、ノード名が入る
+target_cooking_cmd "knife solo cook %s"
+
+# ターゲットのノード
+#   攻撃前に以下のノードすべてに対してtarget_cooking_cmdが実施される
+target_nodes ["www-1.example","www-2.example","db-1.example"]
+
+# 攻撃コマンド
+attack_cmd "ssh attacker.example ./bin/ghakai www-1.example.yml 2>/dev/null"
+
+
+# 攻撃結果の評価
+# code: attack_cmdのプロセス終了コード(普通は0:成功)
+# out:  attack_cmdの標準出力
+# time: attack_cmdの実行時間
+evaluate do |code,out,time|
+  puts out
+  fitness = 0
+
+  # 攻撃コマンドで使っている、グリーン破壊の標準出力から
+  # FAILEDの値を抜き出し0以外は適応値0としている
+  if time > 0 && code == 0 && /^FAILED (\d+)/ =~ out && $1 == "0"
+    # 攻撃コマンドで使っている、グリーン破壊の標準出力から
+    # 適応値に代用できそうなものを正規表現で取得する
+    # request count:200, concurrenry:20, 45.060816 req/s
+    if /, ([\.\d]+) req\/s/ =~ out
+      fitness = $1.to_f
+    end
+    # 単純に実行時間で適応値を設定したいなら以下のようにしても良い
+    # fitness = 1/time
+  end
+  # このブロックは必ず適応値を返すこと(整数or浮動小数)
+  fitness
+end
+
+# パラメータ定義
+# GAにより変動されるパラメータをここで定義する
+# 
+# param 名前 do
+# json_file: 値を上書くJSONファイル nodes/*.jsonやroles/*.json
+#            (注意!) gargorはこのjsonファイルを容赦なく書き換える
+# json_path: json_fileの中から書変える値の場所をJSONPath形式で指定する
+# mutaion:   突然変異時の値の設定
+param "max_clients" do
+  json_file "roles/www.json"
+  json_path '$.httpd.max_clients'
+  mutation rand(500)+10
+end
+
+param "innodb_log_file_size" do
+  json_file "nodes/db-1.example.json"
+  json_path '$.mysqld.innodb_log_file_size'
+  mutation rand(200)
+end
+
+param "sort_buffer_size" do
+  json_file "nodes/db-1.example.json"
+  json_path '$.mysqld.sort_buffer_size'
+  mutation rand(1000)
+end
+
+param "read_buffer_size" do
+  json_file "nodes/db-1.example.json"
+  json_path '$.mysqld.read_buffer_size'
+  mutation rand(1000)
+end
+
+param "query_cache_size" do
+  json_file "nodes/db-1.example.json"
+  json_path '$.mysqld.query_cache_size'
+  mutation rand(100)
+end
+```
+
+このDSLファイルは任意のファイル名でChefのリポジトリに含めてしまうことを推奨します。`dsl-file`を省略した場合は、カレントディレクトリの`gargor.rb`を探します。
 
 ### 注意
 
@@ -150,11 +235,11 @@ MaxRequestsPerChild  <%= node["httpd"]["max_request_per_child"] %>
 
 コマンドラインで使えるものであれば、大体使うことができます。サンプルでは、[グリーン破壊](https://github.com/KLab/green-hakai/)を使わせて頂きました。
 
-負荷試験の厳しさによって個体が死滅することがあります。すると以下のように表示され、プログラムが終了します。
+負荷試験の厳しさによって個体が全滅することがあります。すると以下のように表示され、プログラムが終了します。
 
     ***** EXTERMINATION ******
     
-これは、個体の環境が厳しすぎるためで負荷試験を緩めて再度実施してください。    
+これは、個体の環境が厳しすぎるためで負荷の条件を緩めて再度実施してください。    
 
 ## FAQ
 

data/bin/gargor

@@ -4,8 +4,18 @@ require 'gargor'
 
 dsl_file=ARGV.last||"gargor.rb"
 
-Gargor.start
-Gargor.load_dsl(dsl_file)
+def usage
+  STDERR.print "usage: #{$0} [dsl-file]\n"
+end
+
+begin
+  Gargor.start
+  Gargor.load_dsl(dsl_file)
+rescue
+  usage
+  exit 1
+end
+
 loop {
   Gargor.populate.each { |i|
     if i.fitness == nil

data/gargor.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Gargor::VERSION
   spec.authors       = ["Yoshihiro TAKAHARA"]
   spec.email         = ["y.takahara@gmail.com"]
-  spec.description   = %q{auto server tunner by generic algorithm}
-  spec.summary       = %q{auto server tunner by generic algorithm using chef}
+  spec.description   = %q{It is software which uses generic algorithm to support parameter tuning of the servers controlled by Chef.}
+  spec.summary       = %q{An auto-tuning tool for internet servers w/ Genetic Algorithm and Chef. You can get good settings during sleeping ;) }
   spec.homepage      = "https://github.com/tumf/gargor"
   spec.license       = "MIT"
 

data/lib/gargor.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+require 'rubygems' if RUBY_VERSION < '1.9'
 require "gargor/version"
 require "gargor/individual"
 require "gargor/parameter"
@@ -20,18 +21,20 @@ class Gargor
       @@prev_generation = nil
       @@individuals = []
       @@param_procs = {}
-      @@population = 10
+      @@population = 0
       @@max_generations = 1
       @@generation = 1
       @@elite = 0
       @@attack_cmd = "false"
       @@attack_proc = nil
-      @@evaluate_proc = nil
+      @@evaluate_proc = Proc.new { 0 }
+      @@target_nodes = []
     end
 
     def load_dsl(params_file)
       contents = File.open(params_file, 'rb'){ |f| f.read }
       new.instance_eval(contents)
+      raise "POPULATION == 0" if @@population == 0
     end
 
     def mutation

data/lib/gargor/version.rb

@@ -1,3 +1,3 @@
 class Gargor
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gargor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-16 00:00:00.000000000 Z
+date: 2013-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,7 +43,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: auto server tunner by generic algorithm
+description: It is software which uses generic algorithm to support parameter tuning
+  of the servers controlled by Chef.
 email:
 - y.takahara@gmail.com
 executables:
@@ -86,5 +87,6 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: auto server tunner by generic algorithm using chef
+summary: An auto-tuning tool for internet servers w/ Genetic Algorithm and Chef. You
+  can get good settings during sleeping ;)
 test_files: []