luban-grafana 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07fe7a5e8e72bf860fcb02fd79a7e2efd441e207
-  data.tar.gz: dd89ef620d6863c4b3ac6d91670a1afbb0fb63f6
+  metadata.gz: f3cdadb053fe1d707901bad2da431f8405c40f32
+  data.tar.gz: 309aebf48822d4d6214dec63575b50979ee0b60c
 SHA512:
-  metadata.gz: b2acdb78bf4f7313af43d464696c57800718769e9a633fe6d75bbd90931adeff1d09628768afdd1af69ac80e5f326794f2e09007ac4f962acce4d99f1b9fe286
-  data.tar.gz: '0388b6257efa498dacb58f185a2fbe5fb4755ba6089f68511382c4ebfb6bfaa091fa79a285ea7b0c68ef465f039ef33f8c30f8bf3ea31cb2a6d73aa4a411a868'
+  metadata.gz: 607d8930bde2b2cdfd22ede1e32a472e6959df4b9eb5e7d9a5998724bee16ade6d5f94db5d5f0b64c364bfc0eaf465b1d2aa1eb5f47158379965c4fa5dae51d4
+  data.tar.gz: ead300ef60d2fbb6abed4e30b0493fc16d5f1ff330b9895cc8ecb97319bb071eb1bbbba21d75a453ace024e0894ab298e8054dccc798c4a7602e21fa50103724

data/CHANGLOG.md

@@ -1,5 +1,21 @@
 # Change log
 
+## Version 0.2.0 (Nov 30, 2016)
+
+Minor enhancements:
+  * Setup appropriate paths for deployment of Grafana
+  * Added parameters, #port and #network_host, for basic setup of Grafana
+  * Added Controller and Configurator to manage Grafana deployment
+  * Added related profile templates for Grafana
+  * Bump up gem dependency of luban to version 0.10.10
+
+Bug fixes:
+  * Corrected parent class for Grafana
+  * Corrected parent class for Grafana::Installer
+  * Included Paths in Grafana::Installer
+  * Handled linked directories properly
+  * Cleaned up install path before installation
+
 ## Version 0.1.0 (Nov 25, 2016)
 
 New features:

data/lib/luban/deployment/packages/grafana.rb

@@ -1,4 +1,6 @@
 require 'luban'
 require_relative 'grafana/base'
 require_relative 'grafana/installer'
+require_relative 'grafana/controller'
+require_relative 'grafana/configurator'
 require_relative 'grafana/version'

data/lib/luban/deployment/packages/grafana/base.rb

@@ -1,7 +1,29 @@
 module Luban
   module Deployment
     module Packages
-      class Grafana < Luban::Deployment::Package::Base
+      class Grafana < Luban::Deployment::Service::Base
+        module Paths
+          def control_file_dir; @control_file_dir ||= "conf"; end
+
+          def control_file_name
+            @control_file_name ||= "#{service_name}.ini"
+          end
+
+          def data_path
+            @data_path ||= shared_path.join('data')
+          end
+
+          def plugins_path
+            @plugins_path ||= data_path.join('plugins')
+          end
+        end
+
+        DefaultPort = 3000
+        DefaultNetworkHost = `hostname -f`.chomp
+
+        parameter :port, default: DefaultPort
+        parameter :network_host, default: DefaultNetworkHost
+
         protected
 
         def setup_provision_tasks
@@ -9,6 +31,10 @@ module Luban
           provision_tasks[:install].option :iter, "Iteration"
           provision_tasks[:install].option :dist, "Binary distribution"
         end
+
+        def include_default_templates_path
+          default_templates_paths.unshift(base_templates_path(__FILE__))
+        end
       end
     end
   end

data/lib/luban/deployment/packages/grafana/configurator.rb

@@ -0,0 +1,12 @@
+module Luban
+  module Deployment
+    module Packages
+      class Grafana
+        class Configurator < Luban::Deployment::Service::Configurator
+          include Paths
+          include Controller::Commands
+        end
+      end
+    end
+  end
+end

data/lib/luban/deployment/packages/grafana/controller.rb

@@ -0,0 +1,34 @@
+module Luban
+  module Deployment
+    module Packages
+      class Grafana
+        class Controller < Luban::Deployment::Service::Controller
+          module Commands
+            def self.included(base)
+              base.define_executable 'grafana-server'
+            end
+
+            def process_pattern
+              @process_pattern ||= "#{control_file_path}$"
+            end
+
+            def shell_setup
+              @shell_setup ||= super << "cd #{install_path}"
+            end
+
+            def start_command
+              @start_command ||= shell_command("#{grafana_server_executable} -pidfile #{pid_file_path} -config #{control_file_path}", output: nil) + ' &'
+            end
+
+            def stop_command
+              @stop_command ||= shell_command("kill $(cat #{pid_file_path} 2>/dev/null)")
+            end
+          end
+
+          include Paths
+          include Commands
+        end
+      end
+    end
+  end
+end

data/lib/luban/deployment/packages/grafana/installer.rb

@@ -1,8 +1,10 @@
 module Luban
   module Deployment
     module Packages
-      class Grafana < Luban::Deployment::Package::Base
-        class Installer < Luban::Deployment::Package::Installer
+      class Grafana
+        class Installer < Luban::Deployment::Service::Installer
+          include Paths
+          
           define_executable 'grafana-cli'
 
           def package_iter; task.opts.iter; end
@@ -29,9 +31,15 @@ module Luban
 
           protected
 
+          def init
+            super
+            linked_dirs.push('data')
+          end
+
           def build_package
             info "Building #{package_full_name}"
             within install_path do
+              rm('-r', '*') # Clean up install path
               execute(:mv, build_path.join('*'), '.', ">> #{install_log_file_path} 2>&1")
             end
           end

data/lib/luban/deployment/packages/grafana/templates/conf/grafana.ini.erb

@@ -0,0 +1,360 @@
+##################### Grafana Configuration #####################
+
+# possible values : production, development
+# app_mode = production
+
+# instance name, defaults to HOSTNAME environment variable value or hostname if HOSTNAME var is empty
+# instance_name = ${HOSTNAME}
+
+#################################### Paths ####################################
+[paths]
+# Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used)
+#
+data = <%= data_path %>
+#
+# Directory where grafana can store logs
+#
+logs = <%= log_path %>
+#
+# Directory where grafana will automatically scan and look for plugins
+#
+plugins = <% plugins_path %>
+
+#################################### Server ####################################
+[server]
+# Protocol (http or https)
+# protocol = http
+
+# The ip address to bind to, empty will bind to all interfaces
+# http_addr =
+
+# The http port  to use
+http_port = <%= port %>
+
+# The public facing domain name used to access grafana from a browser
+domain = <%= network_host %>
+
+# Redirect to correct domain if host header does not match domain
+# Prevents DNS rebinding attacks
+# enforce_domain = false
+
+# The full public facing url
+# root_url = %(protocol)s://%(domain)s:%(http_port)s/
+
+# Log web requests
+# router_logging = false
+
+# the path relative working path
+# static_root_path = public
+
+# enable gzip
+# enable_gzip = false
+
+# https certs & key file
+# cert_file =
+# cert_key =
+
+#################################### Database ####################################
+[database]
+# Either "mysql", "postgres" or "sqlite3", it's your choice
+
+# SQLite 3
+type = sqlite3
+name = grafana
+# path relative to data_path setting
+path = <%= application%>_<%= stage %>.db
+
+# type = mysql
+# host = 127.0.0.1:3306
+# name = <%= application %>_<%= stage %>
+# user = root
+# password =
+
+# For "postgres", use either "disable", "require" or "verify-full"
+# For "mysql", use either "true", "false", or "skip-verify".
+ssl_mode = disable
+
+# ca_cert_path =
+# client_key_path =
+# client_cert_path =
+# server_cert_name =
+
+#################################### Session ####################################
+[session]
+# Either "memory", "file", "redis", "mysql", "postgres", "memcache", default is "file"
+# provider = file
+# provider_config = sessions
+
+# Provider config options
+# memory: not have any config yet
+# file: session dir path, is relative to grafana data_path
+# redis: config like redis server e.g. `addr=127.0.0.1:6379,pool_size=100,db=grafana`
+# postgres: user=a password=b host=localhost port=5432 dbname=c sslmode=disable
+# mysql: go-sql-driver/mysql dsn config string, examples:
+#         `user:password@tcp(127.0.0.1:3306)/database_name`
+#         `user:password@unix(/var/run/mysqld/mysqld.sock)/database_name`
+# memcache: 127.0.0.1:11211
+
+# Session cookie name
+# cookie_name = <%= application %>_<%= stage %>_grafana_sess
+
+# If you use session in https only, default is false
+# cookie_secure = false
+
+# Session life time, default is 86400
+# session_life_time = 86400
+# gc_interval_time = 86400
+
+#################################### Analytics ####################################
+[analytics]
+# Server reporting, sends usage counters to stats.grafana.org every 24 hours.
+# No ip addresses are being tracked, only simple counters to track
+# running instances, dashboard and error counts. It is very helpful to us.
+# Change this option to false to disable reporting.
+reporting_enabled = false
+
+# Set to false to disable all checks to https://grafana.net
+# for new vesions (grafana itself and plugins), check is used
+# in some UI views to notify that grafana or plugin update exists
+# This option does not cause any auto updates, nor send any information
+# only a GET request to http://grafana.net to get latest versions
+check_for_updates = true
+
+# Google Analytics universal tracking code, only enabled if you specify an id here
+# google_analytics_ua_id =
+
+# Google Tag Manager ID, only enabled if you specify an id here
+# google_tag_manager_id =
+
+#################################### Security ####################################
+[security]
+# default admin user, created on startup
+# admin_user = admin
+
+# default admin password, can be changed before first start of grafana,  or in profile settings
+# admin_password = admin
+
+# used for signing
+# secret_key = SW2YcwTIb9zpOOhoPsMm
+
+# Auto-login remember days
+# login_remember_days = 7
+cookie_username = <%= application %>_<%= stage %>_grafana_user
+cookie_remember_name = <%= application %>_<%= stage %>_grafana_remember
+
+# disable gravatar profile images
+# disable_gravatar = false
+
+# data source proxy whitelist (ip_or_domain:port separated by spaces)
+# data_source_proxy_whitelist =
+
+[snapshots]
+# snapshot sharing options
+external_enabled = false
+# external_snapshot_url = https://snapshots-origin.raintank.io
+# external_snapshot_name = Publish to snapshot.raintank.io
+
+#################################### Users ####################################
+[users]
+# disable user signup / registration
+allow_sign_up = false
+
+# Allow non admin users to create organizations
+allow_org_create = false
+
+# Set to true to automatically assign new users to the default organization (id 1)
+# auto_assign_org = true
+
+# Default role new users will be automatically assigned (if auto_assign_org above is set to true)
+# auto_assign_org_role = Viewer
+
+# Require email validation before sign up completes
+# verify_email_enabled = false
+
+# Background text for the user field on the login page
+# login_hint = email or username
+
+# Default UI theme ("dark" or "light")
+# default_theme = dark
+
+#################################### Anonymous Auth ##########################
+[auth.anonymous]
+# enable anonymous access
+# enabled = false
+
+# specify organization name that should be used for unauthenticated users
+# org_name = Main Org.
+
+# specify role for unauthenticated users
+# org_role = Viewer
+
+#################################### Github Auth ##########################
+[auth.github]
+enabled = false
+# allow_sign_up = false
+# client_id = some_id
+# client_secret = some_secret
+# scopes = user:email
+# auth_url = https://github.com/login/oauth/authorize
+# token_url = https://github.com/login/oauth/access_token
+# api_url = https://api.github.com/user
+# team_ids =
+# allowed_organizations =
+
+#################################### Google Auth ##########################
+[auth.google]
+enabled = false
+# allow_sign_up = false
+# client_id = some_client_id
+# client_secret = some_client_secret
+# scopes = https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email
+# auth_url = https://accounts.google.com/o/oauth2/auth
+# token_url = https://accounts.google.com/o/oauth2/token
+# api_url = https://www.googleapis.com/oauth2/v1/userinfo
+# allowed_domains =
+
+#################################### Basic Auth ##########################
+[auth.basic]
+enabled = true
+
+#################################### Auth Proxy ##########################
+[auth.proxy]
+enabled = false
+# header_name = X-WEBAUTH-USER
+# header_property = username
+# auto_sign_up = true
+
+#################################### Auth LDAP ##########################
+[auth.ldap]
+enabled = false
+# config_file = <%= control_path.join('ldap.toml')
+
+#################################### SMTP / Emailing ##########################
+[smtp]
+enabled = false
+# host = localhost:25
+# user =
+# password =
+# cert_file =
+# key_file =
+# skip_verify = false
+# from_address = admin@grafana.localhost
+
+[emails]
+# welcome_email_on_sign_up = false
+# templates_pattern = emails/*.html
+
+#################################### Logging ##########################
+[log]
+# Either "console", "file", "syslog". Default is console and  file
+# Use space to separate multiple modes, e.g. "console file"
+mode = console, file
+
+# Either "debug", "info", "warn", "error", "critical", default is "info"
+# level = info
+
+# For "console" mode only
+[log.console]
+level =
+
+# log line format, valid options are text, console and json
+format = console
+
+# For "file" mode only
+[log.file]
+level =
+
+# log line format, valid options are text, console and json
+format = text
+
+# This enables automated log rotate(switch of following options), default is true
+log_rotate = false
+
+# Max line number of single file, default is 1000000
+# max_lines = 1000000
+
+# Max size shift of single file, default is 28 means 1 << 28, 256MB
+# max_size_shift = 28
+
+# Segment log daily, default is true
+# daily_rotate = true
+
+# Expired days of log file(delete after max days), default is 7
+# max_days = 7
+
+[log.syslog]
+# level =
+
+# log line format, valid options are text, console and json
+# format = text
+
+# Syslog network type and address. This can be udp, tcp, or unix. If left blank, the default unix endpoints will be used.
+# network =
+# address =
+
+# Syslog facility. user, daemon and local0 through local7 are valid.
+# facility =
+
+# Syslog tag. By default, the process' argv[0] is used.
+# tag =
+
+
+#################################### AMQP Event Publisher ##########################
+[event_publisher]
+# enabled = false
+# rabbitmq_url = amqp://localhost/
+# exchange = grafana_events
+
+#################################### Dashboard JSON files ##########################
+[dashboards.json]
+# enabled = false
+# path = /var/lib/grafana/dashboards
+
+#################################### Usage Quotas ##########################
+[quota]
+# enabled = false
+
+#### set quotas to -1 to make unlimited. ####
+# limit number of users per Org.
+org_user = 10
+
+# limit number of dashboards per Org.
+org_dashboard = 100
+
+# limit number of data_sources per Org.
+org_data_source = 10
+
+# limit number of api_keys per Org.
+org_api_key = 10
+
+# limit number of orgs a user can create.
+user_org = 10
+
+# Global limit of users.
+global_user = -1
+
+# global limit of orgs.
+global_org = -1
+
+# global limit of dashboards
+global_dashboard = -1
+
+# global limit of api_keys
+global_api_key = -1
+
+# global limit on number of logged in users.
+global_session = -1
+
+#################################### Internal Grafana Metrics ##########################
+# Metrics available at HTTP API Url /api/metrics
+[metrics]
+enabled           = false
+# interval_seconds  = 60
+
+# Send internal Grafana metrics to graphite
+# ; [metrics.graphite]
+# ; address = localhost:2003
+# ; prefix = prod.grafana.%(instance_name)s.
+
+[grafana_net]
+# url = https://grafana.net

data/lib/luban/deployment/packages/grafana/templates/grafana.logrotate.erb

@@ -0,0 +1,16 @@
+# Grafana logrotate configuration
+
+<%= log_file_path %> {
+  daily
+  maxsize 5M
+  maxage <%= logrotate_max_age %>
+  rotate <%= logrotate_count %>
+  missingok
+  compress
+  compresscmd <%= `which gzip`.chomp %>
+  delaycompress
+  dateext
+  dateformat -%Y%m%d-%H%M%S
+  copytruncate
+  olddir archived_logs
+}

data/lib/luban/deployment/packages/grafana/templates/grafana.monitrc.erb

@@ -0,0 +1,10 @@
+# Monit control file for Grafana
+
+check process <%= service_entry %>
+  with pidfile <%= pid_file_path %>
+  onreboot laststate
+  start program = "/bin/bash -c 'sleep 1; <%= start_command %>'"
+  stop program = "/bin/bash -c '<%= stop_command %>'"
+  if failed port <%= port %> for 4 times within 8 cycles then restart
+  if cpu is greater than 80% for 20 cycles then alert
+  if loadavg(5min) greater than 10 for 40 cycles then restart

data/lib/luban/deployment/packages/grafana/version.rb

@@ -1,7 +1,7 @@
 module Luban
   module Deployment
     module Packages
-      GRAFANA_VERSION = '0.1.0'
+      GRAFANA_VERSION = '0.2.0'
     end
   end
 end

data/luban-grafana.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = ">= 2.1.0"
-  spec.add_dependency 'luban', ">= 0.10.6"
+  spec.add_dependency 'luban', ">= 0.10.10"
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: luban-grafana
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rubyist Chi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-25 00:00:00.000000000 Z
+date: 2016-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: luban
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.6
+        version: 0.10.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.6
+        version: 0.10.10
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,7 +84,12 @@ files:
 - lib/luban-grafana.rb
 - lib/luban/deployment/packages/grafana.rb
 - lib/luban/deployment/packages/grafana/base.rb
+- lib/luban/deployment/packages/grafana/configurator.rb
+- lib/luban/deployment/packages/grafana/controller.rb
 - lib/luban/deployment/packages/grafana/installer.rb
+- lib/luban/deployment/packages/grafana/templates/conf/grafana.ini.erb
+- lib/luban/deployment/packages/grafana/templates/grafana.logrotate.erb
+- lib/luban/deployment/packages/grafana/templates/grafana.monitrc.erb
 - lib/luban/deployment/packages/grafana/version.rb
 - lib/luban/grafana.rb
 - luban-grafana.gemspec