mirror of
https://github.com/k8s-at-home/charts.git
synced 2025-01-23 15:39:02 +00:00
[language-tool] new chart
Signed-off-by: Zakhar Bessarab <zekker6@gmail.com>
This commit is contained in:
parent
da8b09cf86
commit
957ab89d67
26
charts/incubator/language-tool/.helmignore
Normal file
26
charts/incubator/language-tool/.helmignore
Normal file
@ -0,0 +1,26 @@
|
||||
# Patterns to ignore when building packages.
|
||||
# This supports shell glob matching, relative path matching, and
|
||||
# negation (prefixed with !). Only one pattern per line.
|
||||
.DS_Store
|
||||
# Common VCS dirs
|
||||
.git/
|
||||
.gitignore
|
||||
.bzr/
|
||||
.bzrignore
|
||||
.hg/
|
||||
.hgignore
|
||||
.svn/
|
||||
# Common backup files
|
||||
*.swp
|
||||
*.bak
|
||||
*.tmp
|
||||
*~
|
||||
# Various IDEs
|
||||
.project
|
||||
.idea/
|
||||
*.tmproj
|
||||
.vscode/
|
||||
# OWNERS file for Kubernetes
|
||||
OWNERS
|
||||
# helm-docs templates
|
||||
*.gotmpl
|
23
charts/incubator/language-tool/Chart.yaml
Normal file
23
charts/incubator/language-tool/Chart.yaml
Normal file
@ -0,0 +1,23 @@
|
||||
apiVersion: v2
|
||||
appVersion: "5.8"
|
||||
description: language-tool helm package
|
||||
name: language-tool
|
||||
version: 1.0.0
|
||||
kubeVersion: ">=1.16.0-0"
|
||||
keywords:
|
||||
- language-tool
|
||||
home: https://github.com/k8s-at-home/charts/tree/master/charts/incubator/language-tool
|
||||
icon: https://language-tool.org/icon
|
||||
sources:
|
||||
- https://github.com/language-tool/language-tool-docker
|
||||
maintainers:
|
||||
- name: zekker6
|
||||
email: zekker6@gmail.com
|
||||
dependencies:
|
||||
- name: common
|
||||
repository: https://library-charts.k8s-at-home.com
|
||||
version: 4.5.2
|
||||
annotations:
|
||||
artifacthub.io/changes: |
|
||||
- kind: added
|
||||
description: Initial version
|
112
charts/incubator/language-tool/README.md
Normal file
112
charts/incubator/language-tool/README.md
Normal file
@ -0,0 +1,112 @@
|
||||
# language-tool
|
||||
|
||||
![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 5.8](https://img.shields.io/badge/AppVersion-5.8-informational?style=flat-square)
|
||||
|
||||
language-tool helm package
|
||||
|
||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
||||
|
||||
## Source Code
|
||||
|
||||
* <https://github.com/language-tool/language-tool-docker>
|
||||
|
||||
## Requirements
|
||||
|
||||
Kubernetes: `>=1.16.0-0`
|
||||
|
||||
## Dependencies
|
||||
|
||||
| Repository | Name | Version |
|
||||
|------------|------|---------|
|
||||
| https://library-charts.k8s-at-home.com | common | 4.5.2 |
|
||||
|
||||
## TL;DR
|
||||
|
||||
```console
|
||||
helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
||||
helm repo update
|
||||
helm install language-tool k8s-at-home/language-tool
|
||||
```
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `language-tool`
|
||||
|
||||
```console
|
||||
helm install language-tool k8s-at-home/language-tool
|
||||
```
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall the `language-tool` deployment
|
||||
|
||||
```console
|
||||
helm uninstall language-tool
|
||||
```
|
||||
|
||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
||||
|
||||
## Configuration
|
||||
|
||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
||||
Other values may be used from the [values.yaml](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common).
|
||||
|
||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
||||
|
||||
```console
|
||||
helm install language-tool \
|
||||
--set env.TZ="America/New York" \
|
||||
k8s-at-home/language-tool
|
||||
```
|
||||
|
||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
||||
|
||||
```console
|
||||
helm install language-tool k8s-at-home/language-tool -f values.yaml
|
||||
```
|
||||
|
||||
## Custom configuration
|
||||
|
||||
N/A
|
||||
|
||||
## Values
|
||||
|
||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common)
|
||||
|
||||
| Key | Type | Default | Description |
|
||||
|-----|------|---------|-------------|
|
||||
| env | object | See below | environment variables. See more environment variables in the [container documentation](https://github.com/Erikvl87/docker-languagetool). |
|
||||
| env.Java_Xms | string | `"1024m"` | Make sure this matches values at `.Values.resources.requests.memory` |
|
||||
| env.Java_Xmx | string | `"1024m"` | Make sure this matches values at `.Values.resources.limits.memory` |
|
||||
| env.TZ | string | `"UTC"` | Set the container timezone |
|
||||
| env.langtool_languageModel | string | `"/ngrams"` | Make sure this matches `.Values.persistence.config.mountPath` |
|
||||
| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
|
||||
| image.repository | string | `"erikvl87/languagetool"` | image repository |
|
||||
| image.tag | string | `nil` | image tag |
|
||||
| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
|
||||
| initContainers.download-ngrams | object | See values.yaml | Init container to set up ngram files. For other languages check for archives (here)[https://languagetool.org/download/ngram-data/] |
|
||||
| initContainers.download-ngrams.volumeMounts[0].mountPath | string | `"/ngrams"` | Make sure this matches `.Values.persistence.config.mountPath` |
|
||||
| persistence | string | See values.yaml | Configure persistence settings for the chart under this key. ngram archive for EN is 9G in size, please ensure your pod have enough disk space to download and unpack files By default init container only installs EN ngram files, that would take approx 14G after unpacking + 9GB for downloading Also, it will take some time to download archive depending on download speed available |
|
||||
| service | object | See values.yaml | Configures service settings for the chart. |
|
||||
|
||||
## Changelog
|
||||
|
||||
### Version 1.0.0
|
||||
|
||||
#### Added
|
||||
|
||||
- Initial version
|
||||
|
||||
### Older versions
|
||||
|
||||
A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/language-tool?modal=changelog)
|
||||
|
||||
## Support
|
||||
|
||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
||||
|
||||
----------------------------------------------
|
||||
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
|
9
charts/incubator/language-tool/README_CONFIG.md.gotmpl
Normal file
9
charts/incubator/language-tool/README_CONFIG.md.gotmpl
Normal file
@ -0,0 +1,9 @@
|
||||
{{- define "custom.custom.configuration.header" -}}
|
||||
## Custom configuration
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.custom.configuration" -}}
|
||||
{{ template "custom.custom.configuration.header" . }}
|
||||
|
||||
N/A
|
||||
{{- end -}}
|
1
charts/incubator/language-tool/templates/NOTES.txt
Normal file
1
charts/incubator/language-tool/templates/NOTES.txt
Normal file
@ -0,0 +1 @@
|
||||
{{- include "common.notes.defaultNotes" . -}}
|
1
charts/incubator/language-tool/templates/common.yaml
Normal file
1
charts/incubator/language-tool/templates/common.yaml
Normal file
@ -0,0 +1 @@
|
||||
{{ include "common.all" . }}
|
80
charts/incubator/language-tool/values.yaml
Normal file
80
charts/incubator/language-tool/values.yaml
Normal file
@ -0,0 +1,80 @@
|
||||
#
|
||||
# IMPORTANT NOTE
|
||||
#
|
||||
# This chart inherits from our common library chart. You can check the default values/options here:
|
||||
# https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml
|
||||
#
|
||||
|
||||
image:
|
||||
# -- image repository
|
||||
repository: erikvl87/languagetool
|
||||
# -- image pull policy
|
||||
pullPolicy: IfNotPresent
|
||||
# -- image tag
|
||||
tag:
|
||||
|
||||
# -- environment variables. See more environment variables in the [container documentation](https://github.com/Erikvl87/docker-languagetool).
|
||||
# @default -- See below
|
||||
env:
|
||||
# -- Set the container timezone
|
||||
TZ: UTC
|
||||
# -- Make sure this matches values at `.Values.resources.requests.memory`
|
||||
Java_Xms: 1024m
|
||||
# -- Make sure this matches values at `.Values.resources.limits.memory`
|
||||
Java_Xmx: 1024m
|
||||
# -- Make sure this matches `.Values.persistence.config.mountPath`
|
||||
langtool_languageModel: /ngrams
|
||||
|
||||
# -- Configures service settings for the chart.
|
||||
# @default -- See values.yaml
|
||||
service:
|
||||
main:
|
||||
ports:
|
||||
http:
|
||||
port: 8010
|
||||
|
||||
|
||||
ingress:
|
||||
# -- Enable and configure ingress settings for the chart under this key.
|
||||
# @default -- See values.yaml
|
||||
main:
|
||||
enabled: false
|
||||
|
||||
initContainers:
|
||||
# -- Init container to set up ngram files.
|
||||
# For other languages check for archives (here)[https://languagetool.org/download/ngram-data/]
|
||||
# @default -- See values.yaml
|
||||
download-ngrams:
|
||||
image: alpine:3
|
||||
command:
|
||||
- sh
|
||||
- -c
|
||||
- |
|
||||
set -ex
|
||||
apk add --no-cache unzip
|
||||
ls -lah /ngrams
|
||||
cd /ngrams
|
||||
|
||||
if [ ! -d /ngrams/en ]; then
|
||||
wget https://languagetool.org/download/ngram-data/ngrams-en-20150817.zip -O en.zip
|
||||
unzip -d /ngrams en.zip
|
||||
rm en.zip
|
||||
fi
|
||||
|
||||
chown -R 100:101 /ngrams
|
||||
volumeMounts:
|
||||
- name: config
|
||||
# -- Make sure this matches `.Values.persistence.config.mountPath`
|
||||
mountPath: /ngrams
|
||||
|
||||
|
||||
# -- Configure persistence settings for the chart under this key.
|
||||
# ngram archive for EN is 9G in size, please ensure your pod have enough disk space to download and unpack files
|
||||
# By default init container only installs EN ngram files, that would take approx 14G after unpacking + 9GB for downloading
|
||||
# Also, it will take some time to download archive depending on download speed available
|
||||
# @default -- See values.yaml
|
||||
persistence:
|
||||
# config:
|
||||
# enabled: true
|
||||
# mountPath: /ngrams
|
||||
# size: 30Gi
|
Loading…
Reference in New Issue
Block a user