160 lines
6.3 KiB
Markdown
160 lines
6.3 KiB
Markdown
tika-helm
|
|
=========
|
|
|
|
[](https://artifacthub.io/packages/search?repo=apache-tika)
|
|
|
|
<div class="artifacthub-widget" data-url="https://artifacthub.io/packages/helm/apache-tika/tika" data-theme="light" data-header="true" data-stars="true" data-responsive="false"><blockquote><p lang="en" dir="ltr"><b>tika</b>: The official Helm chart to deploy Apache Tika on Kubernetes</p>— Open in <a href="https://artifacthub.io/packages/helm/apache-tika/tika">Artifact Hub</a></blockquote></div><script async src="https://artifacthub.io/artifacthub-widget.js"></script>
|
|
|
|
A [Helm chart][] to deploy [Apache Tika][] on [Kubernetes][].
|
|
|
|
<img src="https://tika.apache.org/tika.png" width="300" />
|
|
|
|
This Helm chart is a lightweight way to configure and run the official [apache/tika][] Docker image.
|
|
|
|
We recommend that the Helm chart version is aligned to the version Tika (and subsequently the
|
|
version of the [Tika Docker image][]) you want to deploy.
|
|
This will ensure that you using a chart version that has been tested against the corresponding
|
|
production version. This will also ensure that the documentation and examples for the chart
|
|
will work with the version of Tika you are installing.
|
|
|
|
<!-- development warning placeholder -->
|
|
**Warning**: This branch is used for development, please use the [latest release][] for released version.
|
|
|
|
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
|
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
|
|
- [tika-helm](#tika-helm)
|
|
- [Requirements](#requirements)
|
|
- [Installing](#installing)
|
|
- [Install released version using Helm repository](#install-released-version-using-helm-repository)
|
|
- [Install development version using master branch](#install-development-version-using-master-branch)
|
|
- [Custom configuration for tika](#custom-configuration-for-tika)
|
|
- [Upgrading](#upgrading)
|
|
- [Configuration](#configuration)
|
|
- [Deprecated](#deprecated)
|
|
- [Contributing](#contributing)
|
|
- [More Information](#more-information)
|
|
- [Authors](#authors)
|
|
- [License](#license)
|
|
|
|
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
|
<!-- Use this to update TOC: -->
|
|
<!-- docker run --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc --github -->
|
|
|
|
## Requirements
|
|
|
|
* Kubernetes >= 1.14
|
|
* [Helm][] >= v3.4.2
|
|
|
|
## Installing
|
|
|
|
### Install released version using Helm repository
|
|
|
|
**N.B.** You may or may not need/wish to install the chart into a specific **namespace**,
|
|
in which case you may need to augment the commands below.
|
|
|
|
* Add the Tika Helm charts repo:
|
|
`helm repo add tika https://apache.jfrog.io/artifactory/tika`
|
|
|
|
* Install it:
|
|
- with Helm 3: `helm install tika tika/tika --set image.tag=${release.version} -n tika-test`, you will see something like
|
|
```
|
|
helm install tika tika/tika --set image.tag=latest-full -n tika-test
|
|
|
|
...
|
|
NAME: tika
|
|
LAST DEPLOYED: Mon Jan 24 13:38:01 2022
|
|
NAMESPACE: tika-test
|
|
STATUS: deployed
|
|
REVISION: 1
|
|
NOTES:
|
|
1. Get the application URL by running these commands:
|
|
export POD_NAME=$(kubectl get pods --namespace tika-test -l "app.kubernetes.io/name=tika,app.kubernetes.io/instance=tika" -o jsonpath="{.items[0].metadata.name}")
|
|
export CONTAINER_PORT=$(kubectl get pod --namespace tika-test $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
|
|
echo "Visit http://127.0.0.1:9998 to use your application"
|
|
kubectl --namespace tika-test port-forward $POD_NAME 9998:$CONTAINER_PORT
|
|
```
|
|
You may notice that the _kubectl port forwarding_ experiences a _timeout issue_ which ultimately kills the app. In this case you can run port formarding in a loop
|
|
```
|
|
while true; do kubectl --namespace tika-test port-forward $POD_NAME 9998:$CONTAINER_PORT ; done
|
|
```
|
|
... this should keep `kubectl` reconnecting on connection lost.
|
|
|
|
### Install development version using master branch
|
|
|
|
* Clone the git repo: `git clone git@github.com:apache/tika-helm.git`
|
|
|
|
* Install it:
|
|
- with Helm 3: `helm install tika . --set image.tag=latest-full`
|
|
|
|
### Custom configuration for tika
|
|
|
|
To use custom [configuration]( https://tika.apache.org/2.9.1/configuring.html) values for apache tika, use the `tikaConfig` key in the `values.yaml`.
|
|
Example:
|
|
```
|
|
tikaConfig: |
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
<properties>
|
|
<parsers>
|
|
<!-- Default Parser for most things, except for 2 mime types -->
|
|
<parser class="org.apache.tika.parser.DefaultParser">
|
|
<mime-exclude>image/jpeg</mime-exclude>
|
|
<mime-exclude>application/pdf</mime-exclude>
|
|
</parser>
|
|
</parsers>
|
|
</properties>
|
|
```
|
|
## Upgrading
|
|
|
|
Please check `artifacthub.io/changes` in `Chart.yaml` before upgrading.
|
|
|
|
## Configuration
|
|
|
|
| Parameter | Description | Default |
|
|
| --------- | ----------- | ------- |
|
|
| `...` | ... | ... |
|
|
|
|
## Testing
|
|
|
|
```
|
|
helm plugin install https://github.com/helm-unittest/helm-unittest.git
|
|
helm unittest .
|
|
```
|
|
|
|
See [helm-unittest][] for canonical documentation.
|
|
|
|
## Contributing
|
|
|
|
Please check [CONTRIBUTING][] before any contribution or for any questions
|
|
about our development and testing process.
|
|
|
|
## More Information
|
|
|
|
For more infomation on Apache Tika Server, go to the [Apache Tika Server documentation][].
|
|
|
|
For more information on Apache Tika, go to the official [Apache Tika][] project website.
|
|
|
|
For more information on the Apache Software Foundation, go to the [Apache Software Foundation][] website.
|
|
|
|
## Authors
|
|
|
|
Apache Tika Dev Team (dev@tika.apache.org)
|
|
|
|
# License
|
|
The code is licensed permissively under the [Apache License v2.0][].
|
|
|
|
[Apache License v2.0]: https://www.apache.org/licenses/LICENSE-2.0.html
|
|
[Apache Software Foundation]: http://apache.org
|
|
[Apache Tika]: https://tika.apache.org
|
|
[Apache Tika Server documentation]: https://cwiki.apache.org/confluence/display/TIKA/TikaServer
|
|
[BREAKING_CHANGES.md]: https://github.com/apache/tika-helm/blob/master/BREAKING_CHANGES.md
|
|
[CHANGELOG.md]: https://github.com/apache/tika-helm/blob/master/CHANGELOG.md
|
|
[CONTRIBUTING]: https://github.com/apache/tika#contributing-via-github
|
|
[apache/tika]: https://github.com/apache/tika-docker
|
|
[helm-unittest]: https://github.com/helm-unittest/helm-unittest
|
|
[Helm chart]: https://helm.sh/docs/topics/charts/
|
|
[Kubernetes]: https://kubernetes.io/
|
|
[Tika Docker image]: https://hub.docker.com/r/apache/tika/tags?page=1&ordering=last_updated
|
|
[helm]: https://helm.sh
|
|
[latest release]: https://github.com/apache/tika-helm/releases
|