k8s-deploy-helper 🚀

k8s-deploy-helper is a simple and beginner-friendly CLI tool that helps you build Docker images and deploy applications to Kubernetes using a guided and automated workflow. It is designed to reduce the learning curve of Kubernetes while still supporting real-world DevOps practices.

PROBLEM THIS TOOL SOLVES 🧩

Deploying an application to Kubernetes usually involves many manual steps:

• Creating and maintaining a Dockerfile • Writing Kubernetes YAML files (Deployment, Service, etc.) • Understanding kubectl commands • Managing Docker registry authentication • Debugging unclear or low-level runtime errors

WHAT THIS TOOL DOES ⚙️

k8s-deploy-helper automates the full deployment process by:

• Automatically generating missing Docker and Kubernetes configuration files • Building Docker images for your application • Supporting local deployments without pushing images to Docker Hub • Generating Kubernetes Deployment and Service YAML files automatically • Applying Kubernetes resources using kubectl • Detecting missing setup early and displaying clear, actionable error messages

REQUIREMENTS (BEGINNER FRIENDLY) 🛠️

Minimum setup for local usage:

• Docker Desktop installed • Kubernetes enabled inside Docker Desktop

Docker Desktop already includes:

• Docker • kubectl • A local Kubernetes cluster

To verify Kubernetes is running:

*** kubectl get nodes ***

INSTALLATION 📦

Install the package globally using npm:

*** npm install -g k8s-deploy-helper ***

Verify the installation:

*** k8s-deploy --version ***

HOW TO USE (STEP-BY-STEP) ▶️

STEP 1: INITIALIZE THE PROJECT ⭐

If your project does not already have a Dockerfile or k8s.config.json, run: *** k8s-deploy init ***

This command will:

• Create a basic Dockerfile • Create a k8s.config.json configuration file • Prepare your project for Kubernetes deployment

STEP 2: DEPLOY LOCALLY (RECOMMENDED FOR BEGINNERS) 🧪

For first-time users, deploy without using Docker Hub or any container registry: *** k8s-deploy deploy --local ***

What happens during local deployment:

• The Docker image is built locally • Image push to a registry is skipped • Kubernetes uses the local image • The application is deployed to the local Kubernetes cluster

STEP 3: STANDARD DEPLOYMENT 🌐

Once you are comfortable and logged into a container registry, run: *** k8s-deploy deploy ***

This will:

• Build the Docker image • Push the image to the configured registry • Deploy the application to Kubernetes

FILES CREATED BY THE TOOL 📁

After running the commands, the following files will exist in your project:

Dockerfile k8s.config.json deployment.yaml service.yaml

These files can be:

• Reviewed • Modified • Committed to Git • Used independently if needed

WHAT HAPPENS INTERNALLY 🔍

When you run the deploy command, the tool performs the following steps:

• Checks for required files • Verifies Docker and Kubernetes availability • Builds the Docker image • Generates Kubernetes YAML files • Applies resources using kubectl

WHY THIS TOOL IS VALUABLE ⭐

Without this tool:

• You manually write Kubernetes YAML • You manage Docker commands yourself • You deal with registry authentication issues • Kubernetes feels complex and fragile

With this tool:

• One-command deployment • Beginner-safe defaults • Hands-on Kubernetes experience • Production-ready deployment workflow

AUTHOR 👨‍💻

Lokesh Shimpi