Skip to content

k8-deployment-guide.md

Latest commit

 

History

History
166 lines (106 loc) · 4.64 KB

k8-deployment-guide.md

File metadata and controls

166 lines (106 loc) · 4.64 KB

🚀 Kubernetes Deployment for FastAPI E-commerce Microservices

This guide helps you deploy a microservices-based FastAPI project on Kubernetes using Minikube with locally built Docker images.

🛠️ Prerequisites

  • Docker installed
  • Minikube installed
  • Kubernetes CLI (kubectl) installed
  • Docker Compose installed (optional, if using compose to build images)

Note: Ensure your kubectl and minikube versions are compatible for best results.

⚙️ Step-by-Step Deployment

📦 1. Build Docker Images Locally

Build your service images from their respective Dockerfiles:

docker build -t users-service:latest -f ./services/users/Dockerfile .
docker build -t products-service:latest -f ./services/products/Dockerfile .

Note: If image build fails, try executing the command in the respective service directory

# In services/users
docker build -t users-service:latest -f ./Dockerfile .

# In services/products
docker build -t products-service:latest -f ./Dockerfile .

🐳 2. Load Docker Images into Minikube

Since Minikube uses its own Docker daemon, you need to load these images into Minikube for Kubernetes to access them.

minikube image load users-service
minikube image load products-service

Important: When using local images in Kubernetes, set imagePullPolicy: Never or IfNotPresent in your deployment YAMLs to avoid Kubernetes trying to pull from a remote registry.

🔐 3. Create Kubernetes Secrets (if applicable)

If your services require environment variables or secrets, create them as Kubernetes secrets before applying your manifests:

kubectl create secret generic users-secret --from-file=./services/users/.env
kubectl create secret generic products-secret --from-file=./services/products/.env

Replace paths and secret names as per your setup.

🚀 4. Apply Kubernetes Manifests

Apply your deployment and service YAMLs:

kubectl apply -f k8s/base

🌐 5. Access the Application

To access your services, you have multiple options:

  • Expose nginx LoadBalancer service:

    Minikube creates a tunnel for LoadBalancer services, which may show <pending> for EXTERNAL-IP.

    Use:

    minikube service nginx-service

    This command opens the nginx service URL in your default browser.

  • Port-forward individual services (ClusterIP):

    If your users-service and products-service are ClusterIP, forward their ports locally:

    kubectl port-forward service/users-service 8000:80
kubectl port-forward service/products-service 8001:80

    Then access these URLs in your browser:

🔍 6. Useful Commands and Troubleshooting

  • Check pods status:

    kubectl get pods

  • Describe a pod for detailed info:

    kubectl describe pod <pod-name>

  • View logs of a pod:

    kubectl logs <pod-name>

  • Restart a deployment after rebuilding images:

    kubectl rollout restart deployment/products-deployment

  • Delete all applied Kubernetes resources:

    kubectl delete -f k8s/base

  • Check Minikube status and logs:

    minikube status
minikube logs

  • Troubleshoot common pod issues:

    • ImagePullBackOff or ErrImagePull: Check imagePullPolicy, ensure image is loaded into Minikube.
    • CrashLoopBackOff: Check pod logs for runtime errors.
    • Secret not found: Verify secrets are created before pods start.

📌 Notes

  • Kubernetes defaults to the default namespace; if you use a custom namespace, add -n <namespace> to your kubectl commands.
  • Your Dockerfiles don’t need to set environment variables if you use Kubernetes secrets or ConfigMaps to inject them.
  • When mounting ConfigMaps (e.g., for nginx config), remember to restart pods if you update ConfigMaps to apply changes.
  • Minikube’s LoadBalancer is different from cloud providers: it uses a tunnel, so EXTERNAL-IP will be <pending>. Use minikube service to access the service.

How to install kubectl

How to install minikube