devopstoolbox 1.0.0b1

A Python-based CLI toolkit for automating daily DevOps operations.

DevOpsToolbox

A Python-based CLI toolkit for automating daily DevOps operations.

Features

• Kubernetes Management: Manage pods, services, jobs, and certificates from the command line
• File Validation: Validate YAML and JSON files for syntax errors with detailed error reporting
• Utilities: Generate passwords, encode/decode base64 strings
• Human-readable Output: Formatted tables with Rich for clear visualization
• Metrics Support: View CPU and memory usage for pods (requires Metrics Server)
• Certificate Management: List and monitor cert-manager certificates

Requirements

• Python 3.9+
• Access to a Kubernetes cluster (kubeconfig configured)
• Metrics Server (optional, for pod metrics)
• cert-manager (optional, for certificate management)

Installation

# Clone the repository
git clone https://github.com/georgesouzafarias/DevOpsToolbox.git
cd DevOpsToolbox

# Install in development mode
pip install -e .

Usage

General Commands

# Show version
devopstoolbox version

# Show help
devopstoolbox --help

Short Aliases

All Kubernetes commands support short aliases for common options, matching kubectl conventions:

Long Form	Short	Description
--namespace	-n	Specify the namespace
--all-namespaces	-A	List resources across all namespaces

Pods Management

# List all pods in default namespace
devopstoolbox k8s pods list

# List all pods in a specific namespace
devopstoolbox k8s pods list -n monitoring

# List all pods across all namespaces
devopstoolbox k8s pods list -A

# List unhealthy pods (not Running or Succeeded)
devopstoolbox k8s pods unhealthy -A

# Show pod metrics (CPU and memory usage)
devopstoolbox k8s pods metrics -n default

# Show pod metrics sorted by CPU usage
devopstoolbox k8s pods metrics -A --sort-by cpu

# Show top 10 pods by memory usage
devopstoolbox k8s pods metrics -A --sort-by memory --limit 10

# Find overprovisioned pods (usage below 50% of request)
devopstoolbox k8s pods overprovisioned -n default

# Find overprovisioned pods with custom threshold (30%)
devopstoolbox k8s pods overprovisioned -A --threshold 30

# Find overprovisioned pods sorted by CPU, limit to top 10
devopstoolbox k8s pods overprovisioned -A --sort-by cpu --limit 10

Services Management

# List services in default namespace
devopstoolbox k8s services list

# List services in a specific namespace
devopstoolbox k8s services list -n kube-system

# List all services across all namespaces
devopstoolbox k8s services list -A

Jobs Management

# List all jobs in default namespace
devopstoolbox k8s jobs list

# List all jobs in a specific namespace
devopstoolbox k8s jobs list -n batch

# List all jobs across all namespaces
devopstoolbox k8s jobs list -A

# List only failed jobs
devopstoolbox k8s jobs failed -A

Certificates Management

# List certificates in default namespace
devopstoolbox k8s certificates list

# List certificates in a specific namespace
devopstoolbox k8s certificates list -n cert-manager

# List certificates that are not ready
devopstoolbox k8s certificates not-ready -n default

Miscellaneous Utilities

Password Generation

# Generate a 16-character password (default)
devopstoolbox misc generate

# Generate a password with custom length
devopstoolbox misc generate -l 30
devopstoolbox misc generate --length 24

Base64 Encoding/Decoding

# Encode a string to base64
devopstoolbox misc base64 --encode "hello world"
devopstoolbox misc base64 -e "secret text"

# Encode a file to base64
devopstoolbox misc base64 --file /path/to/file.txt
devopstoolbox misc base64 -f ./config.yaml

# Decode a base64 string
devopstoolbox misc base64 --decode "aGVsbG8gd29ybGQ="
devopstoolbox misc base64 -d "c2VjcmV0IHRleHQ="

File Validation

# Validate a single YAML file
devopstoolbox misc validate yaml -f deployment.yaml

# Validate all YAML files in a directory (recursive)
devopstoolbox misc validate yaml -d ./manifests

# Validate a single JSON file
devopstoolbox misc validate json -f config.json

# Validate all JSON files in a directory (recursive)
devopstoolbox misc validate json -d ./configs

Command Reference

Command	Description
devopstoolbox version	Show tool version
Kubernetes - Pods
devopstoolbox k8s pods list	List pods with status and restart count
devopstoolbox k8s pods metrics	Show CPU and memory usage per container
devopstoolbox k8s pods unhealthy	List pods not in Running/Succeeded state
devopstoolbox k8s pods overprovisioned	Find pods with resources below threshold
Kubernetes - Services
devopstoolbox k8s services list	List services with type and traffic policy
Kubernetes - Jobs
devopstoolbox k8s jobs list	List jobs with status and age
devopstoolbox k8s jobs failed	List only failed jobs with error messages
Kubernetes - Certificates
devopstoolbox k8s certificates list	List cert-manager certificates
devopstoolbox k8s certificates not-ready	List certificates not in Ready state
Misc - Generate
devopstoolbox misc generate	Generate a secure random password
Misc - Base64
devopstoolbox misc base64 -e <string>	Encode a string to base64
devopstoolbox misc base64 -f <file>	Encode a file to base64
devopstoolbox misc base64 -d <string>	Decode a base64 string
Misc - Validate
devopstoolbox misc validate yaml	Validate YAML files for syntax errors
devopstoolbox misc validate json	Validate JSON files for syntax errors

Dependencies

• boto3
• kubernetes
• pyyaml
• typer
• rich

Contributing

Contributions are welcome! Please read our Contributing Guidelines before submitting a pull request.

Development

Setup

# Install with dev dependencies
pip install -e ".[dev]"

# Install the pre-push git hook
./scripts/install-hooks.sh

Running Tests

# Run all tests
pytest

# Run with verbose output
pytest -v

# Run with coverage report
pytest --cov=devopstoolbox --cov-report=html

# Run specific test file
pytest tests/test_pods.py

# Run specific test class
pytest tests/test_pods.py::TestPodsListCommand

# Run specific test
pytest tests/test_pods.py::TestPodsListCommand::test_list_pods_default_namespace

Code Quality

The project uses Ruff for linting and formatting, and pytest for testing.

# Check for linting issues
ruff check .

# Fix auto-fixable issues
ruff check --fix .

# Format code
ruff format .

All tests must pass before pushing code.

Git Hooks

A pre-push hook automatically runs tests before each push to ensure code quality:

# Install the hook (one-time setup)
./scripts/install-hooks.sh

# The hook will run automatically on git push
# If tests fail, the push will be rejected

To bypass the hook (not recommended):

git push --no-verify

License

See LICENSE file for details.

Author

George Farias ([e-mail])