k8s-deploy-helper 1.2.0 → 1.4.0

package/README.md

@@ -1,14 +1,14 @@
-k8s-deploy-helper 🚀
+### 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.
+# 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.
+# It is designed to reduce the learning curve of Kubernetes while still supporting real-world DevOps practices.
 
 -----
 
-PROBLEM THIS TOOL SOLVES 🧩
+### PROBLEM THIS TOOL SOLVES 🧩
 
-Deploying an application to Kubernetes usually involves many manual steps:
+## Deploying an application to Kubernetes usually involves many manual steps:
 
 • Creating and maintaining a Dockerfile
 • Writing Kubernetes YAML files (Deployment, Service, etc.)
@@ -16,15 +16,15 @@ Deploying an application to Kubernetes usually involves many manual steps:
 • Managing Docker registry authentication
 • Debugging unclear or low-level runtime errors
 
-For beginners and even intermediate developers, this process can be confusing, time-consuming, and error-prone.
+# For beginners and even intermediate developers, this process can be confusing, time-consuming, and error-prone.
 
-k8s-deploy-helper removes this complexity by automating these steps and guiding the user through a clear, predictable workflow.
+# k8s-deploy-helper removes this complexity by automating these steps and guiding the user through a clear, predictable workflow.
 
 -----
 
-WHAT THIS TOOL DOES ⚙️
+### WHAT THIS TOOL DOES ⚙️
 
-k8s-deploy-helper automates the full deployment process by:
+## k8s-deploy-helper automates the full deployment process by:
 
 • Automatically generating missing Docker and Kubernetes configuration files
 • Building Docker images for your application
@@ -38,85 +38,81 @@ The tool handles the deployment.
 
 -----
 
-REQUIREMENTS (BEGINNER FRIENDLY) 🛠️
-
-Minimum setup for local usage:
+### REQUIREMENTS (BEGINNER FRIENDLY) 🛠️
 
+# Minimum setup for local usage:
 • Docker Desktop installed
 • Kubernetes enabled inside Docker Desktop
 
-Docker Desktop already includes:
+# Docker Desktop already includes:
 • Docker
 • kubectl
 • A local Kubernetes cluster
 
-To verify Kubernetes is running:
-
-kubectl get nodes
+# To verify Kubernetes is running:
+  kubectl get nodes
 
 -----
 
-INSTALLATION 📦
+### INSTALLATION 📦
 
-Install the package globally using npm:
+# Install the package globally using npm:
   npm install -g k8s-deploy-helper
 
-Verify the installation:
+# Verify the installation:
   k8s-deploy --version
 
 -----
 
-HOW TO USE (STEP-BY-STEP) ▶️
+### HOW TO USE (STEP-BY-STEP) ▶️
 
-STEP 1: INITIALIZE THE PROJECT ⭐
+## STEP 1: INITIALIZE THE PROJECT ⭐
 
-If your project does not already have a Dockerfile or k8s.config.json, 
-run:
+# If your project does not already have a Dockerfile or k8s.config.json, run:
   k8s-deploy init
 
-This command will:
+# This command will:
 • Create a basic Dockerfile
 • Create a k8s.config.json configuration file
 • Prepare your project for Kubernetes deployment
 
-You can modify these files later to match your application needs.
+# You can modify these files later to match your application needs.
 
-STEP 2: DEPLOY LOCALLY (RECOMMENDED FOR BEGINNERS) 🧪
+## STEP 2: DEPLOY LOCALLY (RECOMMENDED FOR BEGINNERS) 🧪
 
-For first-time users, deploy without using Docker Hub or any container registry:
+## For first-time users, deploy without using Docker Hub or any container registry:
   k8s-deploy deploy --local
 
-What happens during local deployment:
+## 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
 
-No Docker Hub account or login is required.
+# No Docker Hub account or login is required.
 
-STEP 3: STANDARD DEPLOYMENT (OPTIONAL) 🌐
+## STEP 3: STANDARD DEPLOYMENT (OPTIONAL) 🌐
 
-Once you are comfortable and logged into a container registry, 
-run:
+# Once you are comfortable and logged into a container registry, run:
   k8s-deploy deploy
 
-This will:
+### This will:
 • Build the Docker image
 • Push the image to the configured registry
 • Deploy the application to Kubernetes
 
 -----
 
-FILES CREATED BY THE TOOL 📁
+### FILES CREATED BY THE TOOL 📁
 
-After running the commands, the following files will exist in your project:
+# After running the commands, the following files will exist in your project:
 
 Dockerfile
 k8s.config.json
 deployment.yaml
 service.yaml
 
-These files can be:
+# These files can be:
 • Reviewed
 • Modified
 • Committed to Git
@@ -124,9 +120,9 @@ These files can be:
 
 -----
 
-WHAT HAPPENS INTERNALLY 🔍
+### WHAT HAPPENS INTERNALLY 🔍
 
-When you run the deploy command, the tool performs the following steps:
+# When you run the deploy command, the tool performs the following steps:
 
 • Checks for required files
 • Verifies Docker and Kubernetes availability
@@ -134,19 +130,19 @@ When you run the deploy command, the tool performs the following steps:
 • Generates Kubernetes YAML files
 • Applies resources using kubectl
 
-Each step is logged clearly so you can understand what is happening.
+# Each step is logged clearly so you can understand what is happening.
 
 -----
 
-WHY THIS TOOL IS VALUABLE ⭐
+### WHY THIS TOOL IS VALUABLE ⭐
 
-Without this tool:
+## 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:
+## With this tool:
 • One-command deployment
 • Beginner-safe defaults
 • Hands-on Kubernetes experience
@@ -154,7 +150,5 @@ With this tool:
 
 -----
 
-AUTHOR 👨‍💻
-
+### AUTHOR 👨‍💻
 Lokesh Shimpi
-Built to simplify Kubernetes deployment and demonstrate real-world DevOps engineering.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "k8s-deploy-helper",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "description": "CLI tool to build, push and deploy applications to Kubernetes",
   "type": "module",
   "bin": {

package/src/init/generateFiles.js

@@ -1,33 +1,72 @@
 import fs from 'fs';
 
-export function generateDockerfile() {
-  if (fs.existsSync('Dockerfile')) return;
+export function generateDockerfiles() {
+  const hasServer = fs.existsSync('server');
+  const hasClient = fs.existsSync('client');
 
-  const dockerfile = `
+  // Backend Dockerfile
+  if (hasServer && !fs.existsSync('Dockerfile.backend')) {
+    const backendDockerfile = `
 FROM node:18-alpine
+
 WORKDIR /app
+
 COPY server/package*.json ./
 RUN npm install
+
 COPY server .
+
 EXPOSE 5000
 CMD ["npm", "start"]
 `.trim();
 
-  fs.writeFileSync('Dockerfile', dockerfile);
-  console.log('✅ Dockerfile created');
+    fs.writeFileSync('Dockerfile.backend', backendDockerfile);
+    console.log('✅ Backend Dockerfile created (Dockerfile.backend)');
+  } else if (hasServer) {
+    console.log('ℹ️ Backend Dockerfile already exists. Skipping.');
+  }
+
+  // Frontend Dockerfile
+  if (hasClient && !fs.existsSync('Dockerfile.frontend')) {
+    const frontendDockerfile = `
+FROM node:18-alpine AS build
+
+WORKDIR /app
+
+COPY client/package*.json ./
+RUN npm install
+
+COPY client .
+RUN npm run build
+
+FROM nginx:alpine
+COPY --from=build /app/build /usr/share/nginx/html
+
+EXPOSE 80
+CMD ["nginx", "-g", "daemon off;"]
+`.trim();
+
+    fs.writeFileSync('Dockerfile.frontend', frontendDockerfile);
+    console.log('✅ Frontend Dockerfile created (Dockerfile.frontend)');
+  } else if (hasClient) {
+    console.log('ℹ️ Frontend Dockerfile already exists. Skipping.');
+  }
 }
 
 export function generateK8sConfig() {
-  if (fs.existsSync('k8s.config.json')) return;
+  if (fs.existsSync('k8s.config.json')) {
+    console.log('ℹ️ k8s.config.json already exists. Skipping.');
+    return;
+  }
 
   const config = {
     appName: 'my-app',
     namespace: 'default',
     docker: {
-      image: 'your-docker-username/my-app',
+      image: 'your-docker-username/my-app-backend',
       tag: 'latest',
       context: '.',
-      dockerfile: 'Dockerfile'
+      dockerfile: 'Dockerfile.backend'
     },
     kubernetes: {
       replicas: 1,

package/src/init/initProject.js

@@ -1,11 +1,21 @@
-import { generateDockerfile, generateK8sConfig } from './generateFiles.js';
+import fs from 'fs';
+import { generateDockerfiles, generateK8sConfig } from './generateFiles.js';
 
 export function initProject() {
-  console.log('🔧 Initializing project for Kubernetes deployment...\n');
+  console.log('\n🔧 Initializing project for Kubernetes deployment...\n');
 
-  generateDockerfile();
+  const hasClient = fs.existsSync('client');
+  const hasServer = fs.existsSync('server');
+
+  if (!hasClient && !hasServer) {
+    console.error('❌ No client/ or server/ directory found.');
+    console.error('👉 Run this command from the project root.');
+    process.exit(1);
+  }
+
+  generateDockerfiles();
   generateK8sConfig();
 
-  console.log('\n🎉 Initialization complete');
-  console.log('👉 Update k8s.config.json with your Docker username');
+  console.log('\n✅ Initialization completed successfully.');
+  console.log('👉 Review generated files before running deployment.\n');
 }

package/src/preflight/checkEnvironment.js

@@ -0,0 +1,33 @@
+import { execa } from 'execa';
+
+export async function checkEnvironment() {
+  // 1. Check Docker availability
+  try {
+    await execa('docker', ['info'], { stdio: 'ignore' });
+  } catch {
+    throw new Error(
+      'Docker is not running.\n' +
+      '👉 Please start Docker Desktop and try again.'
+    );
+  }
+
+  // 2. Check kubectl availability
+  try {
+    await execa('kubectl', ['version', '--client'], { stdio: 'ignore' });
+  } catch {
+    throw new Error(
+      'kubectl is not available.\n' +
+      '👉 Enable Kubernetes in Docker Desktop or install kubectl.'
+    );
+  }
+
+  // 3. Check Kubernetes cluster connectivity
+  try {
+    await execa('kubectl', ['cluster-info'], { stdio: 'ignore' });
+  } catch {
+    throw new Error(
+      'Kubernetes cluster is not reachable.\n' +
+      '👉 Enable Kubernetes in Docker Desktop and wait until it is ready.'
+    );
+  }
+}