charts/bitnami/jasperreports

JasperReports

JasperReports The JasperReports server can be used as a stand-alone or embedded reporting and BI server that offers web-based reporting, analytic tools and visualization, and a dashboard feature for compiling multiple custom views

TL;DR

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/jasperreports

Introduction

This chart bootstraps a JasperReports deployment on a Kubernetes cluster using the Helm package manager.

It also packages the Bitnami MariaDB chart which bootstraps a MariaDB deployment required by the JasperReports application.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters. This chart has been tested to work with NGINX Ingress, cert-manager, fluentd and Prometheus on top of the BKPR.

Prerequisites

• Kubernetes 1.12+
• Helm 3.1.0
• PV provisioner support in the underlying infrastructure
• ReadWriteMany volumes for deployment scaling

Installing the Chart

To install the chart with the release name my-release:

$ helm install my-release bitnami/jasperreports

The command deploys JasperReports on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Tip

: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Parameters

The following table lists the configurable parameters of the JasperReports chart and their default values per section/component:

Global parameters

Parameter	Description	Default
global.imageRegistry	Global Docker image registry	nil
global.imagePullSecrets	Global Docker registry secret names as an array	[] (does not add image pull secrets to deployed pods)
global.storageClass	Global storage class for dynamic provisioning	nil

Common parameters

Parameter	Description	Default
nameOverride	String to partially override common.names.fullname	nil
fullnameOverride	String to fully override common.names.fullname	nil
commonLabels	Labels to add to all deployed objects	{}
commonAnnotations	Annotations to add to all deployed objects	{}
clusterDomain	Default Kubernetes cluster domain	cluster.local
extraDeploy	Array of extra objects to deploy with the release	[] (evaluated as a template)
kubeVersion	Force target Kubernetes version (using Helm capabilities if not set)	nil

JasperReports parameters

Parameter	Description	Default
image.registry	JasperReports image registry	docker.io
image.repository	JasperReports image name	bitnami/jasperreports
image.tag	JasperReports image tag	{TAG_NAME}
image.pullPolicy	JasperReports image pull policy	IfNotPresent
image.pullSecrets	Specify docker-registry secret names as an array	[] (does not add image pull secrets to deployed pods)
jasperreportsUsername	JasperReports user	user
jasperreportsPassword	JasperReports password	random 10 character long alphanumeric string
jasperreportsEmail	JasperReports user email	user@example.com
smtpHost	SMTP host	nil
smtpPort	SMTP port	nil
smtpEmail	SMTP email	nil
smtpUser	SMTP user	nil
smtpPassword	SMTP password	nil
smtpProtocol	SMTP protocol [ssl, none]	nil
command	Override default container command (useful when using custom images)	nil
args	Override default container args (useful when using custom images)	nil
extraEnvVars	Extra environment variables to be set on Jasperreports container	{}
extraEnvVarsCM	Name of existing ConfigMap containing extra env vars	nil
extraEnvVarsSecret	Name of existing Secret containing extra env vars	nil

Jasperreports deployment parameters

Parameter	Description	Default
containerPort	HTTP port to expose at container level	8080
hostAliases	Add deployment host aliases	[]
podSecurityContext	Jasperreports pods' Security Context	Check values.yaml file
containerSecurityContext	Jasperreports containers' Security Context	Check values.yaml file
resources.limits	The resources limits for the Jasperreports container	{}
resources.requests	The requested resources for the Jasperreports container	{"memory": "512Mi", "cpu": "300m"}
livenessProbe	Liveness probe configuration for Jasperreports	Check values.yaml file
readinessProbe	Readiness probe configuration for Jasperreports	Check values.yaml file
customLivenessProbe	Override default liveness probe	nil
customReadinessProbe	Override default readiness probe	nil
updateStrategy	Strategy to use to update Pods	Check values.yaml file
podAffinityPreset	Pod affinity preset. Ignored if affinity is set. Allowed values: soft or hard	""
podAntiAffinityPreset	Pod anti-affinity preset. Ignored if affinity is set. Allowed values: soft or hard	soft
nodeAffinityPreset.type	Node affinity preset type. Ignored if affinity is set. Allowed values: soft or hard	""
nodeAffinityPreset.key	Node label key to match. Ignored if affinity is set.	""
nodeAffinityPreset.values	Node label values to match. Ignored if affinity is set.	[]
affinity	Affinity for pod assignment	{} (evaluated as a template)
nodeSelector	Node labels for pod assignment	{} (evaluated as a template)
tolerations	Tolerations for pod assignment	[] (evaluated as a template)
lifecycleHooks	LifecycleHooks to set additional configuration at startup.	{} (evaluated as a template)
podLabels	Extra labels for Jasperreports pods	{} (evaluated as a template)
podAnnotations	Annotations for Jasperreports pods	{} (evaluated as a template)
extraVolumeMounts	Optionally specify extra list of additional volumeMounts for Jasperreports container(s)	[]
extraVolumes	Optionally specify extra list of additional volumes for Jasperreports pods	[]
initContainers	Add additional init containers to the Jasperreports pods	{} (evaluated as a template)
sidecars	Add additional sidecar containers to the Jasperreports pods	{} (evaluated as a template)
persistence.enabled	Enable persistence using PVC	true
persistence.storageClass	PVC Storage Class for Jasperreports volume	nil (uses alpha storage class annotation)
persistence.existingClaim	An Existing PVC name for Jasperreports volume	nil (uses alpha storage class annotation)
persistence.accessMode	PVC Access Mode for Jasperreports volume	ReadWriteOnce
persistence.size	PVC Storage Request for Jasperreports volume	8Gi

Exposure parameters

Parameter	Description	Default
service.type	Kubernetes Service type	LoadBalancer
service.port	Service HTTP port	80
service.nodePort	Kubernetes http node port	""
service.loadBalancerIP	Kubernetes LoadBalancerIP to request	nil
service.externalTrafficPolicy	Enable client source IP preservation	Cluster
service.annotations	Annotations for Jasperreports service	{} (evaluated as a template)
ingress.enabled	Enable ingress controller resource	false
ingress.certManager	Add annotations for cert-manager	false
ingress.hostname	Default host for the ingress resource	jasperreports.local
ingress.apiVersion	Force Ingress API version (automatically detected if not set)	``
ingress.path	Ingress path	/
ingress.pathType	Ingress path type	ImplementationSpecific
ingress.tls	Create TLS Secret	false
ingress.annotations	Ingress annotations	[] (evaluated as a template)
ingress.extraHosts[0].name	Additional hostnames to be covered	nil
ingress.extraHosts[0].path	Additional hostnames to be covered	nil
ingress.extraPaths	Additional arbitrary path/backend objects	nil
ingress.extraTls[0].hosts[0]	TLS configuration for additional hostnames to be covered	nil
ingress.extraTls[0].secretName	TLS configuration for additional hostnames to be covered	nil
ingress.secrets[0].name	TLS Secret Name	nil
ingress.secrets[0].certificate	TLS Secret Certificate	nil
ingress.secrets[0].key	TLS Secret Key	nil

Database parameters

Parameter	Description	Default
mariadb.enabled	Whether to use the MariaDB chart	true
mariadb.architecture	MariaDB architecture (standalone or replication)	standalone
mariadb.auth.rootPassword	Password for the MariaDB root user	random 10 character alphanumeric string
mariadb.auth.database	Database name to create	bitnami_jasperreports
mariadb.auth.username	Database user to create	bn_jasperreports
mariadb.auth.password	Password for the database	random 10 character long alphanumeric string
mariadb.primary.persistence.enabled	Enable database persistence using PVC	true
mariadb.primary.persistence.accessMode	Database Persistent Volume Access Modes	ReadWriteOnce
mariadb.primary.persistence.size	Database Persistent Volume Size	8Gi
mariadb.primary.persistence.existingClaim	Enable persistence using an existing PVC	nil
mariadb.primary.persistence.storageClass	PVC Storage Class	nil (uses alpha storage class annotation)
mariadb.primary.persistence.hostPath	Host mount path for MariaDB volume	nil (will not mount to a host path)
externalDatabase.user	Existing username in the external db	bn_jasperreports
externalDatabase.password	Password for the above username	nil
externalDatabase.database	Name of the existing database	bitnami_jasperreports
externalDatabase.host	Host of the existing database	nil
externalDatabase.port	Port of the existing database	3306
externalDatabase.existingSecret	Name of the database existing Secret Object	nil

The above parameters map to the env variables defined in bitnami/jasperreports. For more information please refer to the bitnami/jasperreports image documentation.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install my-release \
  --set jasperreportsUsername=admin,jasperreportsPassword=password,mariadb.auth.rootPassword=secretpassword \
    bitnami/jasperreports

The above command sets the JasperReports administrator account username and password to admin and password respectively. Additionally, it sets the MariaDB root user password to secretpassword.

NOTE: Once this chart is deployed, it is not possible to change the application's access credentials, such as usernames or passwords, using Helm. To change these application credentials after deployment, delete any persistent volumes (PVs) used by the chart and re-deploy it, or use the application's built-in administrative tools if available.

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

$ helm install my-release -f values.yaml bitnami/jasperreports

Tip

: You can use the default values.yaml

Configuration and installation details

Rolling VS Immutable tags

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

Persistence

The Bitnami JasperReports image stores the JasperReports data and configurations at the /bitnami/jasperreports path of the container.

Persistent Volume Claims are used to keep the data across deployments. This is known to work in GCE, AWS, and minikube. See the Parameters section to configure the PVC or to disable persistence.

Adding extra environment variables

In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars property.

extraEnvVars:
  - name: LOG_LEVEL
    value: DEBUG

Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM or the extraEnvVarsSecret values.

Sidecars and Init Containers

If you have a need for additional containers to run within the same pod as the JasperReports app (e.g. an additional metrics or logging exporter), you can do so via the sidecars config parameter. Simply define your container according to the Kubernetes container spec.

sidecars:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
       containerPort: 1234

Similarly, you can add extra init containers using the initContainers parameter.

initContainers:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
        containerPort: 1234

Setting Pod's affinity

This chart allows you to set your custom affinity using the affinity parameter. Find more information about Pod's affinity in the kubernetes documentation.

As an alternative, you can use of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset, podAntiAffinityPreset, or nodeAffinityPreset parameters.

Troubleshooting

Find more information about how to deal with common errors related to Bitnami’s Helm charts in this troubleshooting guide.

Upgrading

To 10.0.0

• Chart labels were adapted to follow the Helm charts standard labels.
• Ingress configuration was also adapted to follow the Helm charts best practices.

Consequences:

• Backwards compatibility is not guaranteed. However, you can easily workaround this issue by removing JasperReports deployment before upgrading (the following example assumes that the release name is jasperreports):

$ export JASPER_PASSWORD=$(kubectl get secret --namespace default jasperreports -o jsonpath="{.data.jasperreports-password}" | base64 --decode)
$ export MARIADB_ROOT_PASSWORD=$(kubectl get secret --namespace default jasperreports-mariadb -o jsonpath="{.data.mariadb-root-password}" | base64 --decode)
$ export MARIADB_PASSWORD=$(kubectl get secret --namespace default jasperreports-mariadb -o jsonpath="{.data.mariadb-password}" | base64 --decode)
$ kubectl delete deployments.apps jasperreports
$ helm upgrade jasperreports bitnami/jasperreports --set jasperreportsPassword=$JASPER_PASSWORD,mariadb.auth.rootPassword=$MARIADB_ROOT_PASSWORD,mariadb.auth.password=$MARIADB_PASSWORD

To 9.0.0

In this major there were two main changes introduced:

1. Adaptation to Helm v2 EOL
2. Updated MariaDB dependency version

Please read the update notes carefully.

1. Adaptation to Helm v2 EOL

On November 13, 2020, Helm v2 support was formally finished, this major version is the result of the required changes applied to the Helm Chart to be able to incorporate the different features added in Helm v3 and to be consistent with the Helm project itself regarding the Helm v2 EOL.

What changes were introduced in this major version?

• Previous versions of this Helm Chart use apiVersion: v1 (installable by both Helm 2 and 3), this Helm Chart was updated to apiVersion: v2 (installable by Helm 3 only). Here you can find more information about the apiVersion field.
• Move dependency information from the requirements.yaml to the Chart.yaml
• After running helm dependency update, a Chart.lock file is generated containing the same structure used in the previous requirements.lock
• The different fields present in the Chart.yaml file has been ordered alphabetically in a homogeneous way for all the Bitnami Helm Charts

Considerations when upgrading to this version

• If you want to upgrade to this version from a previous one installed with Helm v3, you shouldn't face any issues
• If you want to upgrade to this version using Helm v2, this scenario is not supported as this version doesn't support Helm v2 anymore
• If you installed the previous version with Helm v2 and wants to upgrade to this version with Helm v3, please refer to the official Helm documentation about migrating from Helm v2 to v3

Useful links

• https://docs.bitnami.com/tutorials/resolve-helm2-helm3-post-migration-issues/
• https://helm.sh/docs/topics/v2_v3_migration/
• https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/

2. Updated MariaDB dependency version

In this major the MariaDB dependency version was also bumped to a new major version that introduces several incompatilibites. Therefore, backwards compatibility is not guaranteed unless an external database is used. Check MariaDB Upgrading Notes for more information.

To upgrade to 9.0.0, it should be done reusing the PVCs used to hold both the MariaDB and JasperReports data on your previous release. To do so, follow the instructions below (the following example assumes that the release name is jasperreports and that a rootUser.password was defined for MariaDB in values.yaml when the chart was first installed):

NOTE: Please, create a backup of your database before running any of those actions. The steps below would be only valid if your application (e.g. any plugins or custom code) is compatible with MariaDB 10.5.x

Obtain the credentials and the names of the PVCs used to hold both the MariaDB and JasperReports data on your current release:

export JASPERREPORTS_PASSWORD=$(kubectl get secret --namespace default jasperreports -o jsonpath="{.data.jasperreports-password}" | base64 --decode)
export MARIADB_ROOT_PASSWORD=$(kubectl get secret --namespace default jasperreports-mariadb -o jsonpath="{.data.mariadb-root-password}" | base64 --decode)
export MARIADB_PASSWORD=$(kubectl get secret --namespace default jasperreports-mariadb -o jsonpath="{.data.mariadb-password}" | base64 --decode)
export MARIADB_PVC=$(kubectl get pvc -l app=mariadb,component=master,release=jasperreports -o jsonpath="{.items[0].metadata.name}")

Delete the JasperReports deployment and delete the MariaDB statefulset. Notice the option --cascade=false in the latter:

  $ kubectl delete deployments.apps jasperreports

  $ kubectl delete statefulsets.apps jasperreports-mariadb --cascade=false

Now the upgrade works:

$ helm upgrade jasperreports bitnami/jasperreports --set mariadb.primary.persistence.existingClaim=$MARIADB_PVC --set mariadb.auth.rootPassword=$MARIADB_ROOT_PASSWORD --set mariadb.auth.password=$MARIADB_PASSWORD --set jasperreportsPassword=$JASPERREPORTS_PASSWORD --set allowEmptyPasswords=false

You will have to delete the existing MariaDB pod and the new statefulset is going to create a new one

$ kubectl delete pod jasperreports-mariadb-0

Finally, you should see the lines below in MariaDB container logs:

$ kubectl logs $(kubectl get pods -l app.kubernetes.io/instance=jasperreports,app.kubernetes.io/name=mariadb,app.kubernetes.io/component=primary -o jsonpath="{.items[0].metadata.name}")
...
mariadb 12:13:24.98 INFO  ==> Using persisted data
mariadb 12:13:25.01 INFO  ==> Running mysql_upgrade
...

to 8.0.0

JasperReports 7.5.0 includes some new configuration options that are required to be added if you upgrade from previous versions. Please check the official community guide to upgrade your previous JasperReports installation.

7.0.0

Helm performs a lookup for the object based on its group (apps), version (v1), and kind (Deployment). Also known as its GroupVersionKind, or GVK. Changing the GVK is considered a compatibility breaker from Kubernetes' point of view, so you cannot "upgrade" those objects to the new GVK in-place. Earlier versions of Helm 3 did not perform the lookup correctly which has since been fixed to match the spec.

In https://github.com/helm/charts/pull/17298 the apiVersion of the deployment resources was updated to apps/v1 in tune with the api's deprecated, resulting in compatibility breakage.

This major version signifies this change.

3.0.0

Backwards compatibility is not guaranteed unless you modify the labels used on the chart's deployments. Use the workaround below to upgrade from versions previous to 3.0.0. The following example assumes that the release name is jasperreports:

$ kubectl patch deployment jasperreports-jasperreports --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'
$ kubectl delete statefulset jasperreports-mariadb --cascade=false