triton-ops 0.18.4.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 23ccae6a1a3b477925806a3cf9d86a1154990c67fff3b1b9aaec9b9b3cd9a9f2
+  data.tar.gz: b4a5d9451580ebecb5e410a347e53e763844f35e1a9bc60bfeedca4faf5f95c6
+SHA512:
+  metadata.gz: 88b343686ee3114d4c8738df04fe268de7e069195d06b0ce5228dcf96577d1333293fed49d057d1879b9190b69451fe0d8e5ded0ddb1d34641755e6b272883c5
+  data.tar.gz: 07df2db88ef327805083f2b02001a5b1db70454b9a76e851b5f1c0360e4494685609c87b5d07ef8eca5f6c4c34e0f91ebecf44b1d9467284b85ce6463f314748

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+The MIT License (MIT)
+Copyright © 2018 Chris Olstrom <chris@olstrom.com>
+
+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.org

@@ -0,0 +1,40 @@
+#+TITLE: Triton-Ops - A Ruby Interface for Triton Operators
+#+LATEX: \pagebreak
+
+* Overview
+
+  ~triton-ops~ provides Contract-based models for working with the parts of
+  Triton that aren't exposed through the Cloud API. Specifically, it consumes
+  JSON produced by tools on a Triton Headnode over SSH, records a snapshot of
+  that data, and provides a predictable set of Objects to explore those
+  snapshots.
+
+* Requirements
+
+  - SSH Access to a Triton Headnode
+  - A local Redis to record snapshots.
+
+* Usage
+
+  ~triton-ops~ includes two utilities to get you started. For more detailed
+  usage, invoke them with =--help=.
+
+** triton-ops-collect
+
+   This program connects to a headnode over SSH, collects data using standard
+   tools included with Triton, and records this information to Redis.
+
+** triton-ops-report
+
+   This program generates usage reports from snapshots recorded by
+   ~triton-ops-collect~.
+
+* License
+
+  ~triton-ops~ is available under the [[https://tldrlegal.com/license/mit-license][MIT License]]. See ~LICENSE.txt~ for the
+  full text.
+
+* Contributors
+
+  - [[https://colstrom.github.io/][Chris Olstrom]] | [[mailto:chris@olstrom.com][e-mail]] | [[https://twitter.com/ChrisOlstrom][Twitter]]
+  - Mark Yen

data/bin/triton-ops-collect

@@ -0,0 +1,76 @@
+#! /usr/bin/env ruby
+# -*- ruby -*-
+
+require 'json'        # Ruby Standard Library
+require 'optparse'    # Ruby Standard Library
+require 'pry'         # MIT License
+require 'tty-spinner' # MIT License
+
+require_relative '../lib/triton-ops/snapshot/collector'
+require_relative '../lib/triton-ops/snapshot/explorer'
+
+feature = {
+  interactive: ENV.fetch('INTERACTIVE') { STDIN.tty? } != 'false',
+  namespace:   ENV.fetch('NAMESPACE')   { '' },
+}
+
+####################################
+# Option Handling and Program Help #
+####################################
+
+OptionParser.new do |options|
+  program = File.basename $PROGRAM_NAME
+
+  # Interactive and non-interactive usage differ slightly. While the form is
+  # consistent, non-interactive usage *requires* arguments, which could
+  # otherwise be resolved with interactive prompts.
+  banner = {
+    'interactive'     => "usage: #{program} [--interactive]   [options] [headnode]",
+    'non-interactive' => "usage: #{program} --non-interactive [options] <headnode>",
+  }
+
+  # To emphasize the difference between interactive and non-interactive usage,
+  # the currently *active* mode is presented in bold typeface.
+  options.on('-h', '--help', "Show this help text") do
+    active         = feature[:interactive] ? 'interactive' : 'non-interactive'
+    banner[active] = Pastel.new.bold banner[active]
+    options.banner = banner.values.join("\n")
+
+    puts options
+    exit
+  end
+
+  options.on('-i', '--interactive',         "Enable interactive prompts (default)") {     feature[:interactive] = true  }
+  options.on('-n', '--non-interactive',     "Disable interactive prompts")          {     feature[:interactive] = false }
+  options.on('-N', '--namespace NAMESPACE', "Use NAMESPACE for Redis keys")         { |o| feature[:namespace]   = o     }
+end.parse!
+
+#####################
+# Argument Handling #
+#####################
+
+begin
+  interactive = ::TritonOps::Snapshot::Explorer.new namespace: feature[:namespace]
+  headnode    = ARGV.shift || (interactive.headnode if feature[:interactive])
+rescue Interrupt, TTY::Reader::InputInterrupt
+  exit Errno::EINTR::Errno
+end
+
+exit Errno::EINVAL::Errno if [headnode].any?(&:nil?)
+
+################
+# Main Program #
+################
+
+collector = TritonOps::Snapshot::Collector.new headnode, namespace: feature[:namespace]
+
+%w(VMs Users Images Servers Platforms).map do |target|
+  TTY::Spinner.new("[:spinner] Collecting #{target} ...", format: :arrow_pulse).run('done!') do
+    target.downcase!
+    collector.record target, collector.method(target).call
+  end
+end
+
+puts "#{headnode} #{collector.timestamp.iso8601}"
+
+binding.pry if ENV.fetch('HACKING', 'false') != 'false'

data/bin/triton-ops-report

@@ -0,0 +1,93 @@
+#! /usr/bin/env ruby
+# -*- ruby -*-
+
+require 'json'        # Ruby Standard Library
+require 'optparse'    # Ruby Standard Library
+require 'pry'         # MIT License
+
+require_relative '../lib/triton-ops/snapshot'
+require_relative '../lib/triton-ops/snapshot/explorer'
+require_relative '../lib/triton-ops/snapshot/reporter'
+
+feature = {
+  exclude:     [],
+  format:      :unicode,
+  interactive: ENV.fetch('INTERACTIVE') { STDIN.tty? } != 'false',
+  namespace:   ENV.fetch('NAMESPACE')   { '' },
+}
+
+####################################
+# Option Handling and Program Help #
+####################################
+
+OptionParser.new do |options|
+  program = File.basename $PROGRAM_NAME
+
+  # Interactive and non-interactive usage differ slightly. While the form is
+  # consistent, non-interactive usage *requires* arguments, which could
+  # otherwise be resolved with interactive prompts.
+  banner = {
+    'interactive'     => "usage: #{program} [--interactive]   [options] [headnode] [snapshot] [user ...]",
+    'non-interactive' => "usage: #{program} --non-interactive [options] <headnode> <snapshot> [user ...]",
+  }
+
+  # To emphasize the difference between interactive and non-interactive usage,
+  # the currently *active* mode is presented in bold typeface.
+  options.on('-h', '--help', "Show this help text") do
+    active         = feature[:interactive] ? 'interactive' : 'non-interactive'
+    banner[active] = Pastel.new.bold banner[active]
+    options.banner = banner.values.join("\n")
+
+    puts options
+    exit
+  end
+
+  options.on('-i', '--interactive',         "Enable interactive prompts (default)") {     feature[:interactive] =  true  }
+  options.on('-n', '--non-interactive',     "Disable interactive prompts")          {     feature[:interactive] =  false }
+  options.on('-N', '--namespace NAMESPACE', "Use NAMESPACE for Redis keys")         { |o| feature[:namespace]   =  o     }
+  options.on('-E', '--exclude LOGIN',       "Exclude LOGIN from report")            { |o| feature[:exclude]     << o     }
+  options.on('-F', '--format FORMAT', "Format output as (basic|ascii|unicode). Defaults to unicode.") do |o|
+    feature[:format] = case o
+                       when /^b(asic)?$/
+                         :basic
+                       when /^a(scii)?$/
+                         :ascii
+                       when /^u(nicode)?$/
+                         :unicode
+                       else
+                         STDERR.puts Pastel.new.red "#{program}: error: option (--format): #{Pastel.new.bold o} is not one of ([b]asic|[a]scii|[u]nicode)"
+                         exit Errno::EINVAL::Errno
+                       end
+  end
+
+end.parse!
+
+#####################
+# Argument Handling #
+#####################
+
+begin
+  interactive = ::TritonOps::Snapshot::Explorer.new namespace: feature[:namespace]
+  headnode    = ARGV.shift || (interactive.headnode          if feature[:interactive])
+  timestamp   = ARGV.shift || (interactive.snapshot headnode if feature[:interactive])
+rescue Interrupt, TTY::Reader::InputInterrupt
+  exit Errno::EINTR::Errno
+end
+
+exit Errno::EINVAL::Errno if [headnode, timestamp].any?(&:nil?)
+
+################
+# Main Program #
+################
+
+snapshot = TritonOps::Snapshot.new headnode, timestamp
+
+reporter = TritonOps::Snapshot::Reporter.new(
+  snapshot,
+  format: feature[:format],
+  exclude: feature[:exclude],
+  targets: ARGV)
+
+reporter.usage
+
+binding.pry if ENV.fetch('HACKING', 'false') != 'false'

data/lib/triton-ops/resource/image.rb

@@ -0,0 +1,195 @@
+
+# -*- ruby -*-
+
+require 'contracts' # BSD-2-Clause License
+
+require_relative '../support/feature/comparable_as_hash'
+require_relative '../support/feature/hash_from_initialization_contract'
+require_relative '../support/types'
+require_relative '../support/type_coercion'
+require_relative 'user'
+
+module TritonOps
+  module Resource
+    class Image
+      include ::Contracts::Core
+      include ::Contracts::Builtin
+      include ::TritonOps::Support::Feature::ComparableAsHash
+      include ::TritonOps::Support::Feature::HashFromInitializationContract
+      include ::TritonOps::Support::Types
+      include ::TritonOps::Support::TypeCoercion
+
+      Type = Enum[*%w(zone-dataset docker lx-dataset zvol other)]
+      OS   = Enum[*%w(smartos linux other bsd)]
+      State = Enum[*%w(active)]
+      NICDriver = Enum[*%w(virtio)]
+      DiskDriver = Enum[*%w(virtio)]
+      CPU = Enum[*%w(host)]
+
+      Contract ({
+                  :v            => Integer,
+                  :uuid         => String,
+                  :owner        => String,
+                  :name         => String,
+                  :version      => String,
+                  :state        => State,
+                  :disabled     => Bool,
+                  :public       => Bool,
+                  :published_at => Or[String, Time],
+                  :type         => Type,
+                  :os           => OS,
+                  :files        => ArrayOf[HashOf[Or[String, Symbol], Any]],
+
+                  :description  => Maybe[String],
+                  :requirements => Maybe[HashOf[Or[String, Symbol], Any]],
+                  :tags         => Maybe[HashOf[Or[String, Symbol], Any]],
+                  :homepage     => Maybe[String],
+                  :origin       => Maybe[String],
+                  :urn          => Maybe[String],
+                  :users        => Maybe[ArrayOf[HashOf[Or[String, Symbol], Any]]],
+                  :nic_driver   => Maybe[NICDriver],
+                  :disk_driver  => Maybe[DiskDriver],
+                  :cpu_type     => Maybe[CPU],
+                  :image_size   => Maybe[Integer],
+                }) => Image
+      def initialize(**options)
+        @options = options
+        self.to_h
+        remove_instance_variable '@options'
+        self
+      end
+
+      #######################
+      # Required Properties #
+      #######################
+
+      Contract None => Integer
+      def v
+        @v ||= @options.fetch :v
+      end
+
+      Contract None => String
+      def uuid
+        @uuid ||= @options.fetch :uuid
+      end
+
+      Contract None => String
+      def owner
+        @owner ||= @options.fetch :owner
+      end
+
+      Contract None => String
+      def name
+        @name ||= @options.fetch :owner
+      end
+
+      Contract None => String
+      def version
+        @version ||= @options.fetch :owner
+      end
+
+      Contract None => State
+      def state
+        @state ||= @options.fetch :state
+      end
+
+      Contract None => Bool
+      def disabled
+        @disabled ||= (@options || {}).fetch :disabled, false
+      end
+
+      Contract None => Bool
+      def public
+        @public ||= (@options || {}).fetch :public, false
+      end
+
+      Contract None => Time
+      def published_at
+        @published_at ||= Coerce.to_time @options.fetch :published_at
+      end
+
+      Contract None => Type
+      def type
+        @type ||= @options.fetch :type
+      end
+
+      Contract None => OS
+      def os
+        @os ||= @options.fetch :os
+      end
+
+      Contract None => ArrayOf[HashOf[Symbol, Any]]
+      def files
+        @files ||= @options.fetch(:files).map { |file| file.transform_keys(&:to_sym) }
+      end
+
+      alias disabled? disabled
+      alias public? public
+
+      ################################################
+      # Optional Properties (with sensible defaults) #
+      ################################################
+
+      Contract None => HashOf[Symbol, Any]
+      def requirements
+        @requirements ||= @options.fetch(:requirements, {}).transform_keys(&:to_sym)
+      end
+
+      Contract None => HashOf[String, Any]
+      def tags
+        @tags ||= @options.fetch(:tags, {}).transform_keys(&:to_s)
+      end
+
+      Contract None => ArrayOf[HashOf[Symbol, String]]
+      def users
+        @users ||= @options.fetch :users, []
+      end
+
+      ##########################################
+      # Optional Properties (without defaults) #
+      ##########################################
+
+      Contract None => Maybe[String]
+      def description
+        @description ||= (@options || {}).fetch :description, nil
+      end
+
+      Contract None => Maybe[String]
+      def homepage
+        @homepage ||= (@options || {}).fetch :homepage, nil
+      end
+
+      Contract None => Maybe[String]
+      def origin
+        @origin ||= (@options || {}).fetch :origin, nil
+      end
+
+      Contract None => Maybe[String]
+      def urn
+        @urn ||= (@options || {}).fetch :urn, nil
+      end
+
+      Contract None => Maybe[NICDriver]
+      def nic_driver
+        @nic_driver ||= (@options || {}).fetch :nic_driver, nil
+      end
+
+      Contract None => Maybe[DiskDriver]
+      def disk_driver
+        @disk_driver ||= (@options || {}).fetch :disk_driver, nil
+      end
+
+      Contract None => Maybe[CPU]
+      def cpu_type
+        @cpu_type ||= (@options || {}).fetch :cpu_type, nil
+      end
+
+      Contract None => Maybe[Integer]
+      def image_size
+        @image_size ||= (@options || {}).fetch :image_size, nil
+      end
+
+      alias size image_size
+    end
+  end
+end

data/lib/triton-ops/resource/platform.rb

@@ -0,0 +1,81 @@
+
+# -*- ruby -*-
+
+require 'contracts' # BSD-2-Clause License
+require 'time'      # Ruby Standard Library
+
+require_relative '../support/feature/comparable_as_hash'
+require_relative '../support/feature/hash_from_initialization_contract'
+require_relative '../support/type_coercion'
+require_relative '../support/types'
+
+module TritonOps
+  module Resource
+    class Platform
+      include ::Contracts::Core
+      include ::Contracts::Builtin
+      include ::TritonOps::Support::Feature::ComparableAsHash
+      include ::TritonOps::Support::Feature::HashFromInitializationContract
+      include ::TritonOps::Support::TypeCoercion
+      include ::TritonOps::Support::Types
+
+      ServerReference = {
+        hostname: String,
+        uuid:     String,
+      }
+
+      Contract ({
+                  :boot_platform => ArrayOf[ServerReference],
+                  :current_platform => ArrayOf[ServerReference],
+                  :default => Bool,
+                  :latest => Bool,
+                  :usb_key => Bool,
+                  :version => Castable::Time,
+                }) => Platform
+      def initialize(**options)
+        @options = options
+        self.to_h
+        remove_instance_variable '@options'
+        self
+      end
+
+      #######################
+      # Required Properties #
+      #######################
+
+      Contract None => Time
+      def version
+        @version ||= Coerce.to_time @options.fetch :version
+      end
+
+      Contract None => ArrayOf[ServerReference]
+      def boot_platform
+        @boot_platform ||= @options.fetch(:boot_platform).map { |hash| hash.transform_keys(&:to_sym) }
+      end
+
+      Contract None => ArrayOf[ServerReference]
+      def current_platform
+        @current_platform ||= @options.fetch(:current_platform).map { |hash| hash.transform_keys(&:to_sym) }
+      end
+
+      Contract None => Bool
+      def latest
+        @latest ||= (@options || {}).fetch(:latest, false)
+      end
+
+      Contract None => Bool
+      def default
+        @default ||= (@options || {}).fetch(:default, false)
+      end
+
+      Contract None => Bool
+      def usb_key
+        @usb_key ||= (@options || {}).fetch(:usb_key, false)
+      end
+
+      alias latest? latest
+      alias default? default
+      alias usb_key? usb_key
+    end
+  end
+end