K3s

This file defines the chart's identity, version, and metadata used by Helm.

It serves as the "package definition" for the Helm chart, similar to package.json (npm) or Chart.lock (Helm dependencies).

Role: Chart.yaml tells Helm what this chart is, what version it is, what application it deploys, and provides searchable metadata for chart repositories.

Helm uses this file to track chart versions, manage dependencies, and display information when users search for or install charts.

In a K3s (lightweight Kubernetes) deployment, the values.yaml file serves as the central configuration file for Helm charts. It defines default parameters and settings that customize how an application or service is deployed to the cluster - things like replica counts, image versions, resource limits, service types, ingress rules, environment variables, and persistent storage configurations.

When you run helm install or helm upgrade, Helm merges the values from this file with the chart's templates to generate the final Kubernetes manifests. You can override specific values at deploy time using --set flags or by supplying a custom values file with -f, making it a flexible mechanism for managing environment-specific configurations (e.g., dev vs. production) without modifying the underlying chart templates.

Documentation Files:

README.md - The main entry point documentation providing project overview, quick start instructions, prerequisites, and general usage information for the K3s deployment workshop.

DEPLOYMENT.md - Detailed deployment guide covering the complete K3s deployment workflow, including pre-requisites, step-by-step instructions, and post-deployment verification procedures.

K3s-INSTALLATION.md - K3s setup and installation instructions covering system preparation, K3s installation, networking configuration, and storage class setup required before deploying Pentaho.

Orchestration & Deployment:

deploy.sh - Automated deployment script that orchestrates the complete K3s deployment workflow including namespace creation, secret generation, manifest application, and service readiness checks.

destroy.sh - Cleanup script that safely removes all K3s resources including deployments, services, persistent volume claims, and namespaces, useful for redeployment or teardown scenarios.

Makefile - Contains convenience command targets for common K3s operations like deploying, destroying, checking status, and viewing logs. Users can run make help to see all available commands.

The docker-build/ directory contains all components needed to build the Pentaho Server container image that will be deployed to K3s:

Documentation Files:

README.md - Complete build documentation covering the Docker image build process, multi-stage build architecture, configuration options, troubleshooting, and best practices for building Pentaho Server images for K3s deployment.

QUICK-START.md - Quick build guide providing step-by-step instructions for users who want to quickly build and test the Pentaho image without reading the complete documentation. Includes common build commands and typical workflows.

ENV-CONFIGURATION.md - Comprehensive configuration reference guide for the .env.example file, detailing all available environment variables, their purposes, default values, and how they affect the Docker build process and resulting image.

Build & Configuration Files:

build.sh - Automated build wrapper script that validates prerequisites, checks for required files (Pentaho ZIP in stagedArtifacts/), detects plugins automatically (PAZ, PIR, PDD), confirms the build with the user, executes docker build, shows image info after build, and optionally pushes to a registry with the -p flag.

.env.example - Configuration template file containing all available environment variables for the Docker build process. Users copy this to .env and customize values for their specific deployment needs including Pentaho version, image tags, and build options.

Dockerfile - Multi-stage build definition using debian:trixie-slim as the base image with OpenJDK 21 JRE. Creates optimized images by separating the build environment from the runtime environment, reducing final image size while maintaining all necessary Pentaho components. The multi-stage approach minimizes security vulnerabilities and improves build efficiency.

test-compose.yml - Local Docker Compose testing environment that allows you to test the built Docker image locally before deploying to K3s. This is useful for validating configuration changes, testing custom plugins, or debugging startup issues without the overhead of a full K3s deployment.

Container Startup Scripts:

entrypoint/ - Directory containing container initialization and startup scripts:

Configuration Overlays:

softwareOverride/ - Configuration overlays directory that gets baked into the Docker image during the build process. Files are organized in numbered directories and processed in alphabetical order to ensure proper application sequence:

Staged Artifacts:

stagedArtifacts/ - Staging directory where users place the Pentaho Server installation package (pentaho-server-ee-11.0.0.0-237.zip) before building the Docker image. Contains a README.md with instructions on where to obtain the Pentaho package and how to stage it properly.

The db_init_postgres/ directory contains PostgreSQL initialization scripts that create all required Pentaho repository databases. These scripts are mounted into the PostgreSQL container and execute automatically on first startup:

1_create_jcr_postgresql.sql - Creates the Jackrabbit Content Repository (JCR) database. The JCR stores all Pentaho content including reports, dashboards, data sources, analysis schemas, transformations, jobs, and user files. This is the primary content management system for the Pentaho repository.

2_create_quartz_postgresql.sql - Sets up the Quartz Scheduler database. Quartz manages all scheduled jobs, triggers, and calendars within Pentaho Server, including report generation schedules, ETL job executions, and other automated processes. Contains critical tables like QRTZ6_JOB_DETAILS, QRTZ6_TRIGGERS, and execution history.

3_create_repository_postgresql.sql - Creates the Hibernate Repository database. This stores user authentication data, authorization information, roles, permissions, and other security-related information managed by Pentaho's security subsystem.

4_pentaho_logging_postgresql.sql - Establishes the pentaho_dilogs schema within the Hibernate database for audit and Data Integration (DI) logging. Captures detailed ETL execution information including job logs, transformation logs, step performance metrics, and error records. Essential for debugging data integration workflows and monitoring pipeline health.

5_pentaho_mart_postgresql.sql - Creates the pentaho_operations_mart schema within the Hibernate database. This dimensional data mart stores operational analytics about Pentaho Server usage, including dimension tables (DIM_DATE, DIM_TIME, DIM_EXECUTOR) and fact tables (FACT_EXECUTION, FACT_STEP_EXECUTION) for analyzing platform utilization, performance trends, and user activity patterns.

The manifests/ directory contains all Kubernetes resource definitions organized by functional area. These YAML files define the declarative state of your K3s deployment:

namespace.yaml - Creates the dedicated pentaho namespace to isolate all Pentaho-related resources from other K3s workloads, providing logical separation and resource organization.

configmaps/ - ConfigMap resources for non-sensitive configuration data:

pentaho/ - Pentaho Server Kubernetes resources:

postgres/ - PostgreSQL database Kubernetes resources:

secrets/ - Sensitive credential storage:

storage/ - Persistent storage definitions:

ingress/ - External access configuration:

The scripts/ directory contains operational and maintenance utilities for managing the K3s Pentaho deployment:

Database Management:

backup-postgres.sh - Automated PostgreSQL backup utility that creates compressed dumps of all Pentaho databases (jackrabbit, quartz, hibernate) using kubectl exec to run pg_dump inside the PostgreSQL pod. Backups are timestamped and compressed with gzip for efficient storage.

restore-postgres.sh - Database restoration utility to recover Pentaho databases from backup files. Useful for disaster recovery, environment cloning, or migrating data between K3s clusters. Handles decompression and restoration via kubectl exec and psql.

Monitoring & Validation:

health-check.sh - Health check script that verifies both PostgreSQL and Pentaho Server are running and responding correctly. Checks pod status, readiness probes, and performs basic connectivity tests.

monitor-resources.sh - Resource monitoring utility that tracks CPU, memory, and storage usage across all Pentaho pods using kubectl top and resource metrics, helping identify resource constraints or optimization opportunities.

monitor-postgres.sh - PostgreSQL-specific monitoring script that checks database connection counts, active queries, table sizes, and database health metrics via SQL queries executed in the PostgreSQL pod.

validate-deployment.sh - Comprehensive deployment validation script that confirms all K3s resources are properly created, pods are running, services are accessible, persistent volumes are bound, and the entire deployment is operational.

verify-k3s.sh - K3s infrastructure verification script that checks K3s installation, node status, storage classes, Traefik ingress controller, and core K3s components before attempting Pentaho deployment.