glb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e9b2940b5d66eed7e9a2a998d8f2a6d38a0407277d22fdc242371b44235e5cc
+  data.tar.gz: 21bc007d1f5347d8948492e291ba7f0d238d4c7005124b367ab14bf9e423ab7a
+SHA512:
+  metadata.gz: 6e9a3a1d25a8ccb9ab4d03eb35d049db46f67a1dfe5562a839840a6c510f5bda518c261dcc02d3dc0cb970e2a8ff3ef2e6bf5ae50137f1fa223b77f927b5056b
+  data.tar.gz: 3b1a02edecf4226c17708d3d92d541e3f5ac2ddb4ebfa8a79687f7833a8da139333970db4685cf7d7e9cd89eac98082a7e2ffd6ba90850ced95012586a451f44

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+/.bundle
+/.config
+/.yardoc
+/_yardoc
+/coverage
+/doc/
+/Gemfile.lock
+/InstalledFiles
+/lib/bundler/man
+/pkg
+/rdoc
+/spec/reports
+/test/tmp
+/test/version_tmp
+/tmp

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
+
+## [0.1.0]
+- Initial release.

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem dependencies in glb.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Guardfile

@@ -0,0 +1,19 @@
+guard "bundler", cmd: "bundle" do
+  watch("Gemfile")
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1 @@
+Proprietary, All rights reserved. For licensing and terms, please refer to https://www.boltops.com/terms

data/README.md

@@ -0,0 +1,51 @@
+# Glb
+
+Create and delete Google Load Balancer components.
+
+Pros:
+
+* The tool wraps gcloud commands. This helps those who are familiar with gcloud commands and are referencing google cloud docs.
+
+Cons/Limitations:
+
+* The tool assumes that the source of truth is the configuration. It does not detect and will update and overwrite any manual changes that does not match the configuration.
+* This is notably different from terraform which will perform a diff calculation, which can provide a diff in the plan.
+* The `gcloud compute [RESOURCE] update` will not run if there are no attributes in the command, else `gcloud` reports an error.
+
+## Usage
+
+Commands:
+
+    glb plan APP
+    glb up APP
+    glb down APP
+    glb show APP
+
+APP is your app name. IE: demo
+
+## Docs
+
+* [External Load Balancer (Global)](docs/external.md)
+* [Internal Load Balancer (Region)](docs/internal.md)
+
+## Resources
+
+The tool creates these resources:
+
+* firewall rule
+* health check
+* backend service
+* url map
+* target http proxy
+* forwarding rule
+
+If SSL is enabled it'll also create a
+
+* target https proxy (associated with the same url map)
+* forwarding rule (associated with the target https proxy)
+
+The same url map is used because that's what shows up as a Load Balancer in the Google console.
+
+## Installation
+
+    gem install glb

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task default: :spec
+
+RSpec::Core::RakeTask.new

data/docs/external.md

@@ -0,0 +1,19 @@
+# External Load Balancer (global)
+
+.glb/config.rb
+
+```ruby
+Glb.configure do |config|
+  config.firewall_rule.network = "dev"
+  config.firewall_rule.target_tags = "demo-web-dev"
+  config.firewall_rule.rules = "tcp:8080"
+
+  config.network_endpoint_group = "demo-web-dev-80-neg"
+
+  config.health_check.port = 8080
+end
+```
+
+To create load balancer run:
+
+    glb up demo

data/docs/internal.md

@@ -0,0 +1,65 @@
+# Internal Load Balancer (region)
+
+Internal load balancers require a configuration that includes region, network, and subnet. It also requires a firewall rule allowing the access from the load balancer proxy only subnet. 
+
+## Recommended config.lb shorthand
+
+Here's an example with the suggested `config.rb` options:
+
+```ruby
+Glb.configure do |config|
+  config.firewall_rule.target_tags = "gke-dev-cluster-9696112c-node"
+  config.firewall_rule.rules = "tcp:8080"
+  config.health_check.port = 8080
+  config.backend_service.add_backend.network_endpoint_group = "demo-web-dev-80-neg"
+
+  # ranges:
+  # load balancer health check: 130.211.0.0/22,35.191.0.0/16
+  # dev-proxy: 10.80.1.0/24
+  config.firewall_rule.source_ranges = "130.211.0.0/22,35.191.0.0/16,10.80.1.0/24"
+
+  # internal load balancer shorthand config.lb. maps to health_check, backend_service, url_map, target_http_proxy, forwarding_rule options
+  config.lb.region = "us-central1"
+  config.lb.load_balancing_scheme = "INTERNAL_MANAGED"
+  config.lb.network = "dev"
+  config.lb.subnet = "dev-app"
+end
+```
+
+## Explicit config long form
+
+You can also more explicitly set each component options. The previous config is the same as this one below.  The `config.lb` options simply map to the underlying resource options.
+
+```ruby
+Glb.configure do |config|
+  config.firewall_rule.target_tags = "gke-dev-cluster-9696112c-node"
+  config.firewall_rule.rules = "tcp:8080"
+  config.health_check.port = 8080
+  config.backend_service.add_backend.network_endpoint_group = "demo-web-dev-80-neg"
+
+  # ranges:
+  # load balancer health check: 130.211.0.0/22,35.191.0.0/16
+  # dev-proxy: 10.80.1.0/24
+  # IMPORTANT: allow the proxy only subnet to access in the firewall rule 
+  # or else you won't be able to reach the internal LB IP
+  config.firewall_rule.source_ranges = "130.211.0.0/22,35.191.0.0/16,10.80.1.0/24"
+
+  # internal load balancer: specific resource options
+  config.health_check.region = "us-central1"
+  config.backend_service.load_balancing_scheme = "INTERNAL_MANAGED"
+  config.backend_service.region = "us-central1"
+  config.backend_service.health_checks_region = "us-central1"
+  config.backend_service.add_backend.region = "us-central1"
+  config.url_map.region = "us-central1" # not updatable
+  config.target_http_proxy.region = "us-central1"
+  config.forwarding_rule.region = "us-central1"
+  config.forwarding_rule.network = "dev"
+  config.forwarding_rule.subnet = "dev-app"
+  config.forwarding_rule.load_balancing_scheme = "INTERNAL_MANAGED"
+  config.forwarding_rule.target_http_proxy_region = "us-central1"
+end
+```
+
+To create load balancer run:
+
+    glb up demo

data/docs/ssl.md

@@ -0,0 +1,33 @@
+# SSL or HTTPS support
+
+Below are examples on how to configure ssl.
+
+## External (global)
+
+Create the google managed cert.
+
+    gcloud compute ssl-certificates create demo-dev --global --domains demo-dev.example.com
+
+.glb/config.rb
+
+```ruby
+Glb.configure do |config|
+  config.lb.ssl_enabled = true
+  config.lb.ssl_certificates = "demo-dev"
+end
+```
+
+## Internal (region)
+
+Create the google unmanaged cert.
+
+    gcloud compute ssl-certificates create demo-dev --certificate certificate.crt --certificate ca_bundle.crt --private-key private.key
+
+.glb/config.rb
+
+```ruby
+Glb.configure do |config|
+  config.lb.ssl_enabled = true
+  config.lb.ssl_certificates = "demo-dev"
+end
+```

data/docs/static-ip-address.md

@@ -0,0 +1,30 @@
+# Static IP Address
+
+## External (global)
+
+To configure a pre-allocated static ip address:
+
+    gcloud compute addresses create demo-dev --global
+    gcloud compute addresses create demo-https-dev --global # if using https
+
+.glb/config.rb
+
+```ruby
+Glb.configure do |config|
+  config.firewall_rule.network = "dev"
+  config.firewall_rule.target_tags = "demo-web-dev"
+  config.firewall_rule.rules = "tcp:8080"
+
+  config.network_endpoint_group = "demo-web-dev-80-neg"
+
+  config.health_check.port = 8080
+
+  config.forwarding_rule.address = "demo-dev"
+  # config.forwarding_rule_https.address = "demo-https-dev" # if using https
+end
+```
+
+IMPORTANT: The [gcloud compute forwarding-rules update](https://cloud.google.com/sdk/gcloud/reference/compute/forwarding-rules/update) command does not support updating the static IP address. You have to delete the forwarding rule and recreate it.
+
+    gcloud compute forwarding-rules delete demo-dev --global
+

data/exe/glb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# Trap ^C
+Signal.trap("INT") {
+  puts "\nCtrl-C detected. Exiting..."
+  sleep 0.1
+  exit
+}
+
+$:.unshift(File.expand_path("../../lib", __FILE__))
+require "glb"
+require "glb/cli"
+
+Glb::CLI.start(ARGV)

data/glb.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "glb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "glb"
+  spec.version       = Glb::VERSION
+  spec.authors       = ["Tung Nguyen"]
+  spec.email         = ["tongueroo@gmail.com"]
+  spec.summary       = "Google Load Balanacer Tool"
+  spec.homepage      = "https://github.com/boltops-tools/glb"
+  spec.license       = "Apache2.0"
+
+  spec.files         = File.directory?('.git') ? `git ls-files`.split($/) : Dir.glob("**/*")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "dsl_evaluator"
+  spec.add_dependency "memoist"
+  spec.add_dependency "rainbow"
+  spec.add_dependency "thor"
+  spec.add_dependency "zeitwerk"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "cli_markdown"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/glb/autoloader.rb

@@ -0,0 +1,21 @@
+require "zeitwerk"
+
+module Glb
+  class Autoloader
+    class Inflector < Zeitwerk::Inflector
+      def camelize(basename, _abspath)
+        map = { cli: "CLI", version: "VERSION" }
+        map[basename.to_sym] || super
+      end
+    end
+
+    class << self
+      def setup
+        loader = Zeitwerk::Loader.new
+        loader.inflector = Inflector.new
+        loader.push_dir(File.dirname(__dir__)) # lib
+        loader.setup
+      end
+    end
+  end
+end

data/lib/glb/cli/base.rb

@@ -0,0 +1,15 @@
+class Glb::CLI
+  class Base
+    include Glb::Util::Sh
+
+    attr_reader :options
+    def initialize(options)
+			@options = options
+			@name = options[:name] # IE: demo-web-dev
+    end
+
+    def region
+      @options[:region] || ENV['GOOGLE_REGION'] || "us-central1"
+    end
+  end
+end

data/lib/glb/cli/help/completion.md

@@ -0,0 +1,20 @@
+## Examples
+
+    glb completion
+
+Prints words for TAB auto-completion.
+
+    glb completion
+    glb completion hello
+    glb completion hello name
+
+To enable, TAB auto-completion add the following to your profile:
+
+    eval $(glb completion_script)
+
+Auto-completion example usage:
+
+    glb [TAB]
+    glb hello [TAB]
+    glb hello name [TAB]
+    glb hello name --[TAB]

data/lib/glb/cli/help/completion_script.md

@@ -0,0 +1,3 @@
+To use, add the following to your `~/.bashrc` or `~/.profile`
+
+    eval $(glb completion_script)

data/lib/glb/cli/help.rb

@@ -0,0 +1,11 @@
+class Glb::CLI
+  module Help
+    class << self
+      def text(namespaced_command)
+        path = namespaced_command.to_s.gsub(':','/')
+        path = File.expand_path("../help/#{path}.md", __FILE__)
+        IO.read(path) if File.exist?(path)
+      end
+    end
+  end
+end

data/lib/glb/cli.rb

@@ -0,0 +1,48 @@
+module Glb
+  class CLI < Command
+    class_option :verbose, type: :boolean
+    class_option :noop, type: :boolean
+
+    desc "plan", "plan load balancer"
+    long_desc Help.text("plan")
+    def plan(name)
+      Glb::Lb.new(@options.merge(name: name)).plan
+    end
+
+    desc "up", "create or update load balancer"
+    long_desc Help.text("up")
+    def up(name)
+      Glb::Lb.new(@options.merge(name: name)).up
+    end
+
+    desc "show", "show load balancer"
+    long_desc Help.text("show")
+    option :format, desc: "formats: config, csv, default, diff, disable, flattened, get, json, list, multi, none, object, table, text, value, yaml"
+    def show(name)
+      Glb::Lb.new(@options.merge(name: name)).show
+    end
+
+    desc "down", "down load balancer"
+    long_desc Help.text("down")
+    def down(name)
+      Glb::Lb.new(@options.merge(name: name)).down
+    end
+
+    desc "completion *PARAMS", "Prints words for auto-completion."
+    long_desc Help.text(:completion)
+    def completion(*params)
+      Completer.new(CLI, *params).run
+    end
+
+    desc "completion_script", "Generates a script that can be eval to setup auto-completion."
+    long_desc Help.text(:completion_script)
+    def completion_script
+      Completer::Script.generate
+    end
+
+    desc "version", "prints version"
+    def version
+      puts VERSION
+    end
+  end
+end

data/lib/glb/command.rb

@@ -0,0 +1,91 @@
+require "thor"
+
+# Override thor's long_desc identation behavior
+# https://github.com/erikhuda/thor/issues/398
+class Thor
+  module Shell
+    class Basic
+      def print_wrapped(message, options = {})
+        message = "\n#{message}" unless message[0] == "\n"
+        stdout.puts message
+      end
+    end
+  end
+end
+
+module Glb
+  class Command < Thor
+    class_option :yes, aliases: :y, type: :boolean
+
+    class << self
+      def dispatch(m, args, options, config)
+        # Allow calling for help via:
+        #   glb command help
+        #   glb command -h
+        #   glb command --help
+        #   glb command -D
+        #
+        # as well thor's normal way:
+        #
+        #   glb help command
+        help_flags = Thor::HELP_MAPPINGS + ["help"]
+        if args.length > 1 && !(args & help_flags).empty?
+          args -= help_flags
+          args.insert(-2, "help")
+        end
+
+        #   glb version
+        #   glb --version
+        #   glb -v
+        version_flags = ["--version", "-v"]
+        if args.length == 1 && !(args & version_flags).empty?
+          args = ["version"]
+        end
+
+        super
+      end
+
+      # Override command_help to include the description at the top of the
+      # long_description.
+      def command_help(shell, command_name)
+        meth = normalize_command_name(command_name)
+        command = all_commands[meth]
+        alter_command_description(command)
+        super
+      end
+
+      def alter_command_description(command)
+        return unless command
+
+        # Add description to beginning of long_description
+        long_desc = if command.long_description
+            "#{command.description}\n\n#{command.long_description}"
+          else
+            command.description
+          end
+
+        # add reference url to end of the long_description
+        unless website.empty?
+          full_command = [command.ancestor_name, command.name].compact.join('-')
+          url = "#{website}/reference/glb-#{full_command}"
+          long_desc += "\n\nHelp also available at: #{url}"
+        end
+
+        command.long_description = long_desc
+      end
+      private :alter_command_description
+
+      # meant to be overriden
+      def website
+        ""
+      end
+
+      # https://github.com/erikhuda/thor/issues/244
+      # Deprecation warning: Thor exit with status 0 on errors. To keep this behavior, you must define `exit_on_failure?` in `Lono::CLI`
+      # You can silence deprecations warning by setting the environment variable THOR_SILENCE_DEPRECATION.
+      def exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/lib/glb/completer/script.rb

@@ -0,0 +1,8 @@
+class Glb::Completer
+  class Script
+    def self.generate
+      bash_script = File.expand_path("script.sh", File.dirname(__FILE__))
+      puts "source #{bash_script}"
+    end
+  end
+end

data/lib/glb/completer/script.sh

@@ -0,0 +1,10 @@
+_glb() {
+  COMPREPLY=()
+  local word="${COMP_WORDS[COMP_CWORD]}"
+  local words=("${COMP_WORDS[@]}")
+  unset words[0]
+  local completion=$(glb completion ${words[@]})
+  COMPREPLY=( $(compgen -W "$completion" -- "$word") )
+}
+
+complete -F _glb glb