cloud-sh 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b779b9ffb09de3a990d1f15dcadfb8dbd18c958c86836866b0ff417a20759907
+  data.tar.gz: ad1200c5af739ed5d7a0e0b21a010f5f6309b528e4e0c46a9519d12b547dda07
+SHA512:
+  metadata.gz: 8923664d58e8f4ac6794b9a2195f33d37d1ce191d1b8aa66f3791edbeff4a45e625ff8f5fa11063326322ef5ece9f5e509b091d5fb7cd767a35a646ae422cef4
+  data.tar.gz: ac512fa615a6ace8b00f8f50aabeed62a6bdf2c6af29d0e95cabcd92e9b35f1372b7bd0381edd7fdfa0722cb852d80a5226a2845ba59ded1897a6accc23661be

data/.github/workflows/gempush.yml

@@ -0,0 +1,32 @@
+name: Ruby Gem
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    cloud-sh (1.0.0)
+      gli
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    gli (2.18.2)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  cloud-sh!
+  minitest (~> 5.0)
+  pry
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Cristian Bica
+
+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,126 @@
+# Cloud shell helpers
+
+Wrapper around `doctl`, `kubectl` to build aliases for easier access to cloud server, services. Special mention to [kubetail](https://github.com/johanhaleby/kubetail) which does the multiple kubernetes containers tailing.
+
+## Features
+
+- DigitalOcean aliases for ssh-ing to droplets
+- DigitalOcean aliases for connecting to your databases (MySQL, Postgres, Redis)
+- Refreshes DigitalOcean certificate for kubernetes
+- Kubernetes aliases for tailing single or multiple pods and opening a shell inside a pod
+
+## Installation
+
+### Requirements
+
+- recent version of ruby (2.6+)
+- kubectl
+- doctl
+- A MySQL client (mysql - version 8 needed for TLS, mycli)
+- A Postgres client (psql, pgcli)
+- Redis client (you'll need redli as it needs TLS support)
+
+### Install
+
+Install the `cloud-sh` gem
+
+```sh
+gem install cloud-sh
+```
+
+## Usage
+
+Login to your DigitalOcean account(s) using `doctl auth init --context context-name`.
+
+Write a YAML file to `~/.config/cloud-sh.yml`
+
+```
+- name: personal      # name of the account; will be used to prefix aliases
+  kind: do            # cloud kind (do - digitalocean support for now)
+  default: true       # if true don't use the name for aliases (default: false)
+  context: default    # doctl context
+  clusters:           # customize K8S clusters aliases
+  - name: k8s-01      # name as it is at DigitalOcean
+    alias: staging    # alias name to be used in aliases (defaults to name)
+    default: true     # if true don't use the name / alias (default: false)
+    ignore: true      # don't create aliases for this (default: false)
+  databases:          # customize databases aliases
+  - name: pg-01       # name as it is at DigitalOcean
+    alias: staging    # alias name to be used in aliases (defaults to name)
+    default: true     # if true don't use the name / alias (default: false)
+    ignore: true      # don't create aliases for this (default: false)
+```
+
+After that you can run `cloud-sh refresh` you'll get the aliases written to `~/.cloud_sh_aliases`.
+
+### Shell Integration
+
+1. Manual Integration
+
+Run `cloud-sh refresh` to generate the aliases in `~/cloud_sh_aliases` and load the aliases. Or run `cloud-sh help` to see the available options.
+
+
+2. Automatic Integration
+Setup a cron job for it:
+
+```
+* * * * * ~/.cloud-sh/bin/cloud-sh refresh 2>&1 | logger -t cloud-sh
+```
+
+And load the aliases using for shell. For `zsh` I'm adding to `.zshrc`:
+
+```
+reload_cloud_sh() {
+  source ~/.cloud_sh_aliases
+}
+add-zsh-hook precmd reload_cloud_sh
+```
+
+### Digital Ocean aliases
+```
+do-ssh-[account-name]-[dashed-droplet-name]
+do-psql-[account-name]-[db-cluster-name]-[db-name]
+do-pgcli-[account-name]-[db-cluster-name]-[db-name]
+do-mysql-[account-name]-[db-cluster-name]-[db-name]
+do-mycli-[account-name]-[db-cluster-name]-[db-name]
+do-redis-[account-name]-[db-cluster-name]-[db-name]
+```
+
+### K8S aliases
+
+Cloud-sh will write a `~/.kube/cloud_sh_config` with the clusters configuration for `kubectl`. If you don't have a different `kubectl` config you can make a symbolic link from `~/.kube/config` to `~/.kube/cloud_sh_config` or you pass `--kubeconfig='~/.kube/cloud_sh_config'` to `kubectl`.
+
+Note: For K8S it will try to guess a pod name by removing the groups or random groups of chars from the end (5 random alpa numeric or 8-10 hexa)
+
+```
+# Switch current kubectl context
+k8s-switch-to-[account-name]-[cluster-name]
+k8s-switch-to-personal-k8s-01 # switch to cluster k8s-01 of the account
+k8s-switch-to-k8s-01 # switch to cluster k8s-01 of the default account
+
+# Tail all pods in a namespace
+k8s-[account-name]-[cluster-name]-[namespace]-tail-all
+
+# Tail by pod name (prefix). Supported arguments:
+# -p - pod index (default: 1)
+# -c - container name (default: first found)
+# -n - number of initial lines (default: 10)
+k8s-[account-name]-[cluster-name]-[namespace]-tail-[pod-name]
+
+# Exec a shell in a specific pod. Supported arguments:
+# -p - pod index (default: 1)
+# -c - container name (default: first found)
+# -x - command to be executed (default: bash)
+k8s-[account-name]-[cluster-name]-[namespace]-exec-[-pod-name]
+
+ # if there's a pod named console then it will run bundle exec rails console in that pod
+k8s-[account-name]-[cluster-name]-[namespace]-rails-console
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cristianbica/cloud-sh.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "cloud/sh"
+
+# 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/cloud-sh.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cloud/sh/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "cloud-sh"
+  spec.version = Cloud::Sh::VERSION
+  spec.authors = ["Cristian Bica"]
+  spec.email = ["cristian.bica@gmail.com"]
+
+  spec.summary = "Cloud shell helpers."
+  spec.description = "Cloud shell helpers."
+  spec.homepage = "https://github.com/cristianbica/cloud-sh"
+  spec.license = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/cristianbica/cloud-sh"
+  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(__dir__)) 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_dependency "gli"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/exe/cloud-sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "cloud/sh"
+require "cloud/sh/cli"
+
+exit Cloud::Sh::Cli.run(ARGV)