charts/charts/calibre-web
renovate[bot] 82f1a1669e
[calibre-web] Update helm chart common to v2 (#366)
Co-authored-by: Renovate Bot <bot@renovateapp.com>
2020-12-16 13:08:56 -05:00
..
ci [calibre-web] convert to common library (#329) 2020-12-09 15:55:16 -05:00
templates [calibre-web] convert to common library (#329) 2020-12-09 15:55:16 -05:00
.helmignore [calibre-web] convert to common library (#329) 2020-12-09 15:55:16 -05:00
Chart.yaml [calibre-web] Update helm chart common to v2 (#366) 2020-12-16 13:08:56 -05:00
OWNERS [calibre-web] convert to common library (#329) 2020-12-09 15:55:16 -05:00
README.md [calibre-web] convert to common library (#329) 2020-12-09 15:55:16 -05:00
values.yaml [calibre-web] convert to common library (#329) 2020-12-09 15:55:16 -05:00

Calibre-Web

This is a helm chart for Calibre-Web.

This chart is not maintained by the upstream project and any issues with the chart should be raised here

TL;DR;

$ helm repo add k8s-at-home https://k8s-at-home.com/charts/
$ helm install k8s-at-home/calibre-web

Storage

If you plan to use networked storage to store your media or config for Booksonic, (NFS, etc.) please take a look at the Fast Access option in the Booksonic settings. This will help improve the perfomance of the application by not constantly monitoring media folders.

Installing the Chart

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

helm install --name my-release k8s-at-home/calibre-web

Uninstalling the Chart

To uninstall/delete the my-release deployment:

helm delete my-release --purge

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

Configuration

Read through the charts values.yaml file. It has several commented out suggested values. Most notably, these include several environment variables used to customize the container. Additionally you can take a look at the common library values.yaml for more (advanced) configuration options.

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

helm install calibre-web \
  --set env.TZ="America/New_York" \
    k8s-at-home/calibre-web

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

helm install calibre-web k8s-at-home/calibre-web -f values.yaml 
image:
  tag: ...

NOTE

If you get

Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...`

it may be because you uninstalled the chart with skipuninstall enabled, you need to manually delete the pvc or use existingClaim.


Upgrading an existing Release to a new major version

A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions.

Upgrading from 2.x.x to 3.x.x

Due to migrating to a centralized common library some values in values.yaml have changed.

Examples:

  • service.port has been moved to service.port.port.
  • persistence.type has been moved to controllerType.

Refer to the library values.yaml for more configuration options.