Skip to content

Commit

Permalink
[stable/jasperreports] Unify and refactor README.md (helm#18302)
Browse files Browse the repository at this point in the history
Signed-off-by: Carlos Rodriguez Hernandez <crhernandez@bitnami.com>
  • Loading branch information
Carlos Rodríguez Hernández authored and Ciprian Hacman committed Dec 5, 2019
1 parent bfdbaab commit e00e2d9
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion stable/jasperreports/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v1
name: jasperreports
version: 6.2.6
version: 6.2.7
appVersion: 7.2.0
description: 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,
Expand Down
8 changes: 5 additions & 3 deletions stable/jasperreports/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To install the chart with the release name `my-release`:
$ helm install --name my-release stable/jasperreports
```

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

> **Tip**: List all releases using `helm list`
Expand All @@ -45,7 +45,7 @@ $ helm delete my-release

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

## Configuration
## Parameters

The following table lists the configurable parameters of the JasperReports chart and their default values.

Expand Down Expand Up @@ -123,6 +123,8 @@ $ helm install --name my-release -f values.yaml stable/jasperreports

> **Tip**: You can use the default [values.yaml](values.yaml)
## Configuration and installation details

### [Rolling VS Immutable tags](https://docs.bitnami.com/containers/how-to/understand-rolling-tags-containers/)

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.
Expand All @@ -134,7 +136,7 @@ Bitnami will release a new chart updating its containers if a new version of the
The [Bitnami JasperReports](https://github.com/bitnami/bitnami-docker-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 [Configuration](#configuration) section to configure the PVC or to disable persistence.
See the [Parameters](#parameters) section to configure the PVC or to disable persistence.

## Upgrading

Expand Down

0 comments on commit e00e2d9

Please sign in to comment.