Simplified Deployment: A Deep Dive into Containerization and Helm

jokerwrld999 — Sun, 08 Oct 2023 18:32:50 +0000

Introduction

In this post, we embark on a journey through the fundamental concepts of containerization and the practical use of Helm charts. Containerization provides a streamlined approach to packaging, distributing, and deploying software, while Helm simplifies the management of complex applications on Kubernetes.

Let's navigate through the essence of containerization and Helm charts, understanding how they contribute to modern software development and deployment. Join us as we unravel the mechanics of these essential tools.

Dockerizing the Application

Project Link: https://github.com/jokerwrld999/devops_assignments.git

Package the FastAPI application into a Docker container for portability and easier deployment.

This Dockerfile uses a multi-stage build process to optimize the Docker image size for the 'hello-world' FastAPI application.

FROM python:slim-bullseye AS builder

WORKDIR /app
COPY poetry.lock pyproject.toml main.py .env gunicorn.sh ./

RUN python -m pip install --no-cache-dir poetry==1.5.1 \
    && poetry config virtualenvs.in-project true \
    && poetry install --no-interaction --no-ansi || true \
    && poetry shell || true

FROM alpine:latest AS base

RUN  apk update \
    && apk upgrade \
    && apk add ca-certificates \
    && update-ca-certificates \
    && echo http://dl-cdn.alpinelinux.org/alpine/v3.6/main >> /etc/apk/repositories \
    && echo http://dl-cdn.alpinelinux.org/alpine/v3.6/community >> /etc/apk/repositories \
    && apk add --update coreutils && rm -rf /var/cache/apk/*   \
    && apk add --update python3 py3-pip \
    && apk add --no-cache nss \
    && rm -rf /var/cache/apk/*

FROM base

WORKDIR /web

ENV ENVIRONMENT=default
ENV ENVIRONMENT_FROM_SECRET=secret_default

RUN python -m pip install --no-cache-dir fastapi gunicorn uvicorn

COPY --from=builder /app ./
COPY app ./app

CMD ["./gunicorn.sh"]

Build Process:

Builder Stage:
- Utilizes the python:slim-bullseye image.
- Sets the working directory to /app.
- Copies essential files like poetry configuration, application files, and the gunicorn script.
- Installs dependencies via Poetry and creates a virtual environment.
Base Stage:
- Based on the alpine:latest image, a lightweight Linux distribution.
- Installs necessary packages including Python and pip.
- Sets the working directory to /web.
- Defines environment variables for the application.
Dependency Installation:
- Installs required Python packages using pip.
Application Setup:
- Copies files from the builder stage to the final image, including the FastAPI application code.
CMD Directive:
- Specifies the command to start the application using gunicorn.sh.

The resulting Docker image is optimized, effectively reducing the image size while maintaining application functionality.

Helm Charts

Helm is a widely used package manager for Kubernetes, designed to simplify and automate the deployment, scaling, and management of applications. It provides an efficient way to define, install, and upgrade even complex Kubernetes applications.

Key Features of Helm:

Package Management:
- Helm packages applications as "charts," making it easy to share and install applications on Kubernetes clusters.
Templating and Parameterization:
- Helm allows users to use templates to define Kubernetes manifests, enabling parameterization and customization of these manifests during installation.
Reusability:
- Helm charts promote the reuse of predefined configurations and deployment strategies across multiple applications, streamlining the development process.
Dependency Management:
- Helm handles dependencies between Kubernetes resources, ensuring the correct order of installation and removal for complex applications.
Rollbacks and Upgrades:
- Helm supports rollbacks to previous versions and facilitates seamless upgrades of applications to newer versions, improving the overall deployment process.
Community Contributions:
- Helm has a thriving community contributing to a vast collection of prebuilt charts, covering a wide array of applications and services.

With these features, Helm significantly simplifies Kubernetes application management, making it a vital tool in the Kubernetes ecosystem.

Helm Chart Folder Structure

The Helm chart folder structure looks like this:

[4.0K]  charts/
├── [4.0K]  app/
│   ├── [4.0K]  templates/
│   │   ├── [ 647]  certmanager.yaml
│   │   ├── [ 180]  configmap.yaml
│   │   ├── [1.4K]  deployment.yaml
│   │   ├── [ 296]  _helpers.tpl
│   │   ├── [ 406]  hpa.yaml
│   │   ├── [ 856]  ingress.yaml
│   │   ├── [ 680]  NOTES.txt
│   │   ├── [ 216]  secret.yaml
│   │   └── [ 332]  service.yaml
│   ├── [4.0K]  values/
│   │   ├── [4.0K]  dev/
│   │   │   ├── [1.6K]  secrets.yaml
│   │   │   └── [  68]  values.yaml
│   │   ├── [4.0K]  prod/
│   │   │   ├── [1.6K]  secrets.yaml
│   │   │   └── [ 167]  values.yaml
│   │   └── [4.0K]  stage/
│   │       ├── [1.6K]  secrets.yaml
│   │       └── [ 179]  values.yaml
│   ├── [ 130]  Chart.yaml
│   └── [ 306]  values.yaml
├── [4.0K]  config/
│   ├── [ 334]  cleanup.sh*
│   └── [ 353]  pre-install.sh*
└── [ 491]  helmfile.yaml

`certmanager.yaml`

This file defines the configuration for Cert-Manager, a Kubernetes add-on for managing TLS certificates.

`configmap.yaml`

This file defines a Kubernetes ConfigMap, which holds configuration data for the application.

`deployment.yaml`

This file defines the Kubernetes Deployment resource, specifying how the application should be deployed and managed.

`_helpers.tpl`

This is a Helm template helper file, containing reusable template snippets.

`hpa.yaml`

This file defines the Horizontal Pod Autoscaler (HPA) for automatically scaling the application based on resource usage.

`ingress.yaml`

This file defines the Kubernetes Ingress resource, configuring how external access to the application is managed.

`NOTES.txt`

This file contains optional post-installation notes and information for users.

`secret.yaml`

This file defines a Kubernetes Secret, holding sensitive configuration data.

`service.yaml`

This file defines the Kubernetes Service resource, managing access to the application.

`values.yaml`

This file contains default configuration values for the Helm chart.

`secrets.yaml` (in `values/dev/`, `values/prod/`, `values/stage/`)

These files define environment-specific secrets that the application uses.

`Chart.yaml`

This file contains metadata and information about the Helm chart.

`cleanup.sh` (in `config/`)

A shell script for cleanup operations before installation.

`pre-install.sh` (in `config/`)

A shell script for pre-installation operations.

`helmfile.yaml`

This file is used for Helmfile, which is a declarative configuration for deploying Helm charts. It defines the Helm releases and their configurations.

Setup Deployment Environment

Minikube Installation

Minikube is a tool that allows you to run a single-node Kubernetes cluster locally on your computer. It's designed to enable developers to set up and experiment with Kubernetes applications in a local environment before deploying to a larger Kubernetes cluster.

Installation: https://minikube.sigs.k8s.io/docs/start/

minikube config set driver docker
minikube start // stop
minikube status

Kubectl Installation

Installation: https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/

curl -LO "https://dl.k8s.io/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl.sha256"
sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl

cat ~/.kube/config  // kubectl config view
alias k='kubectl'

Helm Installation

Installation: https://helm.sh/docs/intro/install/

Cheat Sheet: https://helm.sh/docs/intro/cheatsheet/

curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash

Plugins Installation

helm plugin install https://github.com/databus23/helm-diff
helm plugin install https://github.com/aslafy-z/helm-git
helm plugin install https://github.com/jkroepke/helm-secrets

Secrets Encryption

helm secrets encrypt prod/secrets.yaml

Namespace Creation

kubectl create namespace dev
kubectl create namespace stage
kubectl create namespace prod

Github Registry Login

export CR_PAT=

kubectl create secret docker-registry ghcr-login-secret --docker-server=https://ghcr.io --docker-username=jokerwrld999 --docker-password=$CR_PAT --docker-email=example@gmail.com -n dev
kubectl create secret docker-registry ghcr-login-secret --docker-server=https://ghcr.io --docker-username=jokerwrld999 --docker-password=$CR_PAT --docker-email=example@gmail.com -n stage
kubectl create secret docker-registry ghcr-login-secret --docker-server=https://ghcr.io --docker-username=jokerwrld999 --docker-password=$CR_PAT --docker-email=example@gmail.com -n prod

Helmfile Deployment

Helmfile is a declarative configuration management tool for deploying Helm charts to Kubernetes clusters. It simplifies the process of managing complex Helm deployments by allowing you to define your desired state in a structured YAML file.

Installation: https://github.com/helmfile/helmfile/releases

Development Environment

helmfile --file helmfile.yaml -e dev apply --interactive
helmfile --file helmfile.yaml -e dev destroy

Staging Environment

helmfile --file helmfile.yaml -e stage apply --interactive
helmfile --file helmfile.yaml -e stage destroy

Production Environment

helmfile --file helmfile.yaml -e prod apply --interactive
helmfile --file helmfile.yaml -e prod destroy

Debug/Healthcheck

Service_IP/openapi.json
Service_IP/secret
Service_IP/healthcheck

Accessing the Application

curl -H "Host: dev.jokerwrld.com" http://$(minikube ip)/
curl -H "Host: stage.jokerwrld.com" -k https://$(minikube ip)/
curl -H "Host: prod.jokerwrld.com" -k https://$(minikube ip)/

Conclusion

We've taken a close look at making our applications work smoothly on Kubernetes. With Docker helping us pack our apps neatly, and Helm helping us manage and deploy them, we've simplified the process. Remember, mastering this art opens up exciting possibilities for seamless deployments and happy users. Keep practicing and enjoy the journey into the world of containers and Helm!

Forem: jokerwrld999