radfish 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8324b8cbc6f0ee5f47d551325ad7231c967e2b5ac4e77afd29377f6b2bc8127a
+  data.tar.gz: b394714edbd0f4cf7c888cdb2d93da4e33d4bceb1e375be1666d6ff0e7b7438d
+SHA512:
+  metadata.gz: dce68259152ba35bfe749ca300fbeca2cc8acfd77e20fd0e0b7fa598dd43420b3c2a858b9ec2de99108822e559ec306b16c33cf4bd3977ca344e808d531b2a42
+  data.tar.gz: 1869fa92e7be91f7691fb4a7ab241f5206d5fdf040b8c916c105784cf725d497781a662e375ac7934bc1641fd1d60c6dd4edc4af53c263f32981aa1e94e1bed8

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jonathan Siegel
+
+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,531 @@
+# Radfish - Unified Redfish Client
+
+A Ruby client library that provides a unified interface for managing servers via Redfish API, with automatic vendor detection and adaptation.
+
+## Architecture
+
+Radfish provides a vendor-agnostic interface for server management through Redfish, automatically detecting and adapting to different hardware vendors. The architecture consists of:
+
+```
+radfish (core gem)
+├── Core modules (define interfaces)
+├── Vendor detection
+├── Client (delegates to adapters)
+├── Base classes
+└── Built-in adapters:
+    ├── radfish-idrac (Dell adapter)
+    │   └── IdracAdapter → wraps idrac gem
+    └── radfish-supermicro (Supermicro adapter)
+        └── SupermicroAdapter → wraps supermicro gem
+
+Future adapters:
+- radfish-hpe (HPE iLO)
+- radfish-lenovo (Lenovo XCC)
+- radfish-asrockrack
+```
+
+## Features
+
+### Automatic Vendor Detection
+- Automatically identifies Dell, Supermicro, HPE, Lenovo, and ASRockRack servers
+- Falls back to generic Redfish if vendor cannot be determined
+- Can be overridden with explicit vendor specification
+
+### Unified Interface
+Regardless of vendor, all adapters provide:
+
+- **Power Management**: on/off/restart/cycle
+- **System Inventory**: CPUs, memory, NICs, storage
+- **Virtual Media**: Mount/unmount ISOs
+- **Boot Configuration**: Boot order, one-time boot
+- **Monitoring**: Temperatures, fans, power consumption
+- **Event Logs**: System event log management
+- **Jobs/Tasks**: Long-running operation monitoring
+
+### Vendor-Specific Features
+Adapters can expose vendor-specific functionality while maintaining the common interface.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'radfish'
+```
+
+Or install directly:
+
+```bash
+gem install radfish
+```
+
+The radfish gem now includes built-in support for:
+- **Dell iDRAC** (via radfish-idrac)
+- **Supermicro** (via radfish-supermicro)
+
+These common adapters are included automatically, so you don't need to install them separately. Additional vendor support can be added as needed.
+
+## CLI Usage
+
+Radfish includes a powerful command-line interface for server management:
+
+### Quick Start
+
+```bash
+# Check system status
+radfish system --host 192.168.1.100 -u admin -p password
+
+# Power operations
+radfish power status --host 192.168.1.100 -u admin -p password
+radfish power on --host 192.168.1.100 -u admin -p password
+radfish power restart --host 192.168.1.100 -u admin -p password
+
+# Virtual media operations
+radfish media status --host 192.168.1.100 -u admin -p password
+radfish media mount https://example.com/ubuntu.iso --host 192.168.1.100 -u admin -p password
+radfish media unmount --host 192.168.1.100 -u admin -p password
+
+# Boot configuration
+radfish boot status --host 192.168.1.100 -u admin -p password
+radfish boot cd --once --host 192.168.1.100 -u admin -p password
+radfish boot pxe --uefi --host 192.168.1.100 -u admin -p password
+```
+
+### Environment Variables
+
+Configure common settings via environment variables to avoid repetition:
+
+```bash
+export RADFISH_HOST=192.168.1.100
+export RADFISH_USERNAME=admin
+export RADFISH_PASSWORD=password
+export RADFISH_VENDOR=supermicro  # Optional: auto-detects if not set
+export RADFISH_PORT=443           # Optional: defaults to 443
+
+# Now commands are simpler
+radfish system
+radfish power on
+radfish media mount https://example.com/ubuntu.iso
+```
+
+### Available Commands
+
+#### System Information
+```bash
+radfish system [OPTIONS]           # Display system information
+radfish cpus [OPTIONS]             # List CPUs
+radfish memory [OPTIONS]           # List memory modules
+radfish nics [OPTIONS]             # List network interfaces
+radfish drives [OPTIONS]           # List storage drives
+radfish psus [OPTIONS]             # List power supplies
+```
+
+#### Power Management
+```bash
+radfish power status [OPTIONS]     # Show current power state
+radfish power on [OPTIONS]         # Power on the system
+radfish power off [OPTIONS]        # Power off the system
+radfish power restart [OPTIONS]    # Restart the system
+radfish power cycle [OPTIONS]      # Power cycle the system
+```
+
+#### Virtual Media
+```bash
+radfish media status [OPTIONS]     # Show virtual media status
+radfish media mount URL [OPTIONS]  # Mount ISO from URL
+radfish media unmount [OPTIONS]    # Unmount all virtual media
+```
+
+#### Boot Configuration
+```bash
+radfish boot status [OPTIONS]      # Show boot configuration
+radfish boot cd [OPTIONS]          # Boot from virtual CD
+radfish boot pxe [OPTIONS]         # Boot from network (PXE)
+radfish boot disk [OPTIONS]        # Boot from hard disk
+radfish boot bios [OPTIONS]        # Boot to BIOS setup
+
+# Boot options:
+  --once        # Set boot override for next boot only
+  --continuous  # Set boot override until manually cleared
+  --uefi        # Use UEFI boot mode
+  --legacy      # Use Legacy/BIOS boot mode
+```
+
+#### Monitoring
+```bash
+radfish fans [OPTIONS]              # Show fan speeds
+radfish temps [OPTIONS]             # Show temperatures
+radfish power-consumption [OPTIONS] # Show power consumption
+radfish sel [OPTIONS]               # Show system event log
+radfish clear-sel [OPTIONS]         # Clear system event log
+```
+
+### Global Options
+
+All commands support these options:
+
+```bash
+  --host, -h HOST          # BMC hostname or IP address
+  --username, -u USER      # BMC username
+  --password, -p PASS      # BMC password
+  --vendor VENDOR          # Force specific vendor (dell, supermicro, etc.)
+  --port PORT              # BMC port (default: 443)
+  --json                   # Output in JSON format
+  --verbose, -v            # Enable verbose output (repeat for more verbosity)
+  --no-verify-ssl          # Skip SSL certificate verification
+```
+
+### Output Formats
+
+#### Default (Human-Readable)
+```bash
+$ radfish system
+System Information:
+  Manufacturer: Supermicro
+  Model: X11SCL-F
+  Serial: 0123456789
+  Power State: On
+  Health: OK
+```
+
+#### JSON Format
+```bash
+$ radfish system --json
+{
+  "manufacturer": "Supermicro",
+  "model": "X11SCL-F",
+  "serial": "0123456789",
+  "power_state": "On",
+  "health": "OK"
+}
+```
+
+### Common Workflows
+
+#### Mount ISO and Boot from It
+```bash
+# Mount the ISO
+radfish media mount https://releases.ubuntu.com/24.04/ubuntu-24.04-live-server-amd64.iso
+
+# Configure one-time boot from CD with UEFI
+radfish boot cd --once --uefi
+
+# Restart the system
+radfish power restart
+```
+
+#### Power Cycle with Monitoring
+```bash
+# Check current status
+radfish power status
+radfish temps
+
+# Perform power cycle
+radfish power cycle
+
+# Monitor until back online
+watch radfish power status
+```
+
+#### Automated Script Example
+```bash
+#!/bin/bash
+# Provision multiple servers
+
+SERVERS="192.168.1.100 192.168.1.101 192.168.1.102"
+ISO_URL="https://example.com/os-installer.iso"
+
+for server in $SERVERS; do
+  echo "Provisioning $server..."
+  
+  # Mount ISO
+  radfish media mount $ISO_URL --host $server -u admin -p password
+  
+  # Set one-time boot from CD
+  radfish boot cd --once --host $server -u admin -p password
+  
+  # Restart
+  radfish power restart --host $server -u admin -p password
+done
+```
+
+## Library Usage
+
+### Basic Usage with Auto-Detection
+
+```ruby
+require 'radfish'
+
+# Auto-detect vendor and connect
+Radfish.connect(
+  host: '192.168.1.100',
+  username: 'admin',
+  password: 'password'
+) do |client|
+  puts "Connected to #{client.vendor_name} server"
+  puts "Power state: #{client.power_status}"
+  
+  # Common operations work regardless of vendor
+  client.power_on
+  client.insert_virtual_media("http://example.com/os.iso")
+  client.boot_to_cd
+end
+```
+
+### Explicit Vendor Specification
+
+```ruby
+# Skip auto-detection if you know the vendor
+client = Radfish::Client.new(
+  host: '192.168.1.100',
+  username: 'admin',
+  password: 'password',
+  vendor: 'dell'  # or 'supermicro', 'hpe', etc.
+)
+
+client.login
+# ... operations ...
+client.logout
+```
+
+### Vendor Detection Only
+
+```ruby
+# Just detect the vendor without creating a client
+vendor = Radfish.detect_vendor(
+  host: '192.168.1.100',
+  username: 'admin',
+  password: 'password'
+)
+puts "Detected vendor: #{vendor}"
+# => "dell", "supermicro", "hpe", etc.
+```
+
+### Checking Supported Features
+
+```ruby
+client = Radfish::Client.new(
+  host: '192.168.1.100',
+  username: 'admin',
+  password: 'password'
+)
+
+# Check what this adapter supports
+puts client.supported_features
+# => [:power, :system, :storage, :virtual_media, :boot, :jobs, :utility]
+
+# Get adapter info
+puts client.info
+# => {
+#   vendor: "supermicro",
+#   adapter: "Radfish::SupermicroAdapter",
+#   features: [:power, :system, ...],
+#   host: "192.168.1.100",
+#   base_url: "https://192.168.1.100:443"
+# }
+```
+
+## Common Operations
+
+### Power Management
+
+```ruby
+client.power_status      # => "On" or "Off"
+client.power_on
+client.power_off
+client.power_restart
+client.power_cycle
+```
+
+### System Information
+
+```ruby
+# Basic system info
+info = client.system_info
+# => { "manufacturer" => "Dell", "model" => "PowerEdge R640", ... }
+
+# Hardware inventory
+client.cpus      # CPU information
+client.memory    # Memory DIMMs
+client.nics      # Network interfaces
+client.drives    # Physical drives
+client.psus      # Power supplies
+```
+
+### Virtual Media
+
+```ruby
+# Check current media
+media = client.virtual_media_status
+
+# Mount an ISO
+client.insert_virtual_media("http://example.com/os.iso")
+
+# Unmount all media
+client.unmount_all_media
+
+# Mount and configure boot
+client.mount_iso_and_boot("http://example.com/os.iso")
+```
+
+### Boot Configuration
+
+```ruby
+# Get boot options
+options = client.boot_options
+
+# Set one-time boot
+client.set_boot_override("Pxe", persistent: false)
+
+# Quick boot methods
+client.boot_to_pxe
+client.boot_to_disk
+client.boot_to_cd
+client.boot_to_bios_setup
+```
+
+### Monitoring
+
+```ruby
+# Thermal monitoring
+fans = client.fans
+temps = client.temperatures
+
+# Power monitoring
+power = client.power_consumption
+
+# Event logs
+events = client.sel_summary(limit: 10)
+client.clear_sel_log
+```
+
+## Multi-Vendor Environments
+
+Radfish shines in environments with mixed hardware vendors:
+
+```ruby
+servers = [
+  { host: '192.168.1.100', vendor: 'dell' },
+  { host: '192.168.1.101', vendor: 'supermicro' },
+  { host: '192.168.1.102', vendor: nil }  # auto-detect
+]
+
+servers.each do |server_config|
+  Radfish.connect(
+    host: server_config[:host],
+    username: 'admin',
+    password: 'password',
+    vendor: server_config[:vendor]
+  ) do |client|
+    # Same code works for all vendors
+    puts "#{client.vendor_name}: #{client.power_status}"
+    
+    if client.power_status == "Off"
+      client.power_on
+    end
+  end
+end
+```
+
+## Configuration Options
+
+```ruby
+Radfish::Client.new(
+  host: '192.168.1.100',
+  username: 'admin',
+  password: 'password',
+  
+  # Optional parameters
+  vendor: 'dell',           # Skip auto-detection
+  port: 443,                # BMC port
+  use_ssl: true,            # Use HTTPS
+  verify_ssl: false,        # Verify certificates
+  direct_mode: false,       # Use Basic Auth instead of sessions
+  retry_count: 3,           # Retry failed requests
+  retry_delay: 1,           # Initial delay between retries
+  verbosity: 0              # Debug output level (0-3)
+)
+```
+
+## Debugging
+
+Enable verbose output:
+
+```ruby
+client.verbosity = 1  # Basic debug info
+client.verbosity = 2  # Include request/response details  
+client.verbosity = 3  # Include stack traces
+```
+
+## Supported Vendors
+
+Currently supported:
+- **Dell** (via radfish-idrac)
+- **Supermicro** (via radfish-supermicro)
+
+Planned support:
+- **HPE** (iLO)
+- **Lenovo** (XCC)
+- **ASRockRack**
+- **Generic Redfish** (fallback)
+
+## Creating Custom Adapters
+
+To add support for a new vendor, create an adapter gem:
+
+```ruby
+# radfish-myvendor/lib/radfish/myvendor_adapter.rb
+module Radfish
+  class MyvendorAdapter < Core::BaseClient
+    include Core::Power
+    include Core::System
+    # ... include other modules
+    
+    def vendor
+      'myvendor'
+    end
+    
+    def power_status
+      # Implement vendor-specific logic
+    end
+    
+    # ... implement required methods
+  end
+  
+  # Register the adapter
+  Radfish.register_adapter('myvendor', MyvendorAdapter)
+end
+```
+
+## Benefits of the Unified Approach
+
+1. **Single API**: Learn once, use everywhere
+2. **Vendor Flexibility**: Switch hardware vendors without changing code
+3. **Automatic Detection**: No need to track which vendor each server uses
+4. **Gradual Migration**: Mix vendors during hardware transitions
+5. **Simplified Testing**: Mock one interface instead of many
+6. **Future-Proof**: New vendors can be added without changing existing code
+
+## Migration from Direct Vendor Gems
+
+If you're currently using the idrac or supermicro gems directly:
+
+```ruby
+# Old way (vendor-specific)
+require 'idrac'
+client = IDRAC::Client.new(host: '...', ...)
+
+# New way (unified)
+require 'radfish'
+require 'radfish/idrac_adapter'  # or let it auto-load
+client = Radfish::Client.new(host: '...', vendor: 'dell')
+
+# Or with auto-detection
+client = Radfish::Client.new(host: '...') 
+```
+
+The same method names work, so migration is straightforward.
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+desc "Run integration tests (requires real BMC)"
+RSpec::Core::RakeTask.new(:integration) do |t|
+  t.rspec_opts = "--tag integration"
+end
+
+desc "Run all tests including integration"
+task all: [:spec, :integration]

data/exe/radfish

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+
+require 'radfish/cli'
+Radfish::CLI.start(ARGV)

data/lib/radfish/cli/base.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Radfish
+  module CLI
+    module Base
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+      
+      module ClassMethods
+        def cli_instance
+          @cli_instance ||= Radfish::CLI.new
+        end
+      end
+      
+      def with_client(&block)
+        self.class.cli_instance.send(:with_client, &block)
+      end
+      
+      def success(message)
+        self.class.cli_instance.send(:success, message)
+      end
+      
+      def error(message)
+        self.class.cli_instance.send(:error, message)
+      end
+      
+      def info_msg(message)
+        self.class.cli_instance.send(:info_msg, message)
+      end
+      
+      def safe_call
+        yield
+      rescue => e
+        parent_options[:verbose] ? e.message : nil
+      end
+    end
+  end
+end