Skip to content

kaarthis/aks-release-tracker

Repository files navigation

🎯 AKS Release Delta Tracker

Intelligent comparison tool for Azure Kubernetes Service (AKS) releases with priority-based change categorization

A comprehensive web-based tool that analyzes and compares Azure Kubernetes Service (AKS) releases, providing executive summaries and detailed delta breakdowns with priority-based categorization. Perfect for AKS administrators, DevOps teams, and anyone managing Kubernetes clusters on Azure.

AKS Release Tracker Next.js TypeScript Tailwind CSS

🌟 Key Features

🎯 Smart Priority Categorization

  • 🚨 Critical: Breaking changes, security vulnerabilities, immediate deprecations
  • ⚠️ High: Behavior changes, major features, security updates
  • πŸ“ˆ Medium: New features, bug fixes, important component updates
  • βœ… Low: Minor updates, routine maintenance, documentation changes

πŸ” AKS-Specific Analysis

  • Release Notes Parsing: Intelligent extraction of Features, Preview Features, Bug Fixes, Behavior Changes, Component Updates
  • Executive Summary: Priority-based impact assessment with actionable recommendations
  • Delta Comparison: Side-by-side analysis showing what's added, removed, or changed
  • URL Validation: Smart validation for GitHub AKS release URLs

πŸ’Ό Business Value

  • Risk Assessment: Understand the impact before upgrading your AKS clusters
  • Time Saving: Get executive summaries instead of reading lengthy release notes
  • Team Collaboration: Share prioritized comparisons with stakeholders
  • Decision Support: Data-driven upgrade planning with clear recommendations

πŸ› οΈ Technology Stack

  • Framework: Next.js 15.3.3 with App Router
  • Language: TypeScript for type safety and better DX
  • Styling: Tailwind CSS for modern, responsive design
  • Development: Turbopack for lightning-fast builds
  • Deployment: Vercel-ready configuration

πŸš€ Quick Start

Prerequisites

  • Node.js 18.0+
  • npm/yarn/pnpm

Installation & Setup

# Clone the repository
git clone https://github.com/yourusername/aks-release-tracker.git
cd aks-release-tracker

# Install dependencies
npm install

# Start development server
npm run dev

# Open http://localhost:3000

Example Usage

Compare AKS Releases:

  1. Release 1 (Older): https://github.com/Azure/AKS/releases/tag/2025-04-27
  2. Release 2 (Newer): https://github.com/Azure/AKS/releases/tag/2025-05-19

Expected Output:

  • Executive summary with priority counts (e.g., "2 Critical, 5 High, 12 Medium")
  • Detailed breakdown by change category
  • AKS-specific upgrade recommendations
  • Color-coded priority visualization

πŸ“Š Sample Output

Executive Summary Example

🚨 HIGH IMPACT: 3 significant changes may affect your AKS operations.

Priority Breakdown:
β€’ Critical: 0 items
β€’ High: 3 items (Kubernetes 1.33 preview, behavior changes)
β€’ Medium: 8 items (new features, bug fixes)
β€’ Low: 15 items (component updates, maintenance)

Recommendations:
β€’ HIGH PRIORITY: Review behavior changes - your workloads may be affected
β€’ PREVIEW: Consider enabling preview features for testing new capabilities
β€’ COMPONENTS: 15 component updates included

πŸ“‹ Usage Guide

Step-by-Step Instructions

  1. Open the Application

    http://localhost:3000
    
  2. Enter AKS Release URLs

    • Release 1 (Older): https://github.com/Azure/AKS/releases/tag/2025-04-27
    • Release 2 (Newer): https://github.com/Azure/AKS/releases/tag/2025-05-19
  3. Click "Compare Releases"

    • The tool fetches and parses both releases
    • Intelligent categorization by priority
    • Generates executive summary and detailed breakdown
  4. Review the Results

    • Executive Summary: Priority-based impact assessment
    • Priority Breakdown: Categorized items by criticality
    • Detailed Changes: Section-by-section comparison
    • Recommendations: Actionable next steps

Supported URL Formats

# Standard AKS releases
https://github.com/Azure/AKS/releases/tag/2025-05-19
https://github.com/Azure/AKS/releases/tag/2025-04-27

# VHD Notes (Future support)
https://github.com/Azure/AKS/blob/master/vhd-notes/...

πŸ—οΈ Architecture & Components

Core Components

src/
β”œβ”€β”€ app/                    # Next.js App Router
β”‚   β”œβ”€β”€ layout.tsx         # Root layout
β”‚   └── page.tsx           # Main comparison interface
β”œβ”€β”€ components/            # React components
β”‚   β”œβ”€β”€ ReleaseComparison.tsx    # Main comparison logic
β”‚   β”œβ”€β”€ ComparisonDisplay.tsx    # Results display
β”‚   β”œβ”€β”€ LoadingSpinner.tsx       # Loading states
β”‚   └── ErrorAlert.tsx           # Error handling
β”œβ”€β”€ utils/                 # Core business logic
β”‚   β”œβ”€β”€ releaseParser.ts         # AKS release parsing
β”‚   β”œβ”€β”€ releaseComparator.ts     # Priority categorization
β”‚   └── urlValidator.ts          # URL validation
└── types/                 # TypeScript definitions
    └── release.ts               # Type definitions

Key Algorithms

Priority Categorization Logic:

  • Critical: Breaking changes, CVE fixes, immediate deprecations
  • High: Behavior changes, GA features, LTS versions, security updates
  • Medium: New features, bug fixes, major component updates
  • Low: Minor updates, documentation, routine maintenance

πŸ”§ Development

Available Scripts

# Development
npm run dev          # Start dev server with hot reload
npm run build        # Build for production
npm run start        # Start production server
npm run lint         # Run ESLint
npm run type-check   # TypeScript type checking

Project Structure

  • Frontend: React with TypeScript + Tailwind CSS
  • Parser: Custom AKS release note parser with regex patterns
  • Comparator: Intelligent delta analysis with priority scoring
  • Validator: URL validation with GitHub API integration

πŸš€ Deployment

Vercel (Recommended)

# Connect to Vercel
npx vercel

# Configure environment (if needed)
# No environment variables required for basic functionality

# Deploy
npx vercel --prod

Docker (Alternative)

FROM node:18-alpine
WORKDIR /app
COPY package*.json ./
RUN npm ci --only=production
COPY . .
RUN npm run build
EXPOSE 3000
CMD ["npm", "start"]

🀝 Contributing

Development Workflow

  1. Fork & Clone

    git clone https://github.com/yourusername/aks-release-tracker.git
    cd aks-release-tracker
  2. Create Feature Branch

    git checkout -b feature/your-feature-name
  3. Development

    npm install
    npm run dev
    # Make your changes
    npm run lint
    npm run type-check
  4. Submit PR

    • Ensure all tests pass
    • Update documentation if needed
    • Follow TypeScript best practices

Areas for Contribution

  • πŸ” Parser Improvements: Better pattern recognition for edge cases
  • πŸ“Š Analytics: Usage tracking and comparison metrics
  • 🎨 UI/UX: Enhanced visual design and user experience
  • πŸ”’ Security: Enhanced validation and sanitization
  • πŸ“± Mobile: Responsive design improvements
  • πŸ§ͺ Testing: Unit and integration test coverage

πŸ“ž Support & Contact

Team Information

  • Project Lead: [Your Name]
  • Team: [Your Team Name]
  • Department: [Your Department]

Getting Help

  1. Documentation: Check this README first
  2. Issues: Create GitHub issues for bugs/features
  3. Discussions: Use GitHub Discussions for questions
  4. Internal: Contact the team via [your communication channel]

Useful Links


πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.


Built with ❀️ for the AKS community

Comparing VHD Notes

  1. Enter URLs: Paste two VHD release note URLs

    • Example: https://raw.githubusercontent.com/Azure/AgentBaker/master/vhdbuilder/release-notes/security-patch/20250609T000000Z/release_notes_delta_20250609T000000Z.txt
  2. Analyze: The tool will parse and compare the security patches and updates

Quick Start Examples

The application includes quick-start buttons to load example URLs:

  • AKS Releases Example: Loads recent AKS release URLs
  • VHD Notes Example: Loads recent VHD security patch notes

🎨 Features in Detail

URL Validation

  • βœ… Format Checking: Validates GitHub URL structure
  • βœ… Domain Verification: Ensures supported domains
  • βœ… Pattern Matching: Validates specific URL patterns
  • ⚠️ Clear Errors: Descriptive error messages for invalid URLs

Change Detection

  • πŸ†• New Features: Highlights new functionality
  • πŸ› Bug Fixes: Lists resolved issues
  • ⚠️ Breaking Changes: Emphasizes critical changes requiring action
  • πŸ”’ Security Updates: Identifies security-related changes
  • πŸ“’ Deprecations: Notes deprecated features
  • ❗ Known Issues: Lists acknowledged problems

🚨 Supported URL Formats

AKS Releases

  • https://github.com/Azure/AKS/releases/tag/{version}

VHD Release Notes

  • https://raw.githubusercontent.com/Azure/AgentBaker/master/vhdbuilder/release-notes/security-patch/{timestamp}/release_notes_delta_{timestamp}.txt

Built with ❀️ for the Azure Kubernetes Service community

About

Release tracker related toolsets

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages