kubelink 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 822c6b2dc5aefd26ccb0ad0edc51d83934aca4031d91e1c768285f2a782ba9a2
+  data.tar.gz: 074d4552a27b5d36204db79263d9fd1aa428c4890c2552d26fa9011db68d2a58
+SHA512:
+  metadata.gz: fbb3e32067fbe281021dcf191e5158d0c5c097fb34329a327c640846678eb700f25201387dc6e2fd5ad827c4039de67a1ec1a60b40c753b2b17240f3bc33f286
+  data.tar.gz: c34ade1bd0ad7ab8d28a80cac287e8d1269d1395c9409c44531548db6336672f765946b65ea434410c2f05ad11ed8dcf6acaedc057cd0a103202c85c7749bd4a

data/.gitignore

@@ -0,0 +1,11 @@
+/*.gem
+/.bundle
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/Gemfile.lock
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at difilippo@shaman.xyz. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in kubelink.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Martino di Filippo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# Description
+
+This gem is intended for internal use at Shaman, though you may find it useful (if a bit opinionated) nonetheless.
+
+# Prerequisites
+
+- A Rails >= 5.0 application
+- Ruby >= 2.3.0
+
+# Installation
+
+Add this line to your gemfile:
+
+```ruby
+gem 'kubelink'
+```
+
+Then run `bundle install`.
+
+# Features
+
+## Configuration and logging
+
+This gems sets a few configuration options in production:
+
+- config.force_ssl = true
+- config.log_level = :info
+
+It also includes lograge to reduce logging to a manageable level.
+
+## Healthcheck endpoints
+
+By including this gem two endpoints will be added to your routes:
+
+- /healthz, which runs `SELECT 1` on the database and returns a 200 OK
+- /statusz, which just returns a 200 OK
+
+They are supposed to be used as liveness and readiness probes in Kubernetes.
+
+## Prometheus exporter
+
+PrometheusExporter::Middleware is added to rack. You still need to run an exporter in a separate process:
+
+```ruby
+bundle exec prometheus_exporter
+```
+
+## Sentry integration
+
+This gem requires the presence of a `SENTRY_DSN` environment variable to enable Sentry integration in production.
+You need to include the relevant script tag in your layout by using the appropriate helper:
+
+```erb
+<%= sentry_include_tag %>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://git.shaman.xyz/shaman/kubelink. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Kubelink project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/kubelink/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kubelink"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kubelink.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kubelink/version'
+
+Gem::Specification.new do |s|
+  s.name       = 'kubelink'
+  s.version    = Kubelink::VERSION
+  s.authors    = ['Martino di Filippo']
+  s.email      = ['difilippo@shaman.xyz']
+  s.homepage   = 'https://git.shaman.xyz/shaman/kubelink'
+  s.summary    = %q{Integrate a Rails app with our Kubernetes environment}
+  s.license    = 'MIT'
+  s.required_ruby_version = '>= 2.3.0'
+
+  s.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'lograge', '~> 0.10.0'
+  s.add_dependency 'prometheus_exporter', '~> 0.4.0'
+  s.add_dependency 'sentry-raven', '~> 2.7', '>= 2.7.4'
+
+  s.add_development_dependency 'bundler', '~> 1.16'
+  s.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/kubelink.rb

@@ -0,0 +1,8 @@
+require 'kubelink/version'
+
+if defined?(Rails)
+  require 'kubelink/config'
+  require 'kubelink/health'
+  require 'kubelink/prometheus'
+  require 'kubelink/sentry'
+end

data/lib/kubelink/config.rb

@@ -0,0 +1,15 @@
+module Kubelink
+  class Config < Rails::Railtie
+    initializer "kubelink.config" do
+      if Rails.env.production?
+        require 'lograge'
+
+        Rails.application.configure do
+          config.force_ssl = true
+          config.log_level = :info
+          config.lograge.enabled = true
+        end
+      end
+    end
+  end
+end

data/lib/kubelink/health.rb

@@ -0,0 +1,23 @@
+module Kubelink
+  class Health < Rails::Railtie
+    initializer "kubelink.healthcheck_endpoints" do
+      ActiveSupport.on_load :action_controller do
+        class MonitoringController < ActionController::Base
+          def health
+            ActiveRecord::Base.connection.execute('SELECT 1')
+            render plain: "ok"
+          end
+
+          def status
+            render plain: "ok"
+          end
+        end
+
+        Rails.application.routes.prepend do
+          get 'healthz', to: 'monitoring#health'
+          get 'statusz', to: 'monitoring#status'
+        end
+      end
+    end
+  end
+end

data/lib/kubelink/prometheus.rb

@@ -0,0 +1,12 @@
+module Kubelink
+  class Prometheus < Rails::Railtie
+    initializer 'kubelink.prometheus_exporter' do
+      unless Rails.env.development? || Rails.env.test?
+        require 'prometheus_exporter'
+        require 'prometheus_exporter/middleware'
+
+        Rails.application.middleware.unshift PrometheusExporter::Middleware
+      end
+    end
+  end
+end

data/lib/kubelink/sentry.rb

@@ -0,0 +1,58 @@
+module Kubelink
+  class Sentry < Rails::Railtie
+    initializer "kubelink.sentry_integration" do
+      ActiveSupport.on_load :action_view do
+        include Kubelink::Sentry::Helpers
+      end
+
+      if ENV.key?('RAVEN_DSN')
+        Raven.configure do |config|
+          config.dsn = ENV['RAVEN_DSN']
+          config.release = ENV['RAILS_COMMIT']
+        end
+
+        ActiveSupport.on_load :action_controller do
+          include Kubelink::Sentry::Controller
+        end
+      elsif Rails.env.production?
+        throw "This application cannot run in production without setting RAVEN_DSN"
+      end
+    end
+
+    module Helpers
+      def sentry_dsn
+        @dsn ||= begin
+          u = URI.parse(ENV['SENTRY_DSN'])
+          u.password = nil
+          u.to_s
+        rescue
+          nil
+        end
+      end
+
+      def sentry_include_tag
+        return unless sentry_dsn.present?
+
+        script = 'https://browser.sentry-cdn.com/4.2.0/bundle.min.js'
+
+        [ javascript_include_tag(script, crossorigin: :anonymous),
+          content_tag(:script, %Q{Raven.config("#{sentry_dsn}").install();}.html_safe)
+        ].join("\n").html_safe
+      end
+    end
+
+    module Controller
+      extend ActiveSupport::Concern
+
+      included do
+        before_action :set_raven_context
+      end
+
+      def set_raven_context
+        return unless helpers.sentry_dsn
+        Raven.extra_context(params: params.dup.permit!.to_hash, url: request.url)
+        Raven.user_context(ip_address: request.remote_ip)
+      end
+    end
+  end
+end

data/lib/kubelink/version.rb

@@ -0,0 +1,3 @@
+module Kubelink
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: kubelink
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martino di Filippo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lograge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: prometheus_exporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: sentry-raven
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- difilippo@shaman.xyz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kubelink.gemspec
+- lib/kubelink.rb
+- lib/kubelink/config.rb
+- lib/kubelink/health.rb
+- lib/kubelink/prometheus.rb
+- lib/kubelink/sentry.rb
+- lib/kubelink/version.rb
+homepage: https://git.shaman.xyz/shaman/kubelink
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Integrate a Rails app with our Kubernetes environment
+test_files: []