This is an automated email from the ASF dual-hosted git repository. lewismc pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/tika-helm.git
commit 2c44edcf609b19a8e9b0a7a4774e6d9285c249c6 Author: Lewis John McGibbney <[email protected]> AuthorDate: Thu Apr 8 19:40:02 2021 -0700 First working implementation and documentation --- Chart.yaml | 4 +- README.md | 124 ++++++++++++++++++++++++++++++++++++++++++++-- templates/NOTES.txt | 4 +- templates/deployment.yaml | 2 +- values.yaml | 6 +-- 5 files changed, 129 insertions(+), 11 deletions(-) diff --git a/Chart.yaml b/Chart.yaml index 8e09878..4c0d36f 100644 --- a/Chart.yaml +++ b/Chart.yaml @@ -18,8 +18,8 @@ # apiVersion v2 is Helm 3 --- apiVersion: v2 -name: tika-helm -version: "0.1.0" +name: tika +version: "1.26" #kubeVersion: description: A Helm chart to deploy Apache Tika on Kubernetes type: application diff --git a/README.md b/README.md index 9414ea7..5dd46b7 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,127 @@ tika-helm ========= -A [Helm chart](https://helm.sh/docs/topics/charts/) to deploy [Apache Tika](https://tika.apache.org) on [Kubernetes](https://kubernetes.io/). +<!--[](https://devops-ci.elastic.co/job/elastic+helm-charts+master/)--> +[](https://artifacthub.io/packages/search?repo=apache) -<img src="https://tika.apache.org/tika.png"; align="right" width="300" /> +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 [Tika Docker image][]. + +We recommend that the Helm chart version is aligned to the version Tika 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 --> + + +- [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) +- [Upgrading](#upgrading) +- [Usage notes](#usage-notes) +- [Configuration](#configuration) + - [Deprecated](#deprecated) +- [FAQ](#faq) +- [Contributing](#contributing) + +<!-- 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 Elastic Helm charts repo: +`helm repo add elastic https://helm.elastic.co` + +* Install it: + - with Helm 3: `helm install filebeat elastic/filebeat` + - with Helm 2 (deprecated): `helm install --name filebeat elastic/filebeat` +--> + +### Install development version using master branch + +* Clone the git repo: `git clone [email protected]:apache/tika-helm.git` + +* Install it: + - with Helm 3: `helm install tika . --set image.tag=latest-full` + - with Helm 2 (deprecated): `helm install --name tika . --set image.tag=latest-full` + + +## Upgrading + +Please always check [CHANGELOG.md][] and [BREAKING_CHANGES.md][] before +upgrading to a new chart version. + + +## Usage notes + +* TODO + + +## Configuration + +| Parameter | Description | Default | +|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| `...` | ... | ... | + +### Deprecated + +| Parameter | Description | Default | +|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|---------| +| `...` | ... | `...` | + +## FAQ + +None yet... + +## Contributing + +Please check [CONTRIBUTING.md][] 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 ([email protected]) # License -The code is licensed permissively under the [Apache License v2.0](https://www.apache.org/licenses/LICENSE-2.0.html). \ No newline at end of file +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 +[Helm chart]: https://helm.sh/docs/topics/charts/ +[Kubernetes]: https://kubernetes.io/ +[helm]: https://helm.sh +[latest release]: https://github.com/apache/tika-helm/releases \ No newline at end of file diff --git a/templates/NOTES.txt b/templates/NOTES.txt index 9816078..21fb4d6 100644 --- a/templates/NOTES.txt +++ b/templates/NOTES.txt @@ -17,6 +17,6 @@ {{- else if contains "ClusterIP" .Values.service.type }} export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "tika-helm.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") - echo "Visit http://127.0.0.1:8080 to use your application" - kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT + echo "Visit http://127.0.0.1:9998 to use your application" + kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 9998:$CONTAINER_PORT {{- end }} diff --git a/templates/deployment.yaml b/templates/deployment.yaml index 45a3402..57bc0e9 100644 --- a/templates/deployment.yaml +++ b/templates/deployment.yaml @@ -53,7 +53,7 @@ spec: imagePullPolicy: {{ .Values.image.pullPolicy }} ports: - name: http - containerPort: 80 + containerPort: 9998 protocol: TCP livenessProbe: httpGet: diff --git a/values.yaml b/values.yaml index 3055c3b..ee08c3d 100644 --- a/values.yaml +++ b/values.yaml @@ -20,10 +20,10 @@ replicaCount: 1 image: - repository: apache/tika-docker + repository: apache/tika pullPolicy: IfNotPresent # Overrides the image tag whose default is the chart appVersion. - tag: "1.26" + tag: "latest-full" imagePullSecrets: [] nameOverride: "" @@ -53,7 +53,7 @@ securityContext: {} service: type: ClusterIP - port: 80 + port: 9998 ingress: enabled: false
![https://tika.apache.org/tika.png"](https://tika.apache.org/tika.png"){kind=link}