gitlab-cluster-helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b0d3dfbb8dee26f71a7365cf7bd10d21388154e4e17dfc7289ccfe58afe12ee
+  data.tar.gz: ad916830538153410269717311b0da002d72817457b840475dfd45945fd863c7
+SHA512:
+  metadata.gz: 6222e71d29a7144f954147187e482373e047990d46bd719502d4c2d5a1d236e58b0dba38eb0ae077ef75c14f3c4991cde17ef0e1feaa2ffa92a658e1734208f8
+  data.tar.gz: 8fc553492b555b557e225e1b9b6f5b01a5377a7d714b3c7b683ec9f3a154eb962a672947330a68dcaea6d785dd95b348f11b806460e2d4e641a4bf2f3316e2a3

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/Gemfile.lock

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.4
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gitlab-cluster-helper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Dylan Griffith
+
+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,97 @@
+# Gitlab Cluster Helper
+This is a command line tool you can run locally to help you create and delete clusters easily for doing local development with GitLab features that require a Kubernetes cluster. It will orchestrate Kubernetes cluster and should speed up your development compared to doing all of the setup manually each time you want to try something out.
+It's very common to need to create a new cluster every time you need to test
+out a new feature and then since it's difficult to re-use a cluster for running
+the same test again you will usually find that you need to destroy and recreate
+a new cluster which can take time.
+
+The goal of this tool is to speed up this flow by doing the following things
+for you:
+
+- [X] Create clusters
+- [X] Delete clusters when you are done with them
+- [X] Have one spare cluster ready to go at all times (so you don't need to
+      wait minutes to get a new cluster)
+- [ ] Add the cluster directly to GitLab to save you copy/pasting
+
+## Installation
+
+```
+$ gem install gitlab-cluster-helper
+```
+
+## Usage
+
+### Setup `gcloud` and `kubectl`
+
+If you have been doing GCP and Kubernetes stuff locally you will probably
+already have these setup and can therefor skip these instructions.
+
+If not following the instructions at https://cloud.google.com/sdk/install .
+
+After installing `gcloud` you can install `kubectl` like:
+
+```
+$  gcloud components install kubectl
+```
+
+Make sure you're also signed in to `gcloud` by running:
+
+```
+$ gcloud auth login
+```
+
+### Set up the config file
+
+Create a file at `~/.gitlab-cluster-helper-config.json` with the following content:
+
+```json
+{
+  "gcp_project": "Enter the GCP project ID here",
+  "gcp_zone": "The zone where clusters are created (eg. us-central1-a)",
+  "cluster_prefix": "The prefix to use for naming your clusters (eg. dgriffith)"
+}
+```
+
+### Run the application
+
+```
+$ gitlab-cluster-helper
+c) Create new cluster and show credentials
+q) Quit application and clean up any clusters that were created
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. 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).
+
+### Running mocked GCP locally
+
+When testing the application locally you may prefer to not really be creating
+GCP clusters. So you can easily used a mocked version that sleeps for 5s before
+creating a fake cluster:
+
+```bash
+$ ruby -I lib -r gitlab_cluster_helper/dummy_gcp_client exe/gitlab-cluster-helper
+```
+
+The 5s delay helps with testing out the behaviour where it starts creating the
+next cluster before you've asked for it.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at
+https://gitlab.com/DylanGriffith/gitlab-cluster-helper/issues .
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gitlab/cluster/helper"
+
+# 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/exe/gitlab-cluster-helper

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'gitlab_cluster_helper'
+
+GitlabClusterHelper::Runner.new.start

data/gitlab-cluster-helper.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gitlab_cluster_helper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gitlab-cluster-helper"
+  spec.version       = GitlabClusterHelper::VERSION
+  spec.authors       = ["Dylan Griffith"]
+  spec.email         = ["dyl.griffith@gmail.com"]
+
+  spec.summary       = %q{GitLab Cluster Helper helps you work with clusters when doing local GitLab development.}
+  spec.description   = %q{GitLab Cluster Helper helps you work with clusters when doing local GitLab development.}
+  spec.homepage      = "https://gitlab.com/DylanGriffith/gitlab-cluster-helper"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://gitlab.com/DylanGriffith/gitlab-cluster-helper"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/gitlab_cluster_helper.rb

@@ -0,0 +1,11 @@
+require "gitlab_cluster_helper/cluster"
+require "gitlab_cluster_helper/config"
+require "gitlab_cluster_helper/gcp_client"
+require "gitlab_cluster_helper/manager"
+require "gitlab_cluster_helper/messages"
+require "gitlab_cluster_helper/runner"
+require "gitlab_cluster_helper/shell"
+require "gitlab_cluster_helper/version"
+
+class GitlabClusterHelper
+end

data/lib/gitlab_cluster_helper/cluster.rb

@@ -0,0 +1,12 @@
+class GitlabClusterHelper
+  class Cluster
+    attr_reader :name, :api_url, :ca_certificate, :token
+
+    def initialize(name:,api_url:,ca_certificate:,token:)
+      @name = name
+      @api_url = api_url
+      @ca_certificate = ca_certificate
+      @token = token
+    end
+  end
+end

data/lib/gitlab_cluster_helper/config.rb

@@ -0,0 +1,27 @@
+require 'singleton'
+require 'pathname'
+
+class GitlabClusterHelper
+  class Config
+    include Singleton
+
+    class Error < StandardError; end
+
+    attr_reader :gcp_project, :gcp_zone, :cluster_prefix
+
+    DEFAULT_PATH = Pathname.new('~').join('.gitlab-cluster-helper-config.json').expand_path
+
+    def initialize
+      path = ENV["GITLAB_CLUSTER_HELPER_CONFIG"] || DEFAULT_PATH
+
+      raise Error, "Config file does not exist at path: #{path}" unless Pathname.new(path).file?
+
+      json = File.read(path)
+      data = JSON.parse(json)
+
+      @gcp_project = data['gcp_project']
+      @gcp_zone = data['gcp_zone']
+      @cluster_prefix = data['cluster_prefix']
+    end
+  end
+end

data/lib/gitlab_cluster_helper/dummy_gcp_client.rb

@@ -0,0 +1,20 @@
+require 'gitlab_cluster_helper'
+
+class GitlabClusterHelper
+  class GcpClient
+    def create_cluster
+      sleep 5
+
+      Cluster.new({
+        name: "fake-cluster-#{Time.now.strftime("%Y-%m-%dt%Hh%Mm%Ss")}",
+        api_url: 'fake-url',
+        ca_certificate: 'fake certificate',
+        token: 'fake-token'
+      })
+    end
+
+    def delete_cluster(cluster_name)
+      puts "Deleting: #{cluster_name}"
+    end
+  end
+end

data/lib/gitlab_cluster_helper/gcp_client.rb

@@ -0,0 +1,62 @@
+require 'json'
+require 'base64'
+
+class GitlabClusterHelper
+  class GcpClient
+    def initialize(config: GitlabClusterHelper::Config.instance, shell: GitlabClusterHelper::Shell.new)
+      @config = config
+      @shell = shell
+    end
+
+    def create_cluster
+      cluster_name = "#{@config.cluster_prefix}-#{Time.now.strftime("%Y-%m-%dt%Hh%Mm%Ss")}"
+      @shell.run([*gcloud, 'container', 'clusters', 'create', '--zone', @config.gcp_zone, cluster_name, '--enable-basic-auth'])
+
+      @shell.run([*gcloud, 'container', 'clusters', 'get-credentials', '--zone', @config.gcp_zone, cluster_name])
+
+      api_url = @shell.run(['kubectl', 'config', 'view', '--minify', '-o', "jsonpath='{.clusters[].cluster.server}'"])
+
+      auth_json = @shell.run([*gcloud, 'container', 'clusters', 'describe', '--zone', @config.gcp_zone, cluster_name, '--format', "json(masterAuth.username, masterAuth.password)"])
+
+      auth_data = JSON.parse(auth_json)
+      username = auth_data['masterAuth']['username']
+      password = auth_data['masterAuth']['password']
+
+      @shell.run(['kubectl', 'config', 'set-credentials', cluster_name, '--username', username, '--password', password])
+
+      @shell.run(['kubectl', 'create', 'serviceaccount', 'gitlab'])
+
+      @shell.run([
+        'kubectl', '--user', username,
+        'create', 'clusterrolebinding',
+        '--serviceaccount=default:gitlab', '--clusterrole=cluster-admin', 'gitlab-admin'
+      ])
+
+      secrets_json = @shell.run(['kubectl', 'get', 'secrets', '-o', 'json'])
+      secrets_data = JSON.parse(secrets_json)
+      gitlab_account = secrets_data['items'].find do |item|
+        item['metadata']['annotations']['kubernetes.io/service-account.name'] == 'gitlab'
+      end
+
+      ca_certificate = Base64.decode64(gitlab_account['data']['ca.crt'])
+      token = Base64.decode64(gitlab_account['data']['token'])
+
+      Cluster.new(
+        name: cluster_name,
+        api_url: api_url,
+        ca_certificate: ca_certificate,
+        token: token
+      )
+    end
+
+    def delete_cluster(cluster_name)
+      @shell.run([*gcloud, 'container', 'clusters', 'delete', '--zone', @config.gcp_zone, cluster_name, '--quiet', '--async'])
+    end
+
+    private
+
+    def gcloud
+      ['gcloud', '--project', @config.gcp_project]
+    end
+  end
+end

data/lib/gitlab_cluster_helper/manager.rb

@@ -0,0 +1,38 @@
+class GitlabClusterHelper
+  class Manager
+    def initialize(gcp_client: GitlabClusterHelper::GcpClient.new)
+      @gcp_client = gcp_client
+      @clusters = []
+      @next_cluster = nil
+      create_next_cluster
+    end
+
+    def create
+      @next_cluster_thread.join
+      cluster = @next_cluster
+      @next_cluster = nil
+      @clusters << cluster
+
+      create_next_cluster
+      cluster
+    end
+
+    def cleanup
+      @clusters.each do |cluster|
+        @gcp_client.delete_cluster(cluster.name)
+      end
+
+      @next_cluster_thread.join
+
+      @gcp_client.delete_cluster(@next_cluster.name)
+    end
+
+    def create_next_cluster
+      @next_cluster_thread = Thread.new {
+        next_cluster = @gcp_client.create_cluster
+
+        @next_cluster = next_cluster
+      }
+    end
+  end
+end

data/lib/gitlab_cluster_helper/messages.rb

@@ -0,0 +1,7 @@
+class GitlabClusterHelper
+  module Messages
+    CREATE = "Create new cluster and show credentials"
+    QUIT = "Quit application and clean up any clusters that were created"
+    GOODBYE = "Goodbye!"
+  end
+end

data/lib/gitlab_cluster_helper/runner.rb

@@ -0,0 +1,52 @@
+require 'readline'
+
+class GitlabClusterHelper
+  class Runner
+    def initialize(manager: GitlabClusterHelper::Manager.new, readline_class: Readline, output: $stdout)
+      @manager = manager
+      @readline_class = readline_class
+      @output = output
+    end
+
+    def start
+      print_help
+
+      while line = @readline_class.readline('> ', true)
+        if command = commands[line]
+          command[:command].call
+        end
+
+        @output.puts Messages::GOODBYE && break if line == 'q'
+
+        print_help
+      end
+    end
+
+    private
+
+    def commands
+      {
+        'c' => { message: Messages::CREATE, command: method(:create) },
+        'q' => { message: Messages::QUIT, command: @manager.method(:cleanup) },
+      }
+    end
+
+    def create
+      cluster = @manager.create
+
+      @output.puts <<~END
+      Name: #{cluster.name}
+      Api URL: #{cluster.api_url}
+      Ca Certificate:
+      #{cluster.ca_certificate}
+      Token: #{cluster.token}
+      END
+    end
+
+    def print_help
+      commands.each do |key, command|
+        @output.puts "#{key}) #{command[:message]}"
+      end
+    end
+  end
+end

data/lib/gitlab_cluster_helper/shell.rb

@@ -0,0 +1,26 @@
+require 'open3'
+
+class GitlabClusterHelper
+  class Shell
+    class Error < StandardError; end
+
+    def run(command)
+      puts "Running command: #{command.join(" ")}"
+      stdin, stdout, stderr, wait_thr = Open3.popen3(*command)
+
+      stdin.close
+
+      out = stdout.read
+      stdout.close
+
+      err = stderr.read
+      stderr.close
+
+      exit_status = wait_thr.value
+
+      raise Error, out + err unless exit_status.success?
+
+      out.chomp
+    end
+  end
+end

data/lib/gitlab_cluster_helper/version.rb

@@ -0,0 +1,3 @@
+class GitlabClusterHelper
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: gitlab-cluster-helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dylan Griffith
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: GitLab Cluster Helper helps you work with clusters when doing local GitLab
+  development.
+email:
+- dyl.griffith@gmail.com
+executables:
+- gitlab-cluster-helper
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gitlab-cluster-helper
+- gitlab-cluster-helper.gemspec
+- lib/gitlab_cluster_helper.rb
+- lib/gitlab_cluster_helper/cluster.rb
+- lib/gitlab_cluster_helper/config.rb
+- lib/gitlab_cluster_helper/dummy_gcp_client.rb
+- lib/gitlab_cluster_helper/gcp_client.rb
+- lib/gitlab_cluster_helper/manager.rb
+- lib/gitlab_cluster_helper/messages.rb
+- lib/gitlab_cluster_helper/runner.rb
+- lib/gitlab_cluster_helper/shell.rb
+- lib/gitlab_cluster_helper/version.rb
+homepage: https://gitlab.com/DylanGriffith/gitlab-cluster-helper
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/DylanGriffith/gitlab-cluster-helper
+  source_code_uri: https://gitlab.com/DylanGriffith/gitlab-cluster-helper
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: GitLab Cluster Helper helps you work with clusters when doing local GitLab
+  development.
+test_files: []