NotHarshhaa/devops-environment-toolkit-beginners
This repo provides a ready-to-use local setup with all the essential tools you need before starting your DevOps learning journey.
π DevOps Environment Toolkit for Beginners
Enterprise-grade DevOps environment setup with advanced security and reliability features - Get all essential tools installed, configured, and verified on your local machine with comprehensive error handling, rollback capabilities, and automated health checks!
β¨ What This Toolkit Does
This enterprise-grade toolkit automatically installs, configures, and verifies all the essential DevOps tools you need to start your learning journey on your local machine. Version 2.0.0 introduces advanced security features, comprehensive error handling, rollback capabilities, and automated health checks - making it the most reliable and secure DevOps environment setup available for beginners.
π οΈ Tools Included
| Category | Tools | Purpose | Features |
|---|---|---|---|
| Version Control | Git | Code versioning with helpful aliases | Auto-update checking, secure configuration |
| Containerization | Docker, Docker Compose | Container management and orchestration | Health monitoring, security scans |
| Orchestration | Kubernetes (kubectl + Minikube) | Container orchestration and local development | Version checking, diagnostics |
| Infrastructure | Terraform | Infrastructure as Code | Update notifications, validation |
| Configuration | Ansible | Configuration management and automation | Security configuration checks |
| Development | VS Code | Enhanced development experience with DevOps extensions | Extension verification |
| Cloud CLI | AWS CLI, Azure CLI | Multi-cloud management | Credential security checks |
π Quick Start
π Enhanced Installation Options (v2.0.0)
Choose from multiple installation modes with enterprise-grade features:
π Standard Installation (All Tools with Security)
# Linux/macOS
./install.sh
# Windows PowerShell
.\install.ps1Features: TLS verification, rollback, update checking, security scans
π― Selective Installation (Choose Your Tools)
# Linux/macOS - Interactive menu to choose tools
./install.sh --selective
# Windows PowerShell - Interactive menu to choose tools
.\install.ps1 -SelectiveFeatures: Input validation, secure tool selection, progress tracking
π Preview Installation (See What Would Be Installed)
# Linux/macOS - Dry run mode
./install.sh --dry-run
# Windows PowerShell - Dry run mode
.\install.ps1 -DryRunFeatures: Safe preview, no system changes, detailed logging
π Verbose Installation (Detailed Output)
# Linux/macOS - Verbose mode with debugging
./install.sh --verbose
# Windows PowerShell - Verbose mode with debugging
.\install.ps1 -VerboseFeatures: Detailed logging, step-by-step progress, error diagnostics
π‘οΈ Security-First Installation
# Linux/macOS - Include security configuration checks
./install.sh --security
# Windows PowerShell - Include security configuration checks
.\install.ps1 -SecurityFeatures: Credential scanning, permission checks, security validation
π Remote Installation
# Linux/macOS
curl -fsSL https://raw.githubusercontent.com/NotHarshhaa/devops-environment-toolkit-beginners/master/install.sh | bash
# Windows PowerShell
iwr -useb https://raw.githubusercontent.com/NotHarshhaa/devops-environment-toolkit-beginners/master/install.ps1 | iexManual Installation
git clone https://github.com/NotHarshhaa/devops-environment-toolkit-beginners.git
cd devops-environment-toolkit
chmod +x install.sh
./install.shπ― Features
π Core Features (v2.0.0 Enhanced)
- π One-Click Local Installation: Automated setup for all major platforms on your local machine
- β‘ Lightning Fast: Optimized installation process - ready in minutes
- π¨ Pre-configured: Tools come with sensible defaults and configurations for beginners
- π§ Customizable: Easy to modify and extend as you learn
- π± Cross-Platform: Works on Linux, macOS, and Windows
- π‘οΈ Enterprise Security: TLS verification, credential scanning, permission checks
- π Advanced Rollback: Automatic backup and restore functionality on failure
- π Beginner-Friendly: Clear documentation, examples, and learning resources
- π Learning-Focused: Designed specifically for DevOps beginners starting their journey
π Security & Reliability Features (NEW)
- π TLS Certificate Verification: Secure downloads with certificate validation
- π‘οΈ Input Sanitization: Prevents injection attacks and validates user input
- π Credential Scanning: Detects exposed API keys and sensitive data
- π Permission Validation: Checks and sets appropriate file permissions
- π Automatic Backup: Creates backups before making system changes
- π¨ Rollback on Failure: Automatic recovery with user confirmation
- π Update Checking: Notifies when tool updates are available
- π₯ Health Diagnostics: Comprehensive system and tool health checks
β¨ Advanced Installation Features
- π― Selective Installation: Choose which tools to install with interactive menus
- π Progress Tracking: Visual progress bars with percentage completion
- π Comprehensive Logging: Detailed logs saved to files with timestamps
- β System Validation: Checks disk space, memory, and internet connectivity
- π Dry Run Mode: Preview installation without making changes
- π JSON Reports: Machine-readable reports for automation and CI/CD
- π¨ Enhanced UI: Better colors, formatting, and user experience
- π Support Documentation: Direct links to official documentation for each tool
π Project Structure (v2.0.0 Enhanced)
devops-environment-toolkit/
βββ install.sh # Main installation script (Linux/macOS) - Enhanced v2.0.0
βββ install.ps1 # Windows installation script - Enhanced v2.0.0
βββ verify.sh # Tool verification script (Linux/macOS) - Enhanced v2.0.0
βββ verify.ps1 # Tool verification script (Windows) - Enhanced v2.0.0
βββ scripts/
β βββ setup.sh # Environment setup script - Enhanced v2.0.0
βββ configs/ # Configuration files
β βββ docker/ # Docker configurations
β βββ vscode/ # VS Code settings
βββ templates/ # Project templates
β βββ basic-web-app/ # Simple web application
βββ examples/ # Example configurations
βββ README.md # This documentation - Updated for v2.0.0
π Script Capabilities
| Script | Primary Function | Key Features |
|---|---|---|
| install.sh/install.ps1 | Tool Installation | Security scans, rollback, update checking, progress tracking |
| verify.sh/verify.ps1 | Environment Verification | Health checks, security validation, JSON reports, diagnostics |
| scripts/setup.sh | Environment Setup | Backup/restore, validation, customization options |
π§ Post-Installation Setup
After installation, set up your development environment:
π οΈ Environment Setup
# Linux/macOS
./scripts/setup.sh
# Windows PowerShell
.\scripts\setup.shSetup Options:
# Verbose setup with detailed output
./scripts/setup.sh --verbose
# Preview setup changes
./scripts/setup.sh --dry-run
# Skip backup creation
./scripts/setup.sh --skip-backup
# Skip sample project creation
./scripts/setup.sh --no-sample
# Recover from backup
./scripts/setup.sh --recoverπ Environment Verification
# Linux/macOS - Standard verification
./verify.sh
# Windows PowerShell - Standard verification
.\verify.ps1
# Enhanced verification with health checks and security scanning
./verify.sh --health --security --verbose
# JSON output for automation
./verify.sh --jsonπ What You Get After Setup
1. π Secure Development Environment
- Validated tool configurations with security checks
- Proper file permissions and access controls
- Credential exposure detection and prevention
- Automated backup and recovery systems
2. π Organized Project Structure
~/.devops-toolkit/
βββ configs/ # Tool configurations
βββ templates/ # Project templates
βββ scripts/ # Utility scripts
βββ examples/ # Example configurations
βββ system-report.txt # Detailed installation report
3. π Sample Project Ready
- Complete web application template
- Docker Compose configuration
- VS Code workspace settings
- Git repository with initial commit
- DevOps aliases for productivity
4. π Enhanced Learning Resources
- Pre-configured development environment
- Comprehensive documentation links
- Health monitoring and diagnostics
- Update notifications for tools
π§ Advanced Customization
The toolkit is designed to be highly customizable and extensible:
π¨ Configuration Customization
- Modify
configs/: Change tool configurations and settings - Edit
templates/: Create custom project templates - Extend
scripts/: Add utility scripts and automation - Update
examples/: Add example configurations
π§ Script Customization
- Installation Scripts: Add new tools or modify installation logic
- Verification Scripts: Extend health checks and validation
- Setup Script: Customize environment setup process
- Add Features: Implement new security checks or diagnostics
π Automation Integration
# JSON output for CI/CD pipelines
./verify.sh --json > verification-results.json
# Automated setup for development environments
./scripts/setup.sh --skip-backup --no-sample
# Security scanning for compliance
./verify.sh --security --verbose > security-report.txtπ Enhanced Beginner Learning Path (v2.0.0)
With our enterprise-grade toolkit, follow this structured learning path with built-in monitoring, security, and best practices:
π Week-by-Week Learning Journey
Week 1: Foundation & Security Fundamentals
- π Security First: Learn secure development practices
- π Version Control: Master Git workflows with enhanced aliases
- π³ Container Basics: Learn Docker with health monitoring
- π οΈ Environment Setup: Configure your secure development environment
- π Verification: Use health checks to validate your setup
Week 2: Infrastructure as Code & Automation
- ποΈ Terraform: Learn IaC with update notifications and validation
- βοΈ Ansible: Master configuration management with security checks
- βοΈ Cloud Basics: AWS/Azure CLI with credential security
- π Automation: Build your first automated workflows
- π Monitoring: Track tool versions and system health
Week 3: Container Orchestration
- βΈοΈ Kubernetes: Learn kubectl with diagnostics and health checks
- π Local Development: Master Minikube with monitoring
- π§ Advanced Docker: Multi-container applications with Compose
- π‘οΈ Security Scanning: Check for exposed credentials
- π JSON Reporting: Generate reports for automation
Week 4: Advanced DevOps Practices
- π CI/CD Integration: Use JSON outputs for pipelines
- π Security Compliance: Implement security best practices
- π System Monitoring: Advanced health diagnostics
- π οΈ Tool Management: Update checking and version control
- π Production Readiness: Prepare for real-world deployment
Week 5-6: Real-World Projects
- ποΈ End-to-End Projects: Complete microservices applications
- βοΈ Cloud Deployment: Deploy to AWS/Azure with security
- π§ Infrastructure Automation: Terraform + Ansible + Kubernetes
- π Monitoring & Alerting: System health and security monitoring
- π Continuous Improvement: Update management and optimization
π― Learning Features
- π Progress Tracking: Built-in verification and health checks
- π Security Focus: Learn security best practices from day one
- π οΈ Hands-On: Practical projects with real tools
- π Documentation: Comprehensive guides and examples
- π Continuous Learning: Update notifications and version management
Enterprise-Ready Learning: Each week builds upon the previous, taking you from complete beginner to confident DevOps practitioner with security-first practices and enterprise-grade tooling.
π Enhanced Documentation & Support
π Comprehensive Documentation
After installation, you'll have access to enhanced support documentation:
π Installation Reports
- Text Report:
~/.devops-toolkit/system-report.txt - JSON Report:
~/.devops-toolkit/system-report.json - Setup Log:
~/.devops-toolkit-setup.log - Verification Log:
~/.devops-toolkit-verify.log
π Tool Documentation & Resources
| Tool | Documentation | Version Check | Health Status |
|---|---|---|---|
| Git | https://git-scm.com/doc | β Auto-check | β Health monitor |
| Docker | https://docs.docker.com/ | β Auto-check | β Daemon status |
| Kubernetes | https://kubernetes.io/docs/ | β Auto-check | β Cluster status |
| Terraform | https://developer.hashicorp.com/terraform/docs | β Auto-check | β Version validation |
| Ansible | https://docs.ansible.com/ | β Auto-check | β Configuration check |
| VS Code | https://code.visualstudio.com/docs | β Extension check | β Workspace validation |
| AWS CLI | https://docs.aws.amazon.com/cli/ | β Auto-check | β Credential security |
| Azure CLI | https://docs.microsoft.com/en-us/cli/azure/ | β Auto-check | β Authentication check |
π οΈ Command Reference
# Quick verification commands
devops-verify # Run environment verification
devops-start # Start sample project
devops-stop # Stop sample project
devops-logs # View application logs
# Health and security checks
./verify.sh --health --security
./verify.sh --json --verbose
# Setup and recovery
./scripts/setup.sh --recover
./scripts/setup.sh --verboseπ§ Troubleshooting
- π System Reports: Detailed environment status
- π Health Diagnostics: Tool-specific health checks
- π‘οΈ Security Scans: Credential and permission validation
- π Log Analysis: Comprehensive logging with timestamps
- π Recovery Options: Automatic backup and restore
π€ Contributing to v2.0.0
We welcome contributions to our enterprise-grade DevOps toolkit! Please see our Contributing Guidelines for details.
π Priority Contribution Areas
- π Security Enhancements: Add new security checks and validations
- π Monitoring: Improve health diagnostics and reporting
- π οΈ Tool Support: Add support for additional DevOps tools
- π Documentation: Improve guides and examples
- π Automation: Enhance CI/CD integration features
π‘ Quick Contribution Ideas
- Add support for new tools (Prometheus, Grafana, etc.)
- Improve installation scripts with better error handling
- Create new project templates (microservices, serverless)
- Add more configuration examples and best practices
- Enhance security scanning capabilities
- Improve JSON reporting for automation
- Add container security scanning
- Implement compliance checks
π§ͺ Testing & Validation
- π Security Testing: Validate security features and scans
- π Health Monitoring: Test diagnostics and reporting
- π Rollback Testing: Verify backup and recovery functionality
- π Cross-Platform: Test on Linux, macOS, and Windows
- π Documentation: Ensure all features are well-documented
π Enhanced Support
π Bug Reports & Issues
- π Security Issues: Security Advisory
- π General Bugs: GitHub Issues
- π Feature Requests: GitHub Discussions
- π§ Email Support: harshhaa@gmail.com
π Support Information
When reporting issues, please include:
- π System Reports: Attach
~/.devops-toolkit/system-report.txt - π Logs: Include relevant log files (
~/.devops-toolkit-*.log) - π Commands: Show the exact commands used
- π Environment: OS version, tool versions, system specs
- π‘οΈ Security: Any security concerns or findings
π Self-Service Resources
- π Documentation: Comprehensive guides and examples
- π§ Troubleshooting: Built-in diagnostics and health checks
- π Recovery: Automatic backup and restore functionality
- π Monitoring: Real-time system and tool health status
π License
This project is licensed under the MIT License - see the LICENSE file for details.
π Acknowledgments
- Inspired by the DevOps community
- Built with β€οΈ for beginners
- Special thanks to all contributors
π Ready to Start Your Secure DevOps Journey? (v2.0.0)
β Key Benefits of v2.0.0
- π Enterprise Security: TLS verification, credential scanning, permission validation
- π Advanced Reliability: Automatic backup, rollback, error recovery
- π Enhanced Monitoring: Health checks, diagnostics, JSON reporting
- π‘οΈ Beginner-Friendly: Comprehensive validation and guidance
- π Production Ready: Enterprise-grade features for learning and production
π― Installation Options
π Quick Commands
# Secure installation with verification
curl -fsSL https://raw.githubusercontent.com/NotHarshhaa/devops-environment-toolkit-beginners/master/install.sh | bash && \
./verify.sh --security --health
# Windows PowerShell
iwr -useb https://raw.githubusercontent.com/NotHarshhaa/devops-environment-toolkit-beginners/master/install.ps1 | iex; \
.\verify.ps1 -Security -Healthπ Perfect for beginners - Star β this repo if you found it helpful!
Built with β€οΈ and π for secure DevOps learning
