rhea 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 517c470dc81b2fce8bda550ee12ab84b56363806
-  data.tar.gz: 47ddc6ea4d1f24b1a03fb5b6e97b449623ae52b7
+  metadata.gz: c8f09f9a769acb9cda54ffa31ad07056446cabe4
+  data.tar.gz: 134245ddf59d1e8ab6ed27a7230bc0e7151a38e9
 SHA512:
-  metadata.gz: 2cb4e796d986f4dcae2d66f3e271ef6a9002ecd511d73bc4d1c1d324b831bbb46ab0bf50d6fbdd7a81d4647960b7bc60a437c28dfd4819adbfef6c8ccfef996b
-  data.tar.gz: 35fae2399ffa3ef7de23070493cf11a9c4a30499130bb216a64feb2ea74f7363be018bc60475a97f964235b4b803375e4b6fb9d2bb00812ae736e6eeaa2c1d08
+  metadata.gz: 2eca1512f4b3febb16bda502565699e2b91a51096cfc684a20a114920141c00183ea9c8e117b04f8e979d3907a643edee4ceb8b27a020c5259dad80de81dbb86
+  data.tar.gz: de1e9be0fda7f30dfd81976815acd809f83bdb2baafd8c908bbe2403b3dda1f6f305fb0d7a52315e80513872f56c5d7aeae2fbbeb88f055defb701b1037039d0

data/.gitignore

@@ -1,6 +1,9 @@
 .DS_Store
-Gemfile.lock
 *.gem
-log/*.log
 .bundle/
+credentials/*
+!credentials/.gitkeep
+Gemfile.lock
+log/*.log
 pkg/
+rhea.rb

data/Dockerfile

@@ -0,0 +1,29 @@
+FROM alpine:3.4
+MAINTAINER ayumi@entelo.com
+
+RUN apk update && apk --update add ruby ruby-irb ruby-json ruby-rake \
+    ruby-bigdecimal ruby-io-console libstdc++ tzdata \
+    libxml2-dev libxslt-dev
+
+ADD examples/rhea-rails/Gemfile /app/
+ADD examples/rhea-rails/Gemfile.lock /app/
+
+RUN apk --update add --virtual build-dependencies build-base git \
+    libc-dev linux-headers ruby-dev openssl-dev && \
+    gem install --no-rdoc --no-ri bundler && \
+    cd /app; bundle install --deployment --full-index --jobs 4 && \
+    apk del build-dependencies
+
+
+ADD examples/rhea-rails/. /app
+ADD credentials/. /app/config/credentials/
+ADD rhea.rb /app/config/initializers/
+RUN chown -R nobody:nogroup /app
+USER nobody
+
+EXPOSE 3000
+
+ENV KUBE_API_URL "http://localhost:8080/api/"
+
+WORKDIR /app
+CMD ["bundle", "exec", "rails", "server", "--binding=0.0.0.0"]

data/README.md

@@ -3,7 +3,7 @@
 A web UI for managing a Kubernetes cluster
 
 Overview
---------
+---
 
 Rhea is a web UI for managing a Kubernetes cluster. It makes it very easy to:
 
@@ -25,65 +25,75 @@ Monitor the nodes' pods and the cluster's events:
 [<img src="docs/events.png?raw=true" width="440" />](docs/events.png?raw=true)
 
 Installation
-------------
+---
 
-Rhea is a Rails engine. To install it, include it in your `Gemfile`:
+The included Dockerfile builds a container running a Rails app with Rhea.
 
-```ruby
-gem 'rhea'
-```
+1. Configure Rhea by copying and modifying `rhea.rb.example`:
+  * `cp rhea.rb.example rhea.rb`
+  * Modify `rhea.rb` (see [Configuration](#configuration))
+2. Build the container: `docker build -it rhea .`
+3. Run it: `docker run --rm -p 3000:3000 rhea`
 
-Mount it in `routes.rb`:
 
-```ruby
-mount Rhea::Engine => '/rhea'
-```
 
-And configure it in `config/initializers/rhea.rb`:
+Configuration
+---
+
+Rhea is configured in `rhea.rb`. The only required configuration option is `kube_api`, which configures Rhea to talk to your Kubernetes API.
+
+### kube_api
+
+These options are passed through to [kubeclient](https://github.com/abonas/kubeclient), so anything that's valid in `kubeclient` is valid here.
+
+#### No authentication
 
 ```ruby
+# rhea.rb
 require 'rhea'
 
 Rhea.configure do |config|
   config.kube_api = {
-    options: {
-      ssl_options: {
-        client_key: OpenSSL::PKey::RSA.new(Rails.root.join(ENV['KEYS_DIRECTORY'], 'apiserver-key.pem').read),
-        client_cert: OpenSSL::X509::Certificate.new(Rails.root.join(ENV['KEYS_DIRECTORY'], 'apiserver.pem').read),
-        ca_file: Rails.root.join(ENV['KEYS_DIRECTORY'], 'ca.pem').to_s,
-        verify_ssl: OpenSSL::SSL::VERIFY_PEER
-      }
-    },
-    url: 'https://kubernetes.example.com/api/'
+    url: 'https://kubernetes.example.com/api/',
+    options: {}
   }
-  config.default_image = 'docker.registry.com/myworker:latest'
 end
 ```
 
-Configuration
--------------
+#### Client certificate authentication
 
-See [Installation](#installation) for basic configuration.
+Create a `credentials` directory in the root of this directory and copy the following files into it:
 
-#### kube_api
+```bash
+credentials/apiserver.crt
+credentials/apiserver.key
+credentials/ca.crt
+```
 
-The API options. These are simply passed to [kubeclient](https://github.com/abonas/kubeclient), so anything that's valid in `kubeclient` is valid here. Here's an example:
+Then configure `rhea.rb` to use them:
 
 ```ruby
-config.kube_api = {
-  options: {
-    ssl_options: {
-      client_key: OpenSSL::PKey::RSA.new(Rails.root.join(ENV['KEYS_DIRECTORY'], 'apiserver-key.pem').read),
-      client_cert: OpenSSL::X509::Certificate.new(Rails.root.join(ENV['KEYS_DIRECTORY'], 'apiserver.pem').read),
-      ca_file: Rails.root.join(ENV['KEYS_DIRECTORY'], 'ca.pem').to_s,
-      verify_ssl: OpenSSL::SSL::VERIFY_PEER
+# rhea.rb
+require 'rhea'
+
+Rhea.configure do |config|
+  config.kube_api = {
+    url: 'https://kubernetes.example.com/api/',
+    options: {
+      ssl_options: {
+        client_key: OpenSSL::PKey::RSA.new(Rails.root.join('config/credentials/apiserver.key').read),
+        client_cert: OpenSSL::X509::Certificate.new(Rails.root.join('config/credentials/apiserver.crt').read),
+        ca_file: Rails.root.join('config/credentials/ca.crt').to_s,
+        verify_ssl: OpenSSL::SSL::VERIFY_PEER
+      }
     }
-  },
-  url: 'https://kubernetes.example.com/api/'
-}
+  }
+end
 ```
 
-#### command_types
+The `credentials/*` files above are generated when you create the cluster. For example, if you're using minikube, they're located in `~/.minikube/`.
+
+### command_types
 
 Command types are custom templates that let you create commands more easily. They can be used in the command creation form. `$INPUT` is the value that's passed in from the form input.
 
@@ -112,7 +122,7 @@ config.command_types = [
 ]
 ```
 
-#### container_options
+### container_options
 
 By default, each pod has a single, minimally-configured container. You can easily configure additional container options, which will be merged into the pod's `spec.template.spec.containers[0]`.
 
@@ -131,7 +141,7 @@ config.container_options = {
 }
 ```
 
-#### default_command_type_key
+### default_command_type_key
 
 This will be used to set the default command type when creating new commands.
 
@@ -139,7 +149,7 @@ This will be used to set the default command type when creating new commands.
 config.default_command_type_key = 'goworker'
 ```
 
-#### default_image
+### default_image
 
 This will be used to set the default image when creating new commands.
 
@@ -147,7 +157,7 @@ This will be used to set the default image when creating new commands.
 config.default_image = 'docker.registry.com/myworker:latest'
 ```
 
-#### env_vars
+### env_vars
 
 This will be used to set custom environment variables in pods scheduled by Rhea.
 
@@ -157,6 +167,39 @@ config.env_vars = {
 }
 ```
 
+Using Rhea as a Rails engine
+---
+
+Rhea is also available as a Rails engine. To install it in a Rails app, include it in your `Gemfile`:
+
+```ruby
+gem 'rhea'
+```
+
+And mount it in `routes.rb`:
+
+```ruby
+mount Rhea::Engine => '/rhea'
+```
+
+You'll then configure Rhea in `config/initializers/rhea.rb`. See [Configuration](#configuration) for details.
+
+Development
+---
+
+Use the sample Rails app with Rhea.
+
+1. `cd examples/rhea-rails`
+2. Update the rhea Gem in the sample app's `Gemfile`:
+  - `gem 'rhea', git: 'https://github.com/entelo/rhea.git'`
+to
+  - `gem 'rhea', path: '../../'`
+
+3. Modify `config/rhea.yml` for your needs
+4. `bundle install`
+5. `rails server KUBE_API_URL=http://localhost:8080/api/`
+6. Visit http://localhost:3000
+
 Testing
 -------
 

data/app/assets/stylesheets/rhea/layout.css.sass

@@ -29,3 +29,6 @@ h1, h2, h3, h4, h5, h6
 
 .form-horizontal .control-label
   padding-right: 0
+
+table
+  word-wrap: break-word

data/app/controllers/rhea/commands_controller.rb

@@ -4,7 +4,6 @@ module Rhea
       @commands = Rhea::Kubernetes::Commands::All.new.perform
       @default_image = Rhea.configuration.default_image
       @images = (@commands.map(&:image) + [@default_image]).uniq.sort
-      params[:image] ||= @default_image
       if params[:image].present?
         @commands = @commands.select { |command| command.image == params[:image] }
       end

data/app/views/rhea/commands/_form.html.haml

@@ -9,7 +9,12 @@
     .col-sm-9
       = select_tag :command_type_key, options_for_select(Rhea::CommandType.options_for_select, Rhea.configuration.default_command_type_key), class: 'form-control', style: 'width: 90px;', required: 'required'
   .form-group
-    = label_tag :command_type_input, 'Input', class: 'col-sm-3 control-label'
+    = label_tag :command_syntax, 'Command', class: 'col-sm-3 control-label', style: 'font-weight: normal;'
+    .col-sm-9
+      %pre.command-syntax{style: 'font-size: 12px;'}
+        = Rhea::CommandType.find(Rhea.configuration.default_command_type_key).displayed_format
+  .form-group
+    = label_tag :command_type_input, '$input', class: 'col-sm-3 control-label'
     .col-sm-9
       = text_field_tag :command_type_input, nil, class: 'form-control', style: 'width: 100%;'
   .form-group
@@ -19,4 +24,4 @@
   .form-group
     .col-sm-3
     .col-sm-9
-      = submit_tag 'Create', class: 'btn btn-default'
+      = submit_tag 'Create', class: 'btn btn-success'

data/app/views/rhea/commands/_table.html.haml

@@ -1,7 +1,7 @@
 %table.table.table-condensed.table-striped
   %thead
     %tr
-      %th
+      %th{style: 'width: 25px;'}
         %input{type: 'checkbox', id: 'check-all'}
       %th Image
       %th Command
@@ -13,7 +13,8 @@
     - commands.each do |command|
       - escaped_image_expression = CGI.escape([command.image, command.expression].join(Rhea::Command::IMAGE_EXPRESSION_SEPARATOR))
       %tr
-        %td= check_box_tag 'batch_image_expressions[]', escaped_image_expression, false, class: 'command-checkbox'
+        %td
+          = check_box_tag 'batch_image_expressions[]', escaped_image_expression, false, class: 'command-checkbox checkbox'
         %td= humanize_image(command.image)
         %td= command.expression
         %td= command.process_count
@@ -24,9 +25,9 @@
             = time_ago_in_words(command.created_at.in_time_zone(Time.zone), include_seconds: true)
             ago
         %td{ style: 'white-space: nowrap;' }
-          = link_to redeploy_commands_path(image_expression: escaped_image_expression), title: 'Redeploy', class: 'btn btn-info btn-xs btn-action', 'data-toggle': 'tooltip', 'data-placement': 'bottom' do
+          = link_to redeploy_commands_path(image_expression: escaped_image_expression), title: 'Redeploy', class: 'btn btn-primary btn-xs btn-action', 'data-toggle': 'tooltip', 'data-placement': 'bottom' do
             %span.glyphicon.glyphicon-cloud-download
-          = link_to reschedule_commands_path(image_expression: escaped_image_expression), title: 'Reschedule', class: 'btn btn-info btn-xs btn-action', 'data-toggle': 'tooltip', 'data-placement': 'bottom' do
+          = link_to reschedule_commands_path(image_expression: escaped_image_expression), title: 'Reschedule', class: 'btn btn-primary btn-xs btn-action', 'data-toggle': 'tooltip', 'data-placement': 'bottom' do
             %span.glyphicon.glyphicon-fullscreen
           - if command.process_count == 0
             = link_to delete_commands_path(image_expression: escaped_image_expression), title: 'Delete', class: 'btn btn-danger btn-xs btn-action', 'data-toggle': 'tooltip', 'data-placement': 'bottom' do
@@ -37,15 +38,15 @@
     %tr
       %td{ colspan: 2 }
         .batch-actions{ style: 'display: none;' }
-          = button_tag name: 'batch_action', value: 'redeploy', title: 'Redeploy', class: 'btn btn-info btn-xs btn-action', 'data-toggle': 'tooltip', 'data-placement': 'bottom' do
+          = button_tag name: 'batch_action', value: 'redeploy', title: 'Redeploy', class: 'btn btn-primary btn-xs btn-action', 'data-toggle': 'tooltip', 'data-placement': 'bottom' do
             %span.glyphicon.glyphicon-cloud-download
-          = button_tag name: 'batch_action', value: 'reschedule', title: 'Reschedule', class: 'btn btn-info btn-xs btn-action', 'data-toggle': 'tooltip', 'data-placement': 'bottom' do
+          = button_tag name: 'batch_action', value: 'reschedule', title: 'Reschedule', class: 'btn btn-primary btn-xs btn-action', 'data-toggle': 'tooltip', 'data-placement': 'bottom' do
             %span.glyphicon.glyphicon-fullscreen
           = button_tag name: 'batch_action', value: 'stop', title: 'Stop', class: 'btn btn-warning btn-xs btn-action', 'data-toggle': 'tooltip', 'data-placement': 'bottom' do
             %span.glyphicon.glyphicon-stop
       %td
       %td
       %td
-        = button_tag 'Save', name: 'batch_action', value: 'scale', class: 'btn btn-default'
+        = button_tag 'Save', name: 'batch_action', value: 'scale', class: 'btn btn-success'
       %td
       %td

data/app/views/rhea/commands/index.html.haml

@@ -1,25 +1,31 @@
 .row
   .col-md-8
-    .pull-right
-      = form_tag commands_path, method: 'GET', class: 'form-inline' do
-        .form-group
-          = label_tag :image, 'Image:', style: 'margin-right: 5px; font-size: 12px; font-weight: normal;'
-          - image_options = [['All', nil]] + @images.map { |image| [humanize_image(image), image] }
-          = select_tag :image, options_for_select(image_options, params[:image].presence), class: 'form-control input-sm', onchange: "$(this).closest('form').submit();"
-    %h3 Commands
-    - if @commands.blank?
-      %p No commands found.
-    - else
-      = form_tag batch_update_commands_path, method: 'POST' do
-        = hidden_field_tag :redirect_to, request.fullpath
-        = render partial: 'rhea/commands/table', locals: { commands: @commands }
-      = link_to 'Export', export_commands_path(format: 'json'), class: 'btn btn-default'
-    = form_tag import_commands_path, method: 'PUT', multipart: true, style: 'display: inline-block;' do
-      %span.btn.btn-default.btn-file
-        Import
-        = file_field_tag :data, accept: 'application/json', onchange: "$(this).closest('form').submit();"
-    %br
-    %br
+    .row
+      .col-md-12
+        .pull-left
+          = form_tag commands_path, method: 'GET', class: 'form-inline' do
+            .form-group
+              = label_tag :image, 'Image', style: 'margin-right: 5px; font-size: 13px;'
+              - image_options = [['All', nil]] + @images.map { |image| [humanize_image(image), image] }
+              = select_tag :image, options_for_select(image_options, params[:image].presence), class: 'form-control', onchange: "$(this).closest('form').submit();"
+        .pull-right
+          = form_tag import_commands_path, method: 'PUT', multipart: true, style: 'display: inline-block;' do
+            %span.btn.btn-default.btn-file
+              Import
+              = file_field_tag :data, accept: 'application/json', onchange: "$(this).closest('form').submit();"
+          = link_to 'Export', export_commands_path(format: 'json'), class: 'btn btn-default'
+        %br
+        %br
+        %br
+    .row
+      .col-md-12
+        - if @commands.present?
+          = form_tag batch_update_commands_path, method: 'POST' do
+            = hidden_field_tag :redirect_to, request.fullpath
+            = render partial: 'rhea/commands/table', locals: { commands: @commands }
+        - else
+          %p
+            No commands found.
 
   .col-md-4
     .panel.panel-default
@@ -28,12 +34,6 @@
       .panel-body
         = render partial: 'rhea/commands/form'
 
-    .panel.panel-default
-      .panel-heading
-        %h4 Command Types
-      .panel-body
-        = render partial: 'rhea/command_types/list'
-
 :javascript
   var checkboxes = $('.command-checkbox');
   var batchActions = $('.batch-actions');
@@ -41,11 +41,18 @@
   var toggleBatchActions = function() {
     batchActions.toggle(checkboxes.filter(':checked').length > 0);
     return true;
-  }
+  };
+
+  var updateCommandSyntax = function() {
+    var syntax = this.selectedOptions[0].dataset.syntax;
+    $('.command-syntax').text(syntax);
+  };
 
   checkboxes.on('click', toggleBatchActions);
 
   $('#check-all').change(function(){
     $(".command-checkbox").prop('checked', $(this).prop("checked"));
     toggleBatchActions()
-  })
+  });
+
+  $('#command_type_key').on('change', updateCommandSyntax);

data/app/views/rhea/events/index.html.haml

@@ -4,7 +4,6 @@
       %th Time
       %th
       %th Host
-      %th Message
       %th Type
       %th Resource Type
       %th Resource ID
@@ -16,9 +15,10 @@
           = time_ago_in_words(event.created_at.in_time_zone(Time.zone), include_seconds: true)
           ago
         %td= event.hostname
-        %td= simple_format(event.message)
         %td= event.type
         %td= event.resource_type
         %td= event.resource_id
+      %tr
+        %td{colspan: 6}= simple_format(event.message)
 
-= paginate @events
+= paginate @events

data/app/views/rhea/nodes/index.html.haml

@@ -1,4 +1,4 @@
-%table.table.table-striped
+%table.table.table-condensed.table-striped
   %thead
     %tr
       %th Host
@@ -26,4 +26,4 @@
                     - if uniq_phases.length == 1
                       = uniq_phases.first
                     - else
-                      = phases.sort.join(', ')
+                      = phases.sort.join(', ')