activek8s 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cced9ad51fc24f2435e9b38833bbc5c991b63523db450701d7c80dd548669e7e
-  data.tar.gz: 11f4f7296e0826865e57c5a86d61157d707b7662f63c8399583606460e8b74e8
+  metadata.gz: 1a5c465b6ebfde47bb5ac127401a2ea4fd741d1aea930ff96c6859e594d9ed86
+  data.tar.gz: ca0e3aff59ba3cb044c55bec7c044a5bbeaafb6244ba783f5b7ec84e817b76fc
 SHA512:
-  metadata.gz: cd1a7680bc20702faf6334bdd50c85d0ae3c3cf23e4f0c89730e19c232ea114d3271fa7070932f87e184e326f4fa9f3c5f55bb2c760556205ba9703743c3ddb1
-  data.tar.gz: 29696b79bc8487f13336cebfc73417e8aeff99a5f6c45b221de5fb2bf137a4359c6ff6cae9c25996e2657a7bc4eb2135d10e253816f37ef4f6ac4aecea69f409
+  metadata.gz: 2990b13ffe416d9218ed240425a3d654047189f4166a56fd7c77b4f7dcd856dc0403f42f007d75072ab61ac7f9a7414dc2b82da67e4f50157928ab262ac8507a
+  data.tar.gz: 2a12464f0fd071c2015e4f5ae1490c5889f83cf5f6d9325f00e439108705d309a3e16900a23a115c97ca693fd8452308d35a702820f98258b739e226209ceb75

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activek8s (0.3.0)
+    activek8s (0.4.0)
       childprocess (~> 1.0.0)
 
 GEM

data/README.md

@@ -1,28 +1,96 @@
 # Activek8s
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/activek8s`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem provides a set of _Rake tasks for a convention based Kubernetes integration_. This means that by following some conventions you will be able to leverage some low level [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) commands using [Rake](https://github.com/ruby/rake).
 
-TODO: Delete this and the text above, and describe your gem
+These Rake tasks provide a set of high level customizable commands with sensible defaults. Not everyone in your teams has to be an expert in the Docker/Kubernetes/Ops area to interact with a Kubernetes cluster. __Activek8s__ can help teams working on any project, this isn't a Rails only solution (__not even a Ruby only solution__).
 
 ## Installation
 
+    $ gem install activek8s
+
+## Ruby/Rails project
+
 Add this line to your application's Gemfile:
 
 ```ruby
 gem 'activek8s'
 ```
 
-And then execute:
+## How it works
 
-    $ bundle
+This gem uses a directory named `kube` as a workspace for `deployment.yml`. This YAML file must contain a ConfigMap, Service and Deployment representing the current projects service to be deployed in a Kubernetes cluster. When managing a deployment in a Kubernetes cluster a very common command is `kubectl apply -f <config yml file>`.
 
-Or install it yourself as:
+__Activek8s__ performs template-like text substitution on your `deployment.yml` to output a file named `last_deployment.yml`. This `last_deployment.yml` file is the one applied against the currently authenticated Kubernetes cluster (via kubectl). This text substitution is meant for container image name, container image tags and environment management (dev/staging/prod).
 
-    $ gem install activek8s
+### Directory structure
+
+```
+.
+├── Dockerfile
+├── kube
+│   └── deployment.yml
+```
+
+### Things you'll need
+
+  1. A Kubernetes cluster somewhere
+  2. [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) authenticated to that cluster from #1 (if `kubectl get pods -n NAMESPACE` works you're good)
+  3. A Dockerized project ready to be deployed on #1 or some other services already deployed to #1
+
+### Tasks
+
+  * ak8s:deploy
+    * Creates a `last_deployment.yml` from `deployment.yml` and applies the YAML specification on the currently authenticated Kubernetes cluster
+    * Ex: `kubectl apply -f kube/last_deployment.yml`
+  * ak8s:delete
+    * Creates a `last_deployment.yml` from `deployment.yml` and deletes the matching YAML specification on the currently authenticated Kubernetes cluster
+    * Ex: `kubectl delete -f kube/last_deployment.yml`
+  * ak8s:port_forward
+    * Port forwards all services defined in `.ak8s.yml`.
+    * Will create a file named `services.env` containing your service names and urls which you can source (i.e. `. services.env`)
+  * ak8s:port_forward_current
+    * Port forwards the current project's deployment in a certain namespace defined in `.ak8s.yml`.
+    * Ex: `kubectl port-forward {service} ...`
+
+## .ak8s.yml
+
+This file lets you configure your port forwarding capabilities. Suppose an environment where you have 5 services deployed in a cluster. You would have something similar to the following:
+
+```
+dev:                          # First level keys are namespaces in your cluster.
+  - name: webapp              # Inside the list of services to forward the only
+  - name: backendwebapp       # required field is 'name'.
+  - name: webapi
+  - name: analytics
+  - name: elasticsearch
+
+staging:
+  - name: webapp        
+  - name: backendwebapp
+  - name: webapi              # You can specify the namespace of any service.     
+  - name: analytics           # This would cause the port forwarding to occur
+    namespace: logging        # referencing the service deployed on a specific
+  - name: elasticsearch       # namespace other than the first level key.
+
+production:
+  - name: webapp
+  - name: backendwebapp
+  - name: webapi
+  - name: analytics           # Target port specification allows you to pass in
+    target_port: 8080         # the target port of the service (not on the
+  - name: elasticsearch       # localhost port where the service will be available
+    target_port: 9200
+
+ak8s:                         # ak8s is where general config goes
+  first_port: 4200            # first_port lets you specify the first port where
+                              # the multiple service port forwarding will start
+```
+
+### Port forwarding examples
 
-## Usage
+`rake ak8s:port_forward` will port forward all the services listed by name in the 'dev' namespace __because it was listed first__.
 
-TODO: Write usage instructions here
+`rake ak8s:port_forward[staging]` will port forward all the services listed within the staging namespace. In this case the elasticsearch service will be port forwarded using the logging namespace, instead of using the default (which is the corresponding first level key, 'staging' in this case).
 
 ## Development
 
@@ -32,7 +100,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/activek8s.
+Bug reports and pull requests are welcome on GitHub at https://github.com/fdoxyz/activek8s.
 
 ## License
 

data/lib/activek8s/version.rb

@@ -1,3 +1,3 @@
 module Activek8s
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/lib/tasks/port_forward.rake

@@ -11,7 +11,7 @@ namespace 'ak8s' do
 
     # Helper variables setup
     first_port = config.dig('ak8s', 'first_port') || 4200
-    namespaced_services = config[args.namespace]['services']
+    namespaced_services = config[args.namespace]
     raise 'No services listed in .ak8s.yml' if namespaced_services.empty?
 
     # All services to port forward (an array of hashes)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activek8s
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Fernando Valverde Arredondo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-31 00:00:00.000000000 Z
+date: 2019-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess