K3s

Este arquivo define a identidade, a versão e os metadados do chart usados pelo Helm.

Ele serve como a "definição do pacote" do chart Helm, semelhante ao package.json (npm) ou ao Chart.lock (dependências do Helm).

Função: o Chart.yaml informa ao Helm o que este chart é, qual versão ele possui, qual aplicação ele implanta e fornece metadados pesquisáveis para os repositórios de charts.

O Helm usa este arquivo para rastrear versões do chart, gerenciar dependências e exibir informações quando os usuários pesquisam ou instalam charts.

Em uma implantação K3s (Kubernetes leve), o values.yaml arquivo serve como o arquivo central de configuração para charts Helm. Ele define parâmetros e configurações padrão que personalizam como um aplicativo ou serviço é implantado no cluster - coisas como contagem de réplicas, versões de imagem, limites de recursos, tipos de serviço, regras de Ingress, variáveis de ambiente e configurações de armazenamento persistente.

Quando você executa helm install ou helm upgrade, o Helm mescla os valores deste arquivo com os modelos do chart para gerar os manifests finais do Kubernetes. Você pode substituir valores específicos no momento da implantação usando --set flags ou fornecendo um arquivo de valores personalizado com -f, tornando-o um mecanismo flexível para gerenciar configurações específicas de ambiente (por exemplo, dev vs. produção) sem modificar os modelos subjacentes do chart.

Arquivos de Documentação:

README.md - A documentação principal de entrada, fornecendo visão geral do projeto, instruções de início rápido, pré-requisitos e informações gerais de uso para o workshop de implantação do K3s.

DEPLOYMENT.md - Guia detalhado de implantação cobrindo o fluxo completo de implantação no K3s, incluindo pré-requisitos, instruções passo a passo e procedimentos de verificação pós-implantação.

K3s-INSTALLATION.md - Instruções de configuração e instalação do K3s cobrindo preparação do sistema, instalação do K3s, configuração de rede e configuração da classe de armazenamento necessária antes de implantar o Pentaho.

Orquestração e Implantação:

deploy.sh - Script automatizado de implantação que orquestra o fluxo completo de implantação no K3s, incluindo criação de namespace, geração de secrets, aplicação de manifestos e verificações de prontidão dos serviços.

destroy.sh - Script de limpeza que remove com segurança todos os recursos do K3s, incluindo implantações, serviços, PersistentVolumeClaims e namespaces, útil para cenários de nova implantação ou desmontagem.

Makefile - Contém alvos de comandos de conveniência para operações comuns do K3s, como implantar, destruir, verificar status e visualizar logs. Os usuários podem executar make help para ver todos os comandos disponíveis.

A docker-build/ diretório contém todos os componentes necessários para construir a imagem do contêiner do Pentaho Server que será implantada no K3s:

Arquivos de Documentação:

README.md - Documentação completa do build cobrindo o processo de criação da imagem Docker, a arquitetura de build em múltiplos estágios, opções de configuração, solução de problemas e melhores práticas para criar imagens do Pentaho Server para implantação no K3s.

QUICK-START.md - Guia rápido de build fornecendo instruções passo a passo para usuários que desejam construir e testar rapidamente a imagem do Pentaho sem ler a documentação completa. Inclui comandos comuns de build e fluxos de trabalho típicos.

ENV-CONFIGURATION.md - Guia de referência de configuração abrangente para o .env.example arquivo, detalhando todas as variáveis de ambiente disponíveis, seus propósitos, valores padrão e como elas afetam o processo de build do Docker e a imagem resultante.

Arquivos de build e configuração:

build.sh - Script wrapper de build automatizado que valida pré-requisitos, verifica arquivos necessários (ZIP do Pentaho em stagedArtifacts/), detecta plugins automaticamente (PAZ, PIR, PDD), confirma o build com o usuário, executa docker build, mostra informações da imagem após o build e opcionalmente envia para um registry com a -p flag.

.env.example - Arquivo modelo de configuração contendo todas as variáveis de ambiente disponíveis para o processo de build do Docker. Os usuários copiam isto para .env e personalizam os valores de acordo com suas necessidades específicas de implantação, incluindo versão do Pentaho, tags da imagem e opções de build.

Dockerfile - Definição de build em múltiplos estágios usando debian:trixie-slim como imagem base com OpenJDK 21 JRE. Cria imagens otimizadas separando o ambiente de build do ambiente de execução, reduzindo o tamanho final da imagem enquanto mantém todos os componentes necessários do Pentaho. A abordagem em múltiplos estágios minimiza vulnerabilidades de segurança e melhora a eficiência do build.

test-compose.yml - Ambiente local de teste com Docker Compose que permite testar a imagem Docker construída localmente antes de implantá-la no K3s. Isso é útil para validar alterações de configuração, testar plugins personalizados ou depurar problemas de inicialização sem a sobrecarga de uma implantação completa no K3s.

Scripts de inicialização do contêiner:

entrypoint/ - Diretório contendo scripts de inicialização e startup do contêiner:

Sobreposições de configuração:

softwareOverride/ - Diretório de sobreposições de configuração que é incorporado na imagem Docker durante o processo de build. Os arquivos são organizados em diretórios numerados e processados em ordem alfabética para garantir a sequência correta de aplicação:

Artefatos em estágio:

stagedArtifacts/ - Diretório de preparação onde os usuários colocam o pacote de instalação do Pentaho Server (pentaho-server-ee-11.0.0.0-237.zip) antes de construir a imagem Docker. Contém um README.md com instruções sobre onde obter o pacote do Pentaho e como prepará-lo corretamente.

A db_init_postgres/ diretório contém scripts de inicialização do PostgreSQL que criam todos os bancos de dados de repositório necessários do Pentaho. Esses scripts são montados no contêiner do PostgreSQL e executados automaticamente na primeira inicialização:

1_create_jcr_postgresql.sql - Cria o Jackrabbit Content Repository (JCR) banco de dados. O JCR armazena todo o conteúdo do Pentaho, incluindo relatórios, painéis, fontes de dados, esquemas de análise, transformações, jobs e arquivos de usuário. Este é o principal sistema de gerenciamento de conteúdo para o repositório do Pentaho.

2_create_quartz_postgresql.sql - Configura o Quartz Scheduler banco de dados. O Quartz gerencia todos os jobs agendados, triggers e calendários dentro do Pentaho Server, incluindo agendas de geração de relatórios, execuções de jobs de ETL e outros processos automatizados. Contém tabelas críticas como QRTZ6_JOB_DETAILS, QRTZ6_TRIGGERS, e histórico de execução.

3_create_repository_postgresql.sql - Cria o Hibernate Repository banco de dados. Armazena dados de autenticação de usuários, informações de autorização, funções, permissões e outras informações relacionadas à segurança gerenciadas pelo subsistema de segurança do Pentaho.

4_pentaho_logging_postgresql.sql - Estabelece o pentaho_dilogs schema dentro do banco de dados Hibernate para auditoria e logging de Integração de Dados (DI). Captura informações detalhadas de execução de ETL, incluindo logs de jobs, logs de transformações, métricas de desempenho de etapas e registros de erros. Essencial para depurar fluxos de trabalho de integração de dados e monitorar a saúde do pipeline.

5_pentaho_mart_postgresql.sql - Cria o pentaho_operations_mart schema dentro do banco de dados Hibernate. Este data mart dimensional armazena análises operacionais sobre o uso do Pentaho Server, incluindo tabelas de dimensão (DIM_DATE, DIM_TIME, DIM_EXECUTOR) e tabelas fato (FACT_EXECUTION, FACT_STEP_EXECUTION) para analisar a utilização da plataforma, tendências de desempenho e padrões de atividade do usuário.

A manifests/ diretório contém todas as definições de recursos do Kubernetes organizadas por área funcional. Esses arquivos YAML definem o estado declarativo da sua implantação no K3s:

namespace.yaml - Cria o pentaho namespace dedicado para isolar todos os recursos relacionados ao Pentaho de outras cargas de trabalho do K3s, proporcionando separação lógica e organização de recursos.

configmaps/ - Recursos ConfigMap para dados de configuração não sensíveis:

pentaho/ - Recursos Kubernetes do Pentaho Server:

postgres/ - Recursos Kubernetes do banco de dados PostgreSQL:

secrets/ - Armazenamento de credenciais sensíveis:

storage/ - Definições de armazenamento persistente:

ingress/ - Configuração de acesso externo:

A scripts/ diretório contém utilitários de operação e manutenção para gerenciar a implantação do Pentaho no K3s:

Gerenciamento de Banco de Dados:

backup-postgres.sh - Utilitário automatizado de backup do PostgreSQL que cria dumps compactados de todos os bancos de dados do Pentaho (jackrabbit, quartz, hibernate) usando kubectl exec para executar pg_dump dentro do pod do PostgreSQL. Os backups recebem timestamp e são compactados com gzip para armazenamento eficiente.

restore-postgres.sh - Utilitário de restauração de banco de dados para recuperar os bancos de dados do Pentaho a partir de arquivos de backup. Útil para recuperação de desastres, clonagem de ambiente ou migração de dados entre clusters K3s. Lida com descompactação e restauração via kubectl exec e psql.

Monitoramento e validação:

health-check.sh - Script de verificação de integridade que confirma que tanto o PostgreSQL quanto o Pentaho Server estão em execução e respondendo corretamente. Verifica o status do pod, probes de readiness e realiza testes básicos de conectividade.

monitor-resources.sh - Utilitário de monitoramento de recursos que acompanha o uso de CPU, memória e armazenamento em todos os pods do Pentaho usando kubectl top e métricas de recursos, ajudando a identificar restrições de recursos ou oportunidades de otimização.

monitor-postgres.sh - Script de monitoramento específico do PostgreSQL que verifica contagem de conexões com o banco, consultas ativas, tamanhos de tabelas e métricas de saúde do banco por meio de consultas SQL executadas no pod do PostgreSQL.

validate-deployment.sh - Script abrangente de validação da implantação que confirma se todos os recursos do K3s foram criados corretamente, se os pods estão em execução, se os serviços estão acessíveis, se os volumes persistentes estão vinculados e se toda a implantação está operacional.

verify-k3s.sh - Script de verificação da infraestrutura K3s que verifica a instalação do K3s, o status dos nós, as classes de armazenamento, o controlador de ingress Traefik e os componentes principais do K3s antes de tentar a implantação do Pentaho.