cron-kubernetes 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f95641f4e595e197c2205b213097349df8b5f93c4f4c6556416f66bb6c1dd636
-  data.tar.gz: 3fb3993388b2f631c1b73e297a18340b45c197368a24486b7b5f3ca7cb7395bc
+  metadata.gz: 218b54415c313d661475b6f73f5cf3218b2a928e8fc65d7236a06ac480f07db1
+  data.tar.gz: 4d9a5e7687abe849a14ee8c9d817ee418be6ca22738177c65d21be1f0724f526
 SHA512:
-  metadata.gz: 128dc9682185ff67c49804d099a05056f6403ef4f25ad6161401d8fbf10881b325e141b2dd631445db2570e67c8ba499fb05eef433372e1feedc08a813c4f03e
-  data.tar.gz: 267f422c41cceee4a2bef3293918504322c6f468573eb4158898c71027b3d6ee28973178021af25cc951f9b7d26606c12c9fc77e65a132ca442a6ca6bb506584
+  metadata.gz: 545a23464d897e6b6591e5ed37c017e6330692bdbc8892f5ffccb023b32c41292af8a7ab8add6de0dc60018eb30299a56bc442166a794956f51ee547938fe62e
+  data.tar.gz: 262182d7eda44214339da475f0fd488dd20ffd702310267b34b5f80dd3e62d4da298788b88a87c76d60735ecd88334a86e00dc88d7e7df22c10cc75200684d17

data/.gitignore

@@ -1,4 +1,4 @@
-/.bundle/
+**/.bundle/
 /.yardoc
 /_yardoc/
 /coverage/
@@ -7,7 +7,7 @@
 /spec/reports/
 /tmp/
 /Gemfile.lock
-
+**/*.gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -1,3 +1,7 @@
+AllCops:
+  Exclude:
+    - "gemfiles/*"
+
 Documentation:
   Exclude:
     - "**/railtie.rb"
@@ -31,7 +35,9 @@ Style/FormatStringToken:
   EnforcedStyle: template
 Style/AsciiComments:
   Enabled: false
-
+Naming/FileName:
+  Exclude:
+    - "lib/cron-kubernetes.rb"
 Metrics/BlockLength:
   Exclude:
     - "*.gemspec"

data/Appraisals

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+appraise "kubeclient-3" do
+  gem "kubeclient", "3.1.2"
+end
+
+appraise "kubeclient-4" do
+  gem "kubeclient", "4.0.0"
+end

data/CHANGELOG.md

@@ -1,2 +1,13 @@
+# v1.1.0
+- Fix issue where all cron jobs in a cluster would be removed, not just ones matching `identifier`
+
+# v1.0.0
+**Breaking Change:**
+- Requires `kubeclient` 3.1.2 or 4.x
+
+ **Changes:**
+- Add `kubeclient` configuration option for connecting to any Kubernetes server
+- Add Appraisal for testing with kubeclient 3.1.2 and 4.x
+
 # v0.1.0
 - Initial Release

data/README.md

@@ -95,6 +95,29 @@ replace both `ENTRYPOINT` and `CMD` in the Docker image. See
 [Define a Command and Arguments for a Container](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/)
 for a discussion of how `command` works in Kubernetes.
 
+### kubeclient
+The gem will automatically connect to the Kubernetes server in the following cases:
+- You are running this in [a standard Kubernetes cluster](https://kubernetes.io/docs/tasks/access-application-cluster/access-cluster/#accessing-the-api-from-a-pod)
+- You are running on a system with `kubeclient` installed and
+  - the default cluster context has credentials
+  - the default cluster is GKE and your system has
+    [Google application default credentials](https://developers.google.com/identity/protocols/application-default-credentials)
+    installed
+
+There are many other ways to connect and you can do so by providing your own
+[configured `kubeclient`](https://github.com/abonas/kubeclient#usage):
+
+```ruby
+# config/initializers/resque-kubernetes.rb
+
+CronKubernetes.configuration do |config|
+  config.kubeclient = Kubeclient::Client.new("http://localhost:8080/apis/batch", "v1beta1")
+end
+```
+
+Because this uses the `CronJob` resource, make sure to connect to the `/apis/batch` API endpoint and 
+API version `v1beta1` in your client.
+
 ## Usage
 
 ### Create a Schedule
@@ -111,10 +134,10 @@ CronKubernetes.schedule do
 end
 ```
 
-For all jobs the command with change directories to either `Rails.root` if Rails is installed
+For all jobs the command will change directories to either `Rails.root` if Rails is installed
 or the current working directory. These are evaluated when the scheduled tasks are loaded.
 
-For all jobs you may provide a `name` to name, which will be used with the `identifier` to name the
+For all jobs you may provide a `name` that will be used with the `identifier` to name the
 CronJob. If you do not provide a name `CronKubernetes` will try to figure one out from the job and
 pod templates plus a hash of the schedule and command.
 
@@ -122,15 +145,14 @@ pod templates plus a hash of the schedule and command.
 
 A `command` runs any arbitrary shell command on a schedule. The first argument is the command to run.
 
-
 #### Rake Tasks
 
 A `rake` call runs a `rake` task on the schedule. Rake and Bundler must be installed and on the path 
-in the container The command it executes is `bundle exec rake ...`. 
+in the container. The command it executes is `bundle exec rake ...`.
 
 #### Runners
 
-A `runner` runs arbitrary ruby code under rails. Rails must be installed at `bin/rails` from the 
+A `runner` runs arbitrary ruby code under Rails. Rails must be installed at `bin/rails` from the
 working folder. The command it executes is `bin/rails runner '...'`.
 
 ### Update Your Cluster
@@ -170,21 +192,40 @@ bin/rails runner cron_kubernetes
   at: "[H]H:mm[am|pm]"
   ```
 
-## Development
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/keylime-toolbox/cron-kubernetes-ruby.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 
+1. Fork it (`https://github.com/[my-github-username]/cron-kubernetes-ruby/fork`)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Test your changes with `rake`, add new tests if needed
+4. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Open a new Pull Request
 
-You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Development
 
-To install this gem onto your local machine, run `bundle exec rake install`. 
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `bin/rake` to run the test suite.
 
-To release a new version, update the version number in `lib/cron_kubernets/version.rb` and the `CHANGELOG.md`, 
-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).
+You can run `bin/console` for an interactive prompt that will allow you to
+experiment.
 
-## Contributing
+Write test for any code that you add. Test all changes by running `bin/rake`.
+This does the following, which you can also run separately while working.
+1. Run unit tests: `appraisal rake spec`
+2. Make sure that your code matches the styles: `rubocop`
+3. Verify if any dependent gems have open CVEs (you must update these):
+   `rake bundle:audit`
+
+## Release
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/keylimetoolbox/cron-kubernetes.
+To release a new version, update the version number in
+`lib/cron_kubernetes/version.rb` and the `CHANGELOG.md`, 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).
 
 ## Acknowledgments
 

data/Rakefile

@@ -1,16 +1,22 @@
 # frozen_string_literal: true
 
+require "appraisal/task"
+require "bundler/audit/task"
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rubocop/rake_task"
-require "bundler/audit/task"
 
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 Bundler::Audit::Task.new
+Appraisal::Task.new
 
 # Remove default and replace with a series of test tasks
 task default: []
 Rake::Task[:default].clear
 
-task default: %w[spec rubocop bundle:audit]
+if ENV["APPRAISAL_INITIALIZED"]
+  task default: %i[spec]
+else
+  task default: %i[rubocop bundle:audit appraisal]
+end

data/cron-kubernetes.gemspec

@@ -24,8 +24,9 @@ Gem::Specification.new do |spec|
   spec.bindir = "bin"
   spec.executables << "cron_kubernetes"
 
-  spec.add_dependency "kubeclient", "~> 3.0"
+  spec.add_dependency "kubeclient", ">= 3.1.2", "< 5.0"
 
+  spec.add_development_dependency "appraisal"
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "bundler-audit", "~> 0"
   spec.add_development_dependency "mocha", "~> 1.3"

data/gemfiles/kubeclient_3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "kubeclient", "3.1.2"
+
+gemspec path: "../"

data/gemfiles/kubeclient_4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "kubeclient", "4.0.0"
+
+gemspec path: "../"

data/lib/cron-kubernetes.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require "cron_kubernetes"

data/lib/cron_kubernetes.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "cron_kubernetes/configurable"
+require "cron_kubernetes/context/kubectl"
+require "cron_kubernetes/context/well_known"
 require "cron_kubernetes/cron_job"
 require "cron_kubernetes/cron_tab"
 require "cron_kubernetes/kubeclient_context"
@@ -26,6 +28,9 @@ module CronKubernetes
   # Provide an identifier for this schedule (e.g. your application name)
   define_setting :identifier
 
+  # A `kubeclient` for connection context, default attempts to read from cluster or `~/.kube/config`
+  define_setting :kubeclient, nil
+
   class << self
     def schedule(&block)
       CronKubernetes::Scheduler.instance.instance_eval(&block)

data/lib/cron_kubernetes/context/kubectl.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module CronKubernetes
+  module Context
+    # Kubeclient Context from `kubectl` config file.
+    class Kubectl
+      def applicable?
+        File.exist?(kubeconfig)
+      end
+
+      def context
+        config = Kubeclient::Config.read(kubeconfig)
+
+        CronKubernetes::KubeclientContext::Context.new(
+            config.context.api_endpoint,
+            config.context.api_version,
+            config.context.namespace,
+            auth_options: auth_options(config),
+            ssl_options:  config.context.ssl_options
+        )
+      end
+
+      private
+
+      def kubeconfig
+        File.join(ENV["HOME"], ".kube", "config")
+      end
+
+      def auth_options(config)
+        options = config.context.auth_options
+        return options unless options.empty?
+        google_application_default_credentials
+      end
+
+      def google_application_default_credentials
+        return unless defined?(Google) && defined?(Google::Auth)
+        {bearer_token: Kubeclient::GoogleApplicationDefaultCredentials.token}
+      end
+    end
+  end
+end

data/lib/cron_kubernetes/context/well_known.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module CronKubernetes
+  module Context
+    # Kubeclient Context from well-known locations within a Kubernetes cluster.
+    class WellKnown
+      TOKEN_FILE     = "/var/run/secrets/kubernetes.io/serviceaccount/token"
+      CA_FILE        = "/var/run/secrets/kubernetes.io/serviceaccount/ca.crt"
+      NAMESPACE_FILE = "/var/run/secrets/kubernetes.io/serviceaccount/namespace"
+
+      def applicable?
+        File.exist?(TOKEN_FILE)
+      end
+
+      def context
+        CronKubernetes::KubeclientContext::Context.new(
+            "https://kubernetes.default.svc",
+            "v1",
+            namespace,
+            auth_options: {bearer_token_file: TOKEN_FILE},
+            ssl_options:  ssl_options
+        )
+      end
+
+      private
+
+      def namespace
+        return nil unless File.exist?(NAMESPACE_FILE)
+        File.read(NAMESPACE_FILE)
+      end
+
+      def ssl_options
+        return {} unless File.exist?(CA_FILE)
+        {ca_file: CA_FILE}
+      end
+    end
+  end
+end

data/lib/cron_kubernetes/cron_job.rb

@@ -39,7 +39,7 @@ module CronKubernetes
     private
 
     def namespace
-      return job_manifest["metadata"]["namespace"] if job_manifest["metadata"]
+      return job_manifest["metadata"]["namespace"] if job_manifest["metadata"] && job_manifest["metadata"]["namespace"]
       "default"
     end
 

data/lib/cron_kubernetes/cron_tab.rb

@@ -3,13 +3,6 @@
 module CronKubernetes
   # The "table" of Kubernetes CronJobs that we manage in the cluster.
   class CronTab
-    attr_reader :client
-    private :client
-
-    def initialize
-      @client = CronKubernetes::KubernetesClient.new.batch_beta1_client
-    end
-
     # "Apply" the new configuration
     #   - remove from cluster any cron_jobs that are no longer in the schedule
     #   - add new jobs
@@ -24,9 +17,13 @@ module CronKubernetes
 
     private
 
+    def client
+      @client ||= CronKubernetes::KubernetesClient.new.batch_beta1_client
+    end
+
     # Define a label for our jobs based on an identifier
     def label_selector
-      {"cron-kubernetes-identifier" => CronKubernetes.identifier}
+      {label_selector: "cron-kubernetes-identifier=#{CronKubernetes.identifier}"}
     end
 
     # Find all k8s CronJobs by our label for the identifier

data/lib/cron_kubernetes/kubeclient_context.rb

@@ -5,64 +5,18 @@ require "kubeclient"
 module CronKubernetes
   # Create a context for `Kubeclient` depending on the environment.
   class KubeclientContext
+    Context = Struct.new(:endpoint, :version, :namespace, :options)
+
     class << self
       def context
-        # TODO: Add ability to load this from config
-
-        if File.exist?("/var/run/secrets/kubernetes.io/serviceaccount/token")
-          # When running in k8s cluster, use the service account secret token and ca bundle
-          well_known_context
-        elsif File.exist?(kubeconfig)
-          # When running in development, use the config file for `kubectl` and default application credentials
-          kubectl_context
+        [
+            CronKubernetes::Context::WellKnown,
+            CronKubernetes::Context::Kubectl
+        ].each do |context_type|
+          context = context_type.new
+          return context.context if context.applicable?
         end
       end
-
-      private
-
-      def well_known_context
-        Kubeclient::Config::Context.new(
-            "https://kubernetes",
-            "v1",
-            {ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/ca.crt"},
-            bearer_token_file: "/var/run/secrets/kubernetes.io/serviceaccount/token"
-        )
-      end
-
-      def kubectl_context
-        config = Kubeclient::Config.read(kubeconfig)
-        auth_options = config.context.auth_options
-
-        auth_options = google_default_application_credentials(config) if auth_options.empty?
-
-        Kubeclient::Config::Context.new(
-            config.context.api_endpoint,
-            config.context.api_version,
-            config.context.ssl_options,
-            auth_options
-        )
-      end
-
-      def kubeconfig
-        File.join(ENV["HOME"], ".kube", "config")
-      end
-
-      # TODO: Move this logic to kubeclient. See abonas/kubeclient#213
-      def google_default_application_credentials(config)
-        return unless defined?(Google) && defined?(Google::Auth)
-
-        _cluster, user = config.send(:fetch_context, config.instance_variable_get(:@kcfg)["current-context"])
-        return {} unless user["auth-provider"] && user["auth-provider"]["name"] == "gcp"
-
-        {bearer_token: new_google_token}
-      end
-
-      def new_google_token
-        scopes = ["https://www.googleapis.com/auth/cloud-platform"]
-        authorization = Google::Auth.get_application_default(scopes)
-        authorization.apply({})
-        authorization.access_token
-      end
     end
   end
 end

data/lib/cron_kubernetes/kubernetes_client.rb

@@ -7,18 +7,21 @@ module CronKubernetes
       @batch_beta1_client ||= client("/apis/batch", "v1beta1")
     end
 
+    def namespace
+      context&.namespace
+    end
+
     private
 
     def client(scope, version = nil)
-      context = KubeclientContext.context
+      return CronKubernetes.kubeclient if CronKubernetes.kubeclient
       return unless context
+      Kubeclient::Client.new(context.endpoint + scope, version || context.version, context.options)
+    end
 
-      Kubeclient::Client.new(
-          context.api_endpoint + scope,
-          version || context.api_version,
-          ssl_options:  context.ssl_options,
-          auth_options: context.auth_options
-      )
+    def context
+      return nil if CronKubernetes.kubeclient
+      @context ||= KubeclientContext.context
     end
   end
 end

data/lib/cron_kubernetes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CronKubernetes
-  VERSION = "0.1.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,29 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: cron-kubernetes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jeremy Wadsack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-24 00:00:00.000000000 Z
+date: 2018-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kubeclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.1.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +161,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -150,9 +171,13 @@ files:
 - bin/cron_kubernetes
 - bin/setup
 - cron-kubernetes.gemspec
+- gemfiles/kubeclient_3.gemfile
+- gemfiles/kubeclient_4.gemfile
 - lib/cron-kubernetes.rb
 - lib/cron_kubernetes.rb
 - lib/cron_kubernetes/configurable.rb
+- lib/cron_kubernetes/context/kubectl.rb
+- lib/cron_kubernetes/context/well_known.rb
 - lib/cron_kubernetes/cron_job.rb
 - lib/cron_kubernetes/cron_tab.rb
 - lib/cron_kubernetes/kubeclient_context.rb