ocpclient 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10a1cc075addebee25ca5a78bb9bd6c5935c164f
+  data.tar.gz: 9becb489777b7a81f97e23619f1e9fbea19f1af3
+SHA512:
+  metadata.gz: 22557b366c3712c1e4fe0350bda7af0054d65196fcc3bad3a78d53936ade22a9fa78dfd200b5d6a1856877df8feb122cb18a8b0d0ef00e337a3f621a33a330ca
+  data.tar.gz: 95cfeedc2ccd9073e1ead39569480490aec31658f2a8d92181086fc540fd33fed57d29bb6dc4d4a12f66cc52e81c9d9b2a0bc76e39276b9e0f7b81f5eb4ea7b3

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+*.pem
+examples/certs/*.pem

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kubeclient.gemspec
+gemspec
+gem 'kubeclient'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alissa Bonas
+
+MIT License
+
+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,342 @@
+# Ocpclient
+
+
+A Ruby client for OpenShift Container Platform REST api.
+The client supports GET, POST, PUT, DELETE on projects, build configs, quotas, and role bindings.
+The client currently supports OCP REST api version v1.
+
+This client heavily leverages the [Kubeclient](https://github.com/abonas/kubeclient) Ruby Gem and operates almost identically.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ocpclient'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ocpclient
+
+## Usage
+
+Initialize the client:
+```ruby
+client = Ocpclient::Client.new 'https://localhost:8443/' , "v1"
+```
+
+Or without specifying version (it will be set by default to "v1")
+
+```ruby
+client = Ocpclient::Client.new 'https://localhost:8443/'
+```
+
+Another option is to initialize the client with URI object:
+
+```ruby
+uri = URI::HTTP.build(host: "somehostname", port: 8443)
+client = Ocpclient::Client.new uri
+```
+
+It is also possible to use https and configure ssl with:
+
+```ruby
+ssl_options = {
+  client_cert: OpenSSL::X509::Certificate.new(File.read('/path/to/client.crt')),
+  client_key:  OpenSSL::PKey::RSA.new(File.read('/path/to/client.key')),
+  ca_file:     '/path/to/ca.crt',
+  verify_ssl:  OpenSSL::SSL::VERIFY_PEER
+}
+client = Ocpclient::Client.new 'https://localhost:8443/' , "v1",
+                                ssl_options: ssl_options
+```
+
+As an alternative to the `ca_file` it's possible to use the `cert_store`:
+
+```ruby
+cert_store = OpenSSL::X509::Store.new
+cert_store.add_cert(OpenSSL::X509::Certificate.new(ca_cert_data))
+ssl_options = {
+  cert_store: cert_store,
+  verify_ssl: OpenSSL::SSL::VERIFY_PEER
+}
+client = Ocpclient::Client.new 'https://localhost:8443/' , "v1",
+                                ssl_options: ssl_options
+```
+
+For testing and development purpose you can disable the ssl check with:
+
+```ruby
+ssl_options = { verify_ssl: OpenSSL::SSL::VERIFY_NONE }
+client = Ocpclient::Client.new 'https://localhost:8443/' , 'v1',
+                                ssl_options: ssl_options
+```
+
+If you are using basic authentication or bearer tokens as described
+[here](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/authentication.md) then you can specify one
+of the following:
+
+```ruby
+auth_options = {
+  username: 'username',
+  password: 'password'
+}
+client = Ocpclient::Client.new 'https://localhost:8443/' , 'v1',
+                                auth_options: auth_options
+```
+
+or
+
+```ruby
+auth_options = {
+  bearer_token: 'MDExMWJkMjItOWY1Ny00OGM5LWJlNDEtMjBiMzgxODkxYzYz'
+}
+client = Ocpclient::Client.new 'https://localhost:8443/' , 'v1',
+                                auth_options: auth_options
+```
+
+or
+
+```ruby
+auth_options = {
+  bearer_token_file: '/path/to/token_file'
+}
+client = Ocpclient::Client.new 'https://localhost:8443/' , 'v1',
+                                auth_options: auth_options
+```
+
+
+
+### Kubeclient::Config
+
+If you've been using `kubectl` and have a `.kube/config` file, you can auto-populate a config object using `Kubeclient::Config`:
+```ruby
+config = Kubeclient::Config.read('/path/to/.kube/config')
+```
+
+...and then pass that object to `Kubeclient::Client`:
+
+```
+Kubeclient::Client.new(
+	config.context.api_endpoint,
+    config.context.api_version,
+    {
+    	ssl_options: config.context.ssl_options,
+    	auth_options: config.context.auth_options
+    }
+)
+```
+
+You can also load your JSONified config in from an ENV variable (e.g. `KUBE_CONFIG`) like so:
+
+```
+Kubeclient::Config.new(JSON.parse(ENV['KUBE_CONFIG']), nil)
+```
+
+## Examples:
+
+#### Get all instances of a specific entity type
+Such as: `get_pods`, `get_secrets`, `get_services`, `get_nodes`, `get_replication_controllers`, `get_resource_quotas`, `get_limit_ranges`, `get_persistent_volumes`, `get_persistent_volume_claims`, `get_component_statuses`, `get_service_accounts`
+
+```ruby
+pods = client.get_pods
+```
+
+Get all entities of a specific type in a namespace:<br>
+
+```ruby
+services = client.get_services(namespace: 'development')
+```
+
+You can get entities which have specific labels by specifying a parameter named `label_selector` (named `labelSelector` in Kubernetes server):
+
+```ruby
+pods = client.get_pods(label_selector: 'name=redis-master')
+```
+
+You can specify multiple labels (that option will return entities which have both labels:
+```ruby
+pods = client.get_pods(label_selector: 'name=redis-master,app=redis')
+```
+
+#### Get a specific instance of an entity (by name)
+Such as: `get_service "service name"` , `get_pod "pod name"` , `get_replication_controller "rc name"`, `get_secret "secret name"`, `get_resource_quota "resource quota name"`, `get_limit_range "limit range name"` , `get_persistent_volume "persistent volume name"` , `get_persistent_volume_claim "persistent volume claim name"`, `get_component_status "component name"`, `get_service_account "service account name"`
+
+The GET request should include the namespace name, except for nodes and namespaces entities.
+
+```ruby
+node = client.get_node "127.0.0.1"
+```
+
+```ruby
+service = client.get_service "guestbook", 'development'
+```
+
+Note - Kubernetes doesn't work with the uid, but rather with the 'name' property.
+Querying with uid causes 404.
+
+#### Delete an entity (by name)
+
+For example: `delete_pod "pod name"` , `delete_replication_controller "rc name"`, `delete_node "node name"`, `delete_secret "secret name"`
+
+Input parameter - name (string) specifying service name, pod name, replication controller name.
+```ruby
+client.delete_service "redis-service"
+```
+
+#### Create an entity
+For example: `create_pod pod_object`, `create_replication_controller rc_obj`, `create_secret secret_object`, `create_resource_quota resource_quota_object`, `create_limit_range limit_range_object`, `create_persistent_volume persistent_volume_object`, `create_persistent_volume_claim persistent_volume_claim_object`, `create_service_account service_account_object`
+
+Input parameter - object of type `Service`, `Pod`, `ReplicationController`.
+
+The below example is for v1
+
+```ruby
+service = Service.new
+service.metadata = {}
+service.metadata.name = "redis-master"
+service.metadata.namespace = 'staging'
+service.spec = {}
+service.spec.ports = [{ 'port' => 6379,
+                                'targetPort' => 'redis-server'
+                              }]
+service.spec.selector = {}
+service.spec.selector.name = "redis"
+service.spec.selector.role = "master"
+service.metadata.labels = {}
+service.metadata.labels.app = 'redis'
+service.metadata.labels.role = 'slave'
+client.create_service service`
+```
+
+#### Update an entity
+For example: `update_pod`, `update_service`, `update_replication_controller`, `update_secret`, `update_resource_quota`, `update_limit_range`, `update_persistent_volume`, `update_persistent_volume_claim`, `update_service_account`
+
+Input parameter - object of type `Pod`, `Service`, `ReplicationController` etc.
+
+The below example is for v1
+
+```ruby
+client.update_service service1
+```
+
+#### Patch an entity (by name)
+For example: `patch_pod`, `patch_service`, `patch_secret`, `patch_resource_quota`, `patch_persistent_volume`
+
+Input parameters - name (string) specifying the entity name, patch (hash) to be applied to the resource, optional: namespace name (string)
+
+The PATCH request should include the namespace name, except for nodes and namespaces entities.
+
+The below example is for v1
+
+```ruby
+client.patch_pod "docker-registry", {:metadata => {:annotations => {:key => 'value'}}}, "default"
+```
+
+#### Get all entities of all types : all_entities
+Returns a hash with the following keys (node, secret, service, pod, replication_controller, namespace, resource_quota, limit_range, endpoint, event, persistent_volume, persistent_volume_claim, component_status and service_account). Each key points to an EntityList of same type.
+This method is a convenience method instead of calling each entity's get method separately.
+
+```ruby
+client.all_entities
+```
+
+#### Receive entity updates
+It is possible to receive live update notices watching the relevant entities:
+
+```ruby
+watcher = client.watch_pods
+watcher.each do |notice|
+  # process notice data
+end
+```
+
+It is possible to interrupt the watcher from another thread with:
+
+```ruby
+watcher.finish
+```
+
+#### Watch events for a particular object
+You can use the `field_selector` option as part of the watch methods.
+
+```ruby
+watcher = client.watch_events(namespace: 'development', field_selector: 'involvedObject.name=redis-master')
+watcher.each do |notice|
+  # process notice date
+end
+```
+
+#### Get a proxy URL
+You can get a complete URL for connecting a kubernetes entity via the proxy.
+
+```ruby
+client.proxy_url('service', 'srvname', 'srvportname', 'ns')
+ => "https://localhost.localdomain:8443/api/v1/proxy/namespaces/ns/services/srvname:srvportname"
+```
+
+Note the third parameter, port, is a port name for services and an integer for pods:
+
+```ruby
+client.proxy_url('pod', 'podname', 5001, 'ns')
+ => "https://localhost.localdomain:8443/api/v1/namespaces/ns/pods/podname:5001/proxy"
+```
+
+#### Get the logs of a pod
+You can get the logs of a running pod, specifying the name of the pod and the
+namespace where the pod is running:
+
+```ruby
+client.get_pod_log('pod-name', 'default')
+ => "Running...\nRunning...\nRunning...\n"
+```
+
+If that pod has more than one container, you must specify the container:
+
+```ruby
+client.get_pod_log('pod-name', 'default', container: 'ruby')
+ => "..."
+```
+
+If a container in a pod terminates, a new container is started, and you want to
+retrieve the logs of the dead container, you can pass in the `:previous` option:
+
+```ruby
+client.get_pod_log('pod-name', 'default', previous: true)
+ => "..."
+```
+
+You can also watch the logs of a pod to get a stream of data:
+
+```ruby
+watcher = client.watch_pod_log('pod-name', 'default', container: 'ruby')
+watcher.each do |line|
+  puts line
+end
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/kubeclient/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Test your changes with `rake test rubocop`, add new tests if needed.
+4. If you added a new functionality, add it to README
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create a new Pull Request
+
+## Tests
+
+This client is tested with Minitest and also uses VCR recordings in some tests.
+Please run all tests before submitting a Pull Request, and add new tests for new functionality.
+
+Running tests:
+```ruby
+rake test
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'yaml'
+
+task default: [:test, :rubocop] # same as .travis.yml
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+RuboCop::RakeTask.new

data/examples/create_project.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby
+
+require 'ocpclient'
+require 'kubeclient'
+require 'json'
+
+ssl_options = {
+  client_cert: OpenSSL::X509::Certificate.new(File.read('certs/admincrt.pem')),
+  client_key:  OpenSSL::PKey::RSA.new(File.read('certs/adminkey.pem')),
+  ca_file:     'certs/adminca.pem',
+  verify_ssl: OpenSSL::SSL::VERIFY_NONE }
+
+
+client = Ocpclient::Client.new 'https://openshift.kenscloud.io:8443', "v1", ssl_options: ssl_options
+
+project = Kubeclient::ProjectRequest.new
+
+project.metadata = {}
+project.metadata.name = "testproject"
+project.displayName = "Test Project"
+project.description = "This is a test project"
+
+puts "#{client.create_project_request project}"

data/examples/list_projects.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby
+
+require 'ocpclient'
+require 'json'
+
+ssl_options = {
+  client_cert: OpenSSL::X509::Certificate.new(File.read('certs/admincrt.pem')),
+  client_key:  OpenSSL::PKey::RSA.new(File.read('certs/adminkey.pem')),
+  ca_file:     'certs/adminca.pem',
+  verify_ssl: OpenSSL::SSL::VERIFY_NONE }
+
+
+client = Ocpclient::Client.new 'https://openshift.kenscloud.io:8443', "v1", ssl_options: ssl_options
+
+project_list = client.get_projects
+
+
+project_list.each do |project|
+     puts "Project ==> #{project.metadata.name}"
+end
+

data/lib/ocpclient/version.rb

@@ -0,0 +1,4 @@
+# OpenShift Container Platrform REST-API Client
+module Ocpclient
+  VERSION = '0.0.1'
+end

data/lib/ocpclient.rb

@@ -0,0 +1,50 @@
+require 'kubeclient'
+require 'ocpclient/version'
+require 'json'
+require 'rest-client'
+require 'kubeclient/entity_list'
+require 'kubeclient/kube_exception'
+require 'kubeclient/watch_notice'
+require 'kubeclient/watch_stream'
+require 'kubeclient/common'
+require 'kubeclient/config'
+
+module Ocpclient
+  # OCP Client
+  class Client < Kubeclient::Client
+    include Kubeclient::ClientMixin
+    # Dynamically creating classes definitions (class Project, class BuildConfig, etc.),
+    # The classes are extending RecursiveOpenStruct.
+    # This cancels the need to define the classes
+    # manually on every new entity addition,
+    # and especially since currently the class body is empty
+    ENTITY_TYPES = %w(Project ProjectRequest BuildConfig RoleBinding).map do |et|
+      clazz = Class.new(RecursiveOpenStruct) do
+        def initialize(hash = nil, args = {})
+          args.merge!(recurse_over_arrays: true)
+          super(hash, args)
+        end
+      end
+      [Kubeclient.const_set(et, clazz), et]
+    end
+
+    Kubeclient::ClientMixin.define_entity_methods(ENTITY_TYPES)
+
+    def initialize(
+      uri,
+      version = 'v1',
+      **options
+    )
+      initialize_client(
+        uri,
+        '/oapi',
+        version,
+        options
+      )
+    end
+
+    def all_entities
+      retrieve_all_entities(ENTITY_TYPES)
+    end
+  end
+end

data/ocpclient.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ocpclient/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ocpclient'
+  spec.version       = Ocpclient::VERSION
+  spec.authors       = ['Kenneth Evensen']
+  spec.email         = ['kevensen@redhat.com']
+  spec.summary       = 'A client for OpenShift Container Platform REST api'
+  spec.description   = 'A client for OpenShift Container Platform REST api'
+  spec.homepage      = 'https://github.com/kevensen/ocpclient'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'webmock', '~> 1.24.2'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'rubocop', '= 0.30.0'
+  spec.add_development_dependency 'kubeclient'
+  spec.add_runtime_dependency 'kubeclient'
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: ocpclient
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kenneth Evensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: minitest
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.2
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.30.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.30.0
+- !ruby/object:Gem::Dependency
+  name: kubeclient
+  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: kubeclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A client for OpenShift Container Platform REST api
+email:
+- kevensen@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/create_project.rb
+- examples/list_projects.rb
+- lib/ocpclient.rb
+- lib/ocpclient/version.rb
+- ocpclient.gemspec
+homepage: https://github.com/kevensen/ocpclient
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A client for OpenShift Container Platform REST api
+test_files: []