stable/jasperreports/README.md
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
Given the stable deprecation timeline, the Bitnami maintained JasperReports Helm chart is now located at bitnami/charts.
The Bitnami repository is already included in the Hubs and we will continue providing the same cadence of updates, support, etc that we've been keeping here these years. Installation instructions are very similar, just adding the bitnami repo and using it during the installation (bitnami/<chart> instead of stable/<chart>)
$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/<chart> # Helm 3
$ helm install --name my-release bitnami/<chart> # Helm 2
To update an exisiting stable deployment with a chart hosted in the bitnami repository you can execute
$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm upgrade my-release bitnami/<chart>
Issues and PRs related to the chart itself will be redirected to bitnami/charts GitHub repository. In the same way, we'll be happy to answer questions related to this migration process in this issue created as a common place for discussion.
$ helm install my-release stable/jasperreports
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.
To install the chart with the release name my-release:
$ helm install my-release stable/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
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.
The following table lists the configurable parameters of the JasperReports chart and their default values.
| 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 |
image.registry | JasperReports image registry | docker.io |
image.repository | JasperReports Image name | bitnami/jasperreports |
image.tag | JasperReports Image tag | {TAG_NAME} |
image.pullPolicy | Image pull policy | IfNotPresent |
image.pullSecrets | Specify docker-registry secret names as an array | [] (does not add image pull secrets to deployed pods) |
nameOverride | String to partially override jasperreports.fullname template with a string (will prepend the release name) | nil |
fullnameOverride | String to fully override jasperreports.fullname template with a string | nil |
jasperreportsUsername | User of the application | user |
jasperreportsPassword | Application password | random 10 character long alphanumeric string |
jasperreportsEmail | User email | [email protected] |
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 |
allowEmptyPassword | Allow DB blank passwords | yes |
ingress.enabled | Enable ingress controller resource | false |
ingress.annotations | Ingress annotations | [] |
ingress.certManager | Add annotations for cert-manager | false |
ingress.hosts[0].name | Hostname to your JasperReports installation | jasperreports.local |
ingress.hosts[0].path | Path within the url structure | / |
ingress.hosts[0].tls | Utilize TLS backend in ingress | false |
ingress.hosts[0].tlsHosts | Array of TLS hosts for ingress record (defaults to ingress.hosts[0].name if nil) | nil |
ingress.hosts[0].tlsSecret | TLS Secret (certificates) | jasperreports.local-tls-secret |
ingress.secrets[0].name | TLS Secret Name | nil |
ingress.secrets[0].certificate | TLS Secret Certificate | nil |
ingress.secrets[0].key | TLS Secret Key | nil |
externalDatabase.host | Host of the external database | nil |
externalDatabase.port | Port of the external database | 3306 |
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 |
mariadb.enabled | Whether to use the MariaDB chart | true |
mariadb.db.name | Database name to create | bitnami_jasperreports |
mariadb.db.user | Database user to create | bn_jasperreports |
mariadb.db.password | Password for the database | nil |
mariadb.rootUser.password | MariaDB admin password | nil |
service.type | Kubernetes Service type | LoadBalancer |
service.externalTrafficPolicy | Enable client source IP preservation | Cluster |
service.port | Service HTTP port | 80 |
service.nodePorts.http | Kubernetes http node port | "" |
persistence.enabled | Enable persistence using PVC | true |
persistence.storageClass | PVC Storage Class for JasperReports volume | nil (uses alpha storage annotation) |
persistence.accessMode | PVC Access Mode for JasperReports volume | ReadWriteOnce |
persistence.size | PVC Storage Request for JasperReports volume | 8Gi |
resources | CPU/Memory resource requests/limits | {Memory: 512Mi, CPU: 300m} |
affinity | Map of node/pod affinities | {} |
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.mariadbRootPassword=secretpassword \
stable/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.
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 stable/jasperreports
Tip: You can use the default values.yaml
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.
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.
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.
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