KubeReport Helm Chart

This repository contains the Helm chart for deploying KubeReport to a Kubernetes cluster. KubeReport simplifies the management of Kubernetes clusters by generating comprehensive reports that can be scheduled, sent via email, and stored in the cloud for easy access and archival.

Features

• Scheduled Reporting: Automatically generate and send reports at specified intervals.
• Customizable SMTP Settings: Configure email settings to send reports directly to recipients.
• Persistent Storage: Optionally store generated reports in cloud storage.
• Lightweight Deployment: Easily deploy KubeReport using Helm.

Installation

To install the chart, use the following command:

helm repo add kubereport https://kubesuiteorg.github.io/kubereport-helm-chart
helm repo update
helm install kubereport kubereport/kubereport

Verify the Installation

kubectl get pods -n kubereport

Configuration Parameters

Report Configuration

Parameter	Description	Default Value
report.type	Type of report to generate (e.g., detailed, general, release)	detailed
report.schedulable.enabled	Enable or disable scheduled reporting	true
report.schedulable.schedule	Cron schedule for generating reports (in cron format)	* * * * *
report.releaseversion	Specify the release version for release report(e.g., v1.0.0).	""
report.teamlabel	Specify the team metadata label given in the Deployment definition.	""

SMTP Configuration

Parameter	Description	Default Value
smtp.enabled	Enable or disable SMTP configuration	false
smtp.server	SMTP server address	smtp.gmail.com
smtp.port	Port number for SMTP	587
smtp.useTLS	Enable or disable TLS for SMTP	true
smtp.recipient	Recipient email address for sending reports	example@example.com
smtp.sender	Sender email address	example@gmail.com
smtp.password	SMTP server password (should be stored in a secret in production)	sdaridfdrnyzrtlt
smtp.subject	Subject line for the report email	Kubernetes Cluster Report
smtp.body	Body of the report email	(default body content)

Persistent Volume Configuration

Parameter	Description	Default Value
persistence.enabled	Enable or disable persistent volume storage	false
persistence.storageClass	Storage class for the persistent volume	"" (default storage class)
persistence.capacity	Total storage capacity for the persistent volume	100Mi
persistence.request	Requested storage capacity for the persistent volume	100Mi
persistence.accessModes	Access modes for the persistent volume (e.g., ReadWriteOnce)	ReadWriteOnce
persistence.pvpolicy	Policy for persistent volume (e.g., Retain, Delete)	Retain
persistence.secretName	Name of the secret containing sensitive data	azure-secret
persistence.secretValues	Values stored in the secret, such as Azure storage account details	(obfuscated values)
persistence.provider	Cloud provider configuration for the persistent volume

Demo

You can view the demo in the test.

Your Support Matters

KubeReport is a community-driven open-source project, maintained with dedication and effort. We are committed to keeping it free for everyone!

If KubeReport enhances your Kubernetes experience, please consider supporting us! Your sponsorship will help us continue development and deliver valuable updates. Every contribution counts, and we greatly appreciate your support!

Contribution Guidelines

• File an Issue or Suggestions
• Comment Your Code
• Attach Tested Output

Community & Support

You can connect with us on LinkedIn to stay updated and engage with the community.