diff --git a/charts/incubator/kiwix-serve/.helmignore b/charts/stable/kiwix-serve/.helmignore similarity index 100% rename from charts/incubator/kiwix-serve/.helmignore rename to charts/stable/kiwix-serve/.helmignore diff --git a/charts/incubator/kiwix-serve/CHANGELOG.md b/charts/stable/kiwix-serve/CHANGELOG.md similarity index 100% rename from charts/incubator/kiwix-serve/CHANGELOG.md rename to charts/stable/kiwix-serve/CHANGELOG.md diff --git a/charts/incubator/kiwix-serve/Chart.yaml b/charts/stable/kiwix-serve/Chart.yaml similarity index 89% rename from charts/incubator/kiwix-serve/Chart.yaml rename to charts/stable/kiwix-serve/Chart.yaml index 6e417f66d38..242a2e00b6e 100644 --- a/charts/incubator/kiwix-serve/Chart.yaml +++ b/charts/stable/kiwix-serve/Chart.yaml @@ -1,7 +1,3 @@ -annotations: - truecharts.org/SCALE-support: "true" - truecharts.org/catagories: | - - Productivity apiVersion: v2 appVersion: "latest" dependencies: @@ -9,7 +5,7 @@ dependencies: repository: https://library-charts.truecharts.org version: 10.5.10 deprecated: false -description: Kiwix enables you to have the whole Wikipedia at hand wherever you go! [br]Remove download link after download complete.[/br] +description: Kiwix enables you to have the whole Wikipedia at hand wherever you go! home: https://truecharts.org/docs/charts/incubator/kiwix-serve icon: https://truecharts.org/img/hotlink-ok/chart-icons/kiwix-serve.png keywords: @@ -25,5 +21,10 @@ sources: - https://github.com/truecharts/charts/tree/master/charts/incubator/kiwix-serve - https://www.kiwix.org/ - https://hub.docker.com/r/kiwix/kiwix-serve/ + - https://github.com/kiwix/kiwix-tools/blob/master/docker/server type: application -version: 0.0.27 +version: 1.0.0 +annotations: + truecharts.org/SCALE-support: "true" + truecharts.org/catagories: | + - Productivity diff --git a/charts/incubator/kiwix-serve/README.md b/charts/stable/kiwix-serve/README.md similarity index 100% rename from charts/incubator/kiwix-serve/README.md rename to charts/stable/kiwix-serve/README.md diff --git a/charts/stable/kiwix-serve/docs/installation_notes.md b/charts/stable/kiwix-serve/docs/installation_notes.md new file mode 100644 index 00000000000..ae992f7e00d --- /dev/null +++ b/charts/stable/kiwix-serve/docs/installation_notes.md @@ -0,0 +1,16 @@ +# Installation Notes + +You need to have at least one `.zim` file. + +You can download a `.zim` file from [here](https://wiki.kiwix.org/wiki/Content) + +## ZIM Files + +For 1 `.zim` file: + +- Enter the download link in the `DOWNLOAD` field box. You have to remove the link afterwards, + otherwise it will keep re-downloading the file on each start. + +For 1 or more `.zim` files: + +- Mount `Data Storage` to a Host Path, and place your `.zim` files there. diff --git a/charts/incubator/kiwix-serve/icon.png b/charts/stable/kiwix-serve/icon.png similarity index 100% rename from charts/incubator/kiwix-serve/icon.png rename to charts/stable/kiwix-serve/icon.png diff --git a/charts/incubator/kiwix-serve/questions.yaml b/charts/stable/kiwix-serve/questions.yaml similarity index 68% rename from charts/incubator/kiwix-serve/questions.yaml rename to charts/stable/kiwix-serve/questions.yaml index c022a44c87b..7de8c232a32 100644 --- a/charts/incubator/kiwix-serve/questions.yaml +++ b/charts/stable/kiwix-serve/questions.yaml @@ -13,23 +13,23 @@ questions: # Include{controllerExpert} # Include{controllerExpertExtraArgs} - variable: env - group: "Container Configuration" - label: "Image Environment" + group: Container Configuration + label: Image Environment schema: additional_attrs: true type: dict attrs: - variable: DOWNLOAD - label: "DOWNLOAD" - description: "Add download link here to download contents httpswiki.kiwix.orgwikiContent" + label: DOWNLOAD + description: Add download link here to download contents https://wiki.kiwix.org/wiki/Content. You have to remove link after it's downloaded. schema: type: string - default: "http://download.kiwix.org/zim/wikipedia_en_chemistry_nopic.zim" + default: "" # Include{containerConfig} # Include{serviceRoot} - variable: main - label: "Main Service" - description: "The Primary service on which the healthcheck runs, often the webUI" + label: Main Service + description: The Primary service on which the healthcheck runs, often the webUI schema: additional_attrs: true type: dict @@ -37,22 +37,22 @@ questions: # Include{serviceSelectorLoadBalancer} # Include{serviceSelectorExtras} - variable: main - label: "Main Service Port Configuration" + label: Main Service Port Configuration schema: additional_attrs: true type: dict attrs: - variable: port - label: "Port" - description: "This port exposes the container port on the service" + label: Port + description: This port exposes the container port on the service schema: type: int - default: 8040 + default: 10323 required: true -# Include{advancedPortTCP} +# Include{advancedPortHTTP} - variable: targetPort - label: "Target Port" - description: "The internal(!) port on the container the Application runs on" + label: Target Port + description: The internal(!) port on the container the Application runs on schema: type: int default: 80 @@ -62,8 +62,8 @@ questions: # Include{serviceList} # Include{persistenceRoot} - variable: data - label: "data Storage" - description: "Container Path data" + label: data Storage + description: Container Path data schema: additional_attrs: true type: dict @@ -73,7 +73,7 @@ questions: # Include{persistenceList} # Include{ingressRoot} - variable: main - label: "Main Ingress" + label: Main Ingress schema: additional_attrs: true type: dict @@ -86,42 +86,42 @@ questions: # Include{security} # Include{securityContextAdvancedRoot} - variable: privileged - label: "Privileged mode" + label: Privileged mode schema: type: boolean default: false - variable: readOnlyRootFilesystem - label: "ReadOnly Root Filesystem" + label: ReadOnly Root Filesystem schema: type: boolean default: false - variable: allowPrivilegeEscalation - label: "Allow Privilege Escalation" + label: Allow Privilege Escalation schema: type: boolean default: false - variable: runAsNonRoot - label: "runAsNonRoot" + label: runAsNonRoot schema: type: boolean default: false # Include{securityContextAdvanced} # Include{podSecurityContextRoot} - variable: runAsUser - label: "runAsUser" - description: "The UserID of the user running the application" + label: runAsUser + description: The UserID of the user running the application schema: type: int default: 0 - variable: runAsGroup - label: "runAsGroup" - description: The groupID this App of the user running the application" + label: runAsGroup + description: The groupID this App of the user running the application schema: type: int default: 0 - variable: fsGroup - label: "fsGroup" - description: "The group that should own ALL storage." + label: fsGroup + description: The group that should own ALL storage. schema: type: int default: 568 diff --git a/charts/incubator/kiwix-serve/templates/common.yaml b/charts/stable/kiwix-serve/templates/common.yaml similarity index 100% rename from charts/incubator/kiwix-serve/templates/common.yaml rename to charts/stable/kiwix-serve/templates/common.yaml diff --git a/charts/incubator/kiwix-serve/values.yaml b/charts/stable/kiwix-serve/values.yaml similarity index 73% rename from charts/incubator/kiwix-serve/values.yaml rename to charts/stable/kiwix-serve/values.yaml index 247b2c5b850..e066e954896 100644 --- a/charts/incubator/kiwix-serve/values.yaml +++ b/charts/stable/kiwix-serve/values.yaml @@ -1,26 +1,33 @@ -env: - DOWNLOAD: http://download.kiwix.org/zim/wikipedia_en_chemistry_nopic.zim image: pullPolicy: IfNotPresent repository: tccr.io/truecharts/kiwix-serve - tag: latest@sha256:30bc36fa6d197997987d2f11d3beb6b7f7d87cdff5fbabc30763441a106515de -persistence: - data: - enabled: true - mountPath: /data + tag: v3.3.0@sha256:1b4f364630ed6bf4431ab7c79551fee25f594555b84f31d3449af2397b880fa5 + +args: ["*.zim"] + podSecurityContext: runAsGroup: 0 runAsUser: 0 + securityContext: readOnlyRootFilesystem: false runAsNonRoot: false + +env: + DOWNLOAD: http://download.kiwix.org/zim/wikipedia_en_chemistry_nopic.zim + service: main: ports: main: - port: 8040 - protocol: TCP + port: 10323 + protocol: HTTP targetPort: 80 +persistence: + data: + enabled: true + mountPath: /data + portal: enabled: true diff --git a/cspell.config.yaml b/cspell.config.yaml index f26edaa71b8..08b1ad4bcaa 100644 --- a/cspell.config.yaml +++ b/cspell.config.yaml @@ -61,9 +61,9 @@ words: - entrypoints - eptgmk - fireshare + - flatnotes - flemarr - Flemmarr - - flatnotes - flushtables - forcegc - fullname @@ -100,6 +100,7 @@ words: - jovyan - keepalive - killswitch + - Kiwix - kjeld - kube - kubeconfig