kubert 0.0.1.pre.dev6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df48773e44f09c65f555a75fe4303e33ad1c597c
-  data.tar.gz: ba0e595e8f60e62f6b6f0340d7c9629430157108
+  metadata.gz: 13d3f33521c6405a0742f4ad72762bae8eb98039
+  data.tar.gz: f6063a35ffe1f8146b779f515f1646bc448286c4
 SHA512:
-  metadata.gz: b2e861857520e53524f27dfd461e5d058e4ba4e7f011bc9945f1f3ef9a995f8e3493e2713a5a692480b6d4afdc4db6fb57b855cf20cfb6ec61fd5bf7cd527a26
-  data.tar.gz: 969626a019d04a92f3a70f168f07ba8328cd565da3489afbdc7fea797ac5212a06d8b8e1c3e7b68e0ce7fc430d1b8147f1f9c9ac58e940623a6103f5776d92a1
+  metadata.gz: cad02b12eabe8d9bf7d6edac689ec48c91f6ebaaeef5da59a96624ac0a0071dd67165454419bd25fbd18dc631d87a4f0727bedd41e4ee2d2d04b3ed2acb2854d
+  data.tar.gz: 2c9545f878499dba963ef758ee5bcb4f56a6c0057d7901cbd87493d333d9b67f957923888484cdaa8fb641b6513393d252ff8c521fff6bb6b10414ab38022534

data/README.md

@@ -1,37 +1,48 @@
-# Kubert
+# Kubert - Your helpful kubernetes ruby terminal friend!
 
-## Installation
+## The gem relies on a second gem, [ky](https://github.com/stellaservice/ky) which may be used independently
 
-Add this line to your application's Gemfile:
+# Install gem via `gem install kubert` as usual.  This will also install the ky gem, which handles configuration.
 
-```ruby
-gem 'kubert'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install kubert
-
-## Usage
+Kubert assumes your kubernetes config file lives in `~/.kube/config` and reads that to talk to the cluster.
 
-TODO: Write usage instructions here
+If you don't intend to use KY for generating your deployment yml, you can ignore kubert's compile and rollback methods, which rely on ky and a Procfile to define the scope of a deployment as a group of related, seperate kubernetes deployments.  Typing `ky example` at the console will import example ky configuration, including kubert configuration.  You may ignore most of this if not using ky itself, and focus primarily on the kubert section of the yml for a few pieces of kubert configuration...  the important ones are these:
 
-## 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.
+```
+project_name: "my-project"
+kubert:
+  contexts:
+    staging: staging.example.com
+    prod: production.example.com
+  excluded_deployments: [sanitize, migration]
+  default_environment: stg
+  default_namespace: default
+  task_pod: console
+  console_command: rails c
+  command_prefix: bundle exec
+```
 
-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).
+The project name is used by ky and assumes a metadata namespace for your app deployments in the format of `{{project_name}}-{{deployment_name}}`, so as long as your deployments obey this pattern it should be usable for you without ky.
+contexts is used to create convenience functions for switching between different clusters defined in the same kubeconfig file, i.e. `kubert staging` with above config will switch/ensure your config is using staging.example.com
 
-## Contributing
+excluded_deployments says not to deploy the following deployments defined in your Procfile during a normal deployment, and not to rollback during a rollback.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kubert.
+default_environment and/or default_namespace are optional but effect pod selection if no task_pod is defined, and effect default target environment for deployment and rollback if not specified via CLI flags.
 
+Task pod is what is used for running consoles and executing tasks.  If not defined it selects a random pod and uses that pod's type, though it is splitting on dashes so may not work if your pod type has dashes in its deployment name at present.
 
-## License
+console_command and console_prefix are for opening a REPL and for prefixing all task commands with a common prefix
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+###Example usage
+```
+$ kubert console                  # open a console on a task_pod
+$ kubert execute rake db:migrate  # run a migration
+$ kubert list web                 # list all running web pods
+$ kubert sandbox                  # only if rails c/rails console is console_command above, opens console wrapped in DB transaction
+$ kubert context                  # print current kubectl context/cluster
+$ kubert deploy -e prd            # perform a production deployment
+$ kubert rollback -e prd          # rollback a production deployment
+$ kubert deploy                   # perform a deployment to the default environment
+```
 
+A valid url may also be used in place of a file path for input.

data/kubert.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.add_runtime_dependency 'thor', '~> 0.19'
   spec.add_runtime_dependency 'kubeclient', '~> 2'
-  spec.add_runtime_dependency 'ky', '~> 0.5.2.pre1'
+  spec.add_runtime_dependency 'ky', '~> 0.6'
   spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/kubert.rb

@@ -13,14 +13,30 @@ module Kubert
     configuration[:contexts] || []
   end
 
+  def self.task_pod
+    configuration[:task_pod] || random_pod_type
+  end
+
   def self.default_environment
     configuration[:default_environment]
   end
 
+  def self.default_namespace
+    configuration[:default_namespace] || configuration[:default_environment]
+  end
+
   def self.context
     kube_config.contexts.select {|c| kube_config.context.api_endpoint.match(c) }
   end
 
+  def self.console_command
+    Array(configuration[:console_command] && configuration[:console_command].split(" "))
+  end
+
+  def self.command_prefix
+    configuration[:command_prefix]
+  end
+
   def self.excluded_deployments
     configuration[:excluded_deployments] || []
   end
@@ -44,4 +60,22 @@ module Kubert
       )
     end
   end
+
+  private
+
+  def self.random_pod_type
+    Kubert.client.get_pods(namespace: current_namespace)
+    .sample
+    .metadata
+    .name
+    .split("-")
+    .first
+  end
+
+  def self.current_namespace
+    KY::Configuration.new[:namespace]   ||
+    default_namespace                   ||
+    (raise "MUST DEFINE A NAMESPACE FOR POD OPERATIONS, ky namespace, default_namespace or default_environment")
+  end
+
 end

data/lib/kubert/cli.rb

@@ -4,7 +4,7 @@ require "irb"
 module Kubert
   class Cli < Thor
 
-    desc "list pod_type", "display a list of one type of Pod, only Ready by default"
+    desc "list pod_type", "Display a list of one type of Pod, only Running by default"
     def list(pod_type, status=:running)
       puts Pods.list(pod_type, status)
     end
@@ -14,17 +14,19 @@ module Kubert
       puts Kubert.context
     end
 
-    desc "sandbox", "Connect to a Rails console in sandbox that will wrap session in DB transaction and rollback when done"
-    def sandbox
-      execute("rails", "console", "--sandbox")
+    if Kubert.console_command.first == "rails"
+      desc "sandbox", "Connect to a Rails console in sandbox that will wrap session in DB transaction and rollback when done"
+      def sandbox
+        execute(*Kubert.console_command, "--sandbox")
+      end
     end
 
-    desc "console", "Connect to a Rails console on a console pod"
+    desc "console", "Connect to a console on a task pod"
     def console
-      execute("rails", "console")
+      execute(*Kubert.console_command)
     end
 
-    desc "execute command", "Connect to a pod run the specified command (with bundle exec prefix)"
+    desc "execute command", "Connect to a task pod and run the specified command (with #{Kubert.command_prefix} prefix)"
     def execute(*command)
       Pods.execute(command)
     end
@@ -40,7 +42,7 @@ module Kubert
       Deployment.perform(options)
     end
 
-    desc "rollback", "Connect to a pod run the specified command (with bundle exec prefix)"
+    desc "rollback", "Rollback a deployment, reverse of a kubert deploy command with same flags"
     method_option :namespace, type: :string, aliases: "-n"
     method_option :environment, type: :string, aliases: "-e"
     method_option :image_tag, type: :string, aliases: "-t"

data/lib/kubert/pods.rb

@@ -32,9 +32,9 @@ module Kubert
       pods.map(&:metadata).map(&:name)
     end
 
-    def execute(command)
-      pod = all('console').status(:running).pods.sample
-      exec_command = "kubectl exec -n #{pod.metadata.namespace} #{pod.metadata.name} -it bundle exec #{command.join(' ')}"
+    def execute(command, pod_type=Kubert.task_pod)
+      pod = all(pod_type).status(:running).pods.sample
+      exec_command = "kubectl exec -n #{pod.metadata.namespace} #{pod.metadata.name} -it #{Kubert.command_prefix} #{command.join(' ')}"
       puts "Executing command: \n#{exec_command}"
       Open3.popen3("bash") do
         exec exec_command

data/lib/kubert/version.rb

@@ -1,3 +1,3 @@
 module Kubert
-  VERSION = "0.0.1-dev6"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubert
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre.dev6
+  version: 0.1.0
 platform: ruby
 authors:
 - Brian Glusman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2.pre1
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2.pre1
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -149,9 +149,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8