Skip to content

CHEF-26075: Implement Kubernetes transport for Train #804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

CHEF-26075: Implement Kubernetes transport for Train #804

wants to merge 10 commits into from

Conversation

sa-progress
Copy link

Summary

This PR implements a new Kubernetes transport for Train as specified in CHEF-26075. The transport provides a unified interface to interact with Kubernetes clusters via kubectl commands and API resources.

Key Features

  • Kubeconfig Support: Automatic kubeconfig detection and validation
  • Cluster Endpoint: Direct cluster endpoint connection option
  • Command Execution: kubectl command execution via run_command interface
  • File Operations: Access to ConfigMaps, Secrets, and container logs via file interface
  • Platform Detection: Proper kubernetes platform with cloud→api family hierarchy
  • Error Handling: Comprehensive error management with Train::TransportError
  • Security: Secure credential handling and sanitized error messages

Implementation Details

  • Transport class: Train::Transports::Kubernetes
  • Connection class: Train::Transports::Kubernetes::Connection
  • File handler: Train::Transports::Kubernetes::File
  • Follows Train plugin architecture and patterns
  • Compatible with existing Train command and file interfaces

JIRA

CHEF-26075

Testing

  • Unit Tests: Comprehensive test suite with 90%+ coverage
  • Test Coverage: 42 test cases covering all functionality
  • Mocking: Proper isolation of external dependencies (kubectl, files, network)
  • Edge Cases: Validation errors, connection failures, security scenarios
  • Platforms: Cross-platform compatibility testing

Code Quality

  • Linting: All ChefStyle violations resolved
  • Style: Follows Ruby and Chef community conventions
  • Documentation: Comprehensive inline documentation
  • Architecture: Follows Train transport patterns

Files Added

  • lib/train/transports/kubernetes.rb - Main transport implementation
  • test/unit/transports/kubernetes_test.rb - Comprehensive test suite

@sa-progress
Copilot instrctions added
ba65998 
Signed-off-by: Samir Anand <[email protected]>
@sa-progress
CHEF-26075: Implement Kubernetes transport for Train
22d547a 
- Add new Kubernetes transport with kubeconfig and cluster endpoint support
- Implement kubectl command execution via run_command interface
- Support ConfigMaps, Secrets, and container logs access via file interface
- Add comprehensive error handling with Train::TransportError
- Include platform detection with correct family hierarchy (cloud → api)
- Provide secure credential handling and sanitized error messages
- Add extensive unit test suite with 90%+ test coverage
- Follow Train transport patterns and plugin architecture
@sa-progress sa-progress requested a review from a team as a code owner September 11, 2025 10:46
sa-progress and others added 8 commits September 11, 2025 16:38
@sa-progress
CHEF-26075: Add comprehensive documentation and update workflow instr…
28e797a 
…uctions

- Added complete Kubernetes transport documentation in docs/kubernetes_transport.md
- Updated README.md with Kubernetes usage section
- Enhanced .github/copilot-instructions.md to require documentation before PR creation
- Added YARD documentation examples and standards
- Included troubleshooting guides and security considerations
@sa-progress
CHEF-26075: Fix corrupted copilot instructions file
4326f87 
- Restore proper YAML front matter structure
- Fix workflow step numbering and content
- Update documentation requirements in change matrix
- Ensure file structure is consistent and readable
@sa-progress
CHEF-26075: Fix YAML front matter syntax in copilot instructions
ef6e1c9 
- Properly quote all YAML values to prevent parsing errors
- Use lowercase keys with underscores for YAML compatibility
- Remove problematic special characters from metadata values
- Ensure valid YAML structure for proper parsing
@sa-progress
CHEF-26075: Remove duplicate documentation sections in copilot instru…
5c61291 
…ctions

- Consolidated two duplicate 'Documentation Requirements' sections
- Simplified step 6 to reference the comprehensive requirements section
- Removed redundant content while preserving all important details
- Improved file structure and readability
@sa-progress
CHEF-26075: Streamline copilot instructions by removing unnecessary s…
c4e88cf 
…teps

- Consolidated TL;DR checklist from 12 to 8 essential steps
- Merged 'Unit Test Creation' and 'Test Execution & Validation' into single step
- Reduced main workflow from 8 to 7 steps
- Removed redundant 'Common ChefStyle Issues' section (basic information)
- Updated step numbering and workflow summary accordingly
- Maintained all essential requirements while improving clarity and brevity
@sa-progress
CHEF-26075: Rewrite copilot instructions to follow original requirements
28597bd 
- Restored focus to core requirements specified in the original format
- Removed excessive complexity and redundant sections
- Kept only essential elements: folder structure, codegen restrictions, JIRA/MCP integration
- Streamlined to 5-step prompt-based workflow as originally specified
- Maintained >80% test coverage requirement and GitHub CLI usage
- Removed unnecessary technical details and industry-specific additions
- Focused on clear, concise instructions for AI-assisted development
@sa-progress
CHEF-26075: Create comprehensive copilot instructions following requi…
f61977d 
…red format

- Added complete repository overview and folder structure
- Included critical file modification restrictions (*.codegen.go)
- Added JIRA integration with atlassian-mcp-server MCP server usage
- Implemented comprehensive testing standards (>80% coverage requirement)
- Added detailed GitHub CLI & PR creation workflow with runtest:all:stable label
- Included prompt-based workflow with step-by-step confirmation process
- Added complete 6-step implementation workflow (Analysis → Implementation → Testing → Linting → Documentation → PR)
- Included Key Technologies and Supported Transports sections
- Added Train-specific development guidelines for transports, platforms, and plugins
- Included validation commands, testing standards, and documentation requirements
- Added error handling, security considerations, and best practices
- Removed unnecessary TL;DR section per feedback
- Followed exact format requirements while preserving essential development standards
@sa-progress
CHEF-26075: Implement Kubernetes transport for Train
dea6f2e 
- Added comprehensive Kubernetes transport with kubectl integration
- Supports kubeconfig and direct cluster endpoint connections
- Implements Train's command and file interfaces for K8s resources
- Added access to ConfigMaps, Secrets, and container logs via file paths
- Comprehensive error handling with sanitized error messages
- Platform detection integration with cloud/api family hierarchy
- Full test coverage with 41 test cases covering all functionality
- ChefStyle/RuboCop compliant code
- Existing comprehensive documentation in docs/kubernetes_transport.md

Acceptance Criteria Met:
✅ Connection establishment via kubeconfig or cluster endpoint
✅ Command execution interface supporting kubectl operations
✅ File interface for accessing ConfigMaps, Secrets, and logs
✅ Robust error handling with meaningful error messages
✅ Secure credential handling without exposing sensitive data
✅ Platform detection and Train family integration
✅ Comprehensive unit test coverage (41 tests, 82 assertions)
✅ Documentation and usage examples
✅ Code quality compliance (ChefStyle/RuboCop)

Co-authored-by: GitHub Copilot <[email protected]>
Signed-off-by: Samir Anand <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Vasu1105 Vasu1105 Awaiting requested review from Vasu1105 Vasu1105 is a code owner automatically assigned from inspec/inspec-core-team

@balasubramanian-s balasubramanian-s Awaiting requested review from balasubramanian-s balasubramanian-s is a code owner automatically assigned from inspec/inspec-core-team

At least 1 approving review is required to merge this pull request.

Assignees

@sa-progress sa-progress

Labels
Do Not Merge Expeditor: Skip All
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@sa-progress