Publish new changes in catalog

This commit is contained in:
sonicaj
2023-11-21 17:01:31 +00:00
parent b96df93275
commit db7fa6fb7b
28 changed files with 1080 additions and 733 deletions

View File

@@ -1,6 +0,0 @@
dependencies:
- name: common
repository: file://../../../common
version: 1.2.2
digest: sha256:fb077cb81f6acecd5c9e6adc22a18e156f780cd78f27198cdb47810f95364b56
generated: "2023-11-09T15:42:36.644289587+02:00"

View File

@@ -1,31 +0,0 @@
paperlessNetwork:
webPort: 31000
paperlessConfig:
adminUser: admin
adminPassword: supersecretpassword
adminMail: admin@example.com
paperlessID:
user: 1001
group: 1001
paperlessStorage:
data:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/data
media:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/media
consume:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/consume
trash:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/trash
pgData:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/pgData
pgBackup:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/pgBackup

View File

@@ -1,44 +0,0 @@
paperlessNetwork:
webPort: 31000
paperlessConfig:
adminUser: admin
adminPassword: supersecretpassword
adminMail: admin@example.com
enableTrash: false
additionalEnvs:
- name: PAPERLESS_OCR_LANGUAGES
value: deu+eng
- name: PAPERLESS_OCR_MODE
value: redo
paperlessID:
user: 1001
group: 1001
paperlessStorage:
data:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/data
media:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/media
consume:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/consume
trash:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/trash
pgData:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/pgData
pgBackup:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/pgBackup
additionalStorages:
- type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/data1
mountPath: /data1
- type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/data2
mountPath: /data2

View File

@@ -1,28 +0,0 @@
paperlessNetwork:
webPort: 31000
hostNetwork: true
paperlessConfig:
adminUser: admin
adminPassword: supersecretpassword
adminMail: admin@example.com
paperlessStorage:
data:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/data
media:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/media
consume:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/consume
trash:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/trash
pgData:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/pgData
pgBackup:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/pgBackup

View File

@@ -1,530 +0,0 @@
groups:
- name: Paperless-ngx Configuration
description: Configure Paperless-ngx
- name: User and Group Configuration
description: Configure User and Group for Paperless-ngx
- name: Network Configuration
description: Configure Network for Paperless-ngx
- name: Storage Configuration
description: Configure Storage for Paperless-ngx
- name: Resources Configuration
description: Configure Resources for Paperless-ngx
portals:
web_portal:
protocols:
- "$kubernetes-resource_configmap_portal_protocol"
host:
- "$kubernetes-resource_configmap_portal_host"
ports:
- "$kubernetes-resource_configmap_portal_port"
path: "$kubernetes-resource_configmap_portal_path"
questions:
- variable: TZ
group: Paperless-ngx Configuration
label: Timezone
schema:
type: string
default: Etc/UTC
required: true
$ref:
- definitions/timezone
- variable: paperlessConfig
label: ""
group: Paperless-ngx Configuration
schema:
type: dict
attrs:
- variable: adminUser
label: Admin User
description: |
The admin user for Paperless-ngx.</br>
It is only used for the initial installation.
schema:
type: string
default: ""
immutable: true
required: true
- variable: adminPassword
label: Admin Password
description: |
The admin password for Paperless-ngx.</br>
It is only used for the initial installation.
schema:
type: string
default: ""
immutable: true
required: true
private: true
- variable: adminMail
label: Admin Mail
description: |
The admin mail for Paperless-ngx.</br>
It is only used for the initial installation.
schema:
type: string
default: ""
immutable: true
required: true
- variable: enableTrash
label: Enable Trash
description: |
Enable the trash feature for Paperless-ngx.</br>
When enabled, documents will be moved to the trash instead of being deleted.
schema:
type: boolean
default: true
- variable: additionalEnvs
label: Additional Environment Variables
description: Configure additional environment variables for Paperless-ngx.
schema:
type: list
default: []
items:
- variable: env
label: Environment Variable
schema:
type: dict
attrs:
- variable: name
label: Name
schema:
type: string
required: true
- variable: value
label: Value
schema:
type: string
required: true
- variable: paperlessID
label: ""
group: User and Group Configuration
schema:
type: dict
attrs:
- variable: user
label: User ID
description: The user id that Paperless-ngx files will be owned by.
schema:
type: int
min: 568
default: 568
required: true
- variable: group
label: Group ID
description: The group id that Paperless-ngx files will be owned by.
schema:
type: int
min: 568
default: 568
required: true
- variable: paperlessNetwork
label: ""
group: Network Configuration
schema:
type: dict
attrs:
- variable: webPort
label: Web Port
description: The port for the Paperless-ngx Web UI.
schema:
type: int
default: 30070
min: 9000
max: 65535
required: true
- variable: hostNetwork
label: Host Network
description: |
Bind to the host network. It's recommended to keep this disabled.</br>
schema:
type: boolean
default: false
- variable: paperlessStorage
label: ""
group: Storage Configuration
schema:
type: dict
attrs:
- variable: data
label: Paperless-ngx Data Storage
description: The path to store Paperless-ngx Data.
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.
schema:
type: string
required: true
immutable: true
default: "ixVolume"
enum:
- value: "hostPath"
description: Host Path (Path that already exists on the system)
- value: "ixVolume"
description: ixVolume (Dataset created automatically by the system)
- variable: datasetName
label: Dataset Name
schema:
type: string
show_if: [["type", "=", "ixVolume"]]
required: true
hidden: true
immutable: true
default: "data"
$ref:
- "normalize/ixVolume"
- variable: hostPath
label: Host Path
schema:
type: hostpath
show_if: [["type", "=", "hostPath"]]
immutable: true
required: true
- variable: media
label: Paperless-ngx Media Storage
description: The path to store Paperless-ngx Media.
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.
schema:
type: string
required: true
immutable: true
default: "ixVolume"
enum:
- value: "hostPath"
description: Host Path (Path that already exists on the system)
- value: "ixVolume"
description: ixVolume (Dataset created automatically by the system)
- variable: datasetName
label: Dataset Name
schema:
type: string
show_if: [["type", "=", "ixVolume"]]
required: true
hidden: true
immutable: true
default: "media"
$ref:
- "normalize/ixVolume"
- variable: hostPath
label: Host Path
schema:
type: hostpath
show_if: [["type", "=", "hostPath"]]
immutable: true
required: true
- variable: consume
label: Paperless-ngx Consumption Storage
description: The path to store Paperless-ngx Data for Consumption.
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.
schema:
type: string
required: true
immutable: true
default: "ixVolume"
enum:
- value: "hostPath"
description: Host Path (Path that already exists on the system)
- value: "ixVolume"
description: ixVolume (Dataset created automatically by the system)
- variable: datasetName
label: Dataset Name
schema:
type: string
show_if: [["type", "=", "ixVolume"]]
required: true
hidden: true
immutable: true
default: "consume"
$ref:
- "normalize/ixVolume"
- variable: hostPath
label: Host Path
schema:
type: hostpath
show_if: [["type", "=", "hostPath"]]
immutable: true
required: true
- variable: trash
label: Paperless-ngx Trash Storage
description: |
The path to store Paperless-ngx Trash.</br>
This is only used when the trash feature is enabled.
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.
schema:
type: string
required: true
immutable: true
default: "ixVolume"
enum:
- value: "hostPath"
description: Host Path (Path that already exists on the system)
- value: "ixVolume"
description: ixVolume (Dataset created automatically by the system)
- variable: datasetName
label: Dataset Name
schema:
type: string
show_if: [["type", "=", "ixVolume"]]
required: true
hidden: true
immutable: true
default: "trash"
$ref:
- "normalize/ixVolume"
- variable: hostPath
label: Host Path
schema:
type: hostpath
show_if: [["type", "=", "hostPath"]]
immutable: true
required: true
- variable: pgData
label: Paperless-ngx Postgres Data Storage
description: The path to store Paperless-ngx Postgres Data.
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.
schema:
type: string
required: true
immutable: true
default: ixVolume
enum:
- value: hostPath
description: Host Path (Path that already exists on the system)
- value: ixVolume
description: ixVolume (Dataset created automatically by the system)
- variable: datasetName
label: Dataset Name
schema:
type: string
show_if: [["type", "=", "ixVolume"]]
required: true
hidden: true
immutable: true
default: pgData
$ref:
- "normalize/ixVolume"
- variable: hostPath
label: Host Path
schema:
type: hostpath
show_if: [["type", "=", "hostPath"]]
immutable: true
required: true
- variable: pgBackup
label: Paperless-ngx Postgres Backup Storage
description: The path to store Paperless-ngx Postgres Backup.
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.
schema:
type: string
required: true
immutable: true
default: ixVolume
enum:
- value: hostPath
description: Host Path (Path that already exists on the system)
- value: ixVolume
description: ixVolume (Dataset created automatically by the system)
- variable: datasetName
label: Dataset Name
schema:
type: string
show_if: [["type", "=", "ixVolume"]]
required: true
hidden: true
immutable: true
default: pgBackup
$ref:
- "normalize/ixVolume"
- variable: hostPath
label: Host Path
schema:
type: hostpath
show_if: [["type", "=", "hostPath"]]
immutable: true
required: true
- variable: additionalStorages
label: Additional Storage
description: Additional storage for Paperless-ngx.
schema:
type: list
default: []
items:
- variable: storageEntry
label: Storage Entry
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.</br>
SMB Share: Is a SMB share that is mounted to a persistent volume claim.
schema:
type: string
required: true
default: "ixVolume"
immutable: true
enum:
- value: "hostPath"
description: Host Path (Path that already exists on the system)
- value: "ixVolume"
description: ixVolume (Dataset created automatically by the system)
- value: "smb-pv-pvc"
description: SMB Share (Mounts a persistent volume claim to a SMB share)
- variable: mountPath
label: Mount Path
description: The path inside the container to mount the storage.
schema:
type: path
required: true
- variable: hostPath
label: Host Path
description: The host path to use for storage.
schema:
type: hostpath
show_if: [["type", "=", "hostPath"]]
required: true
- variable: datasetName
label: Dataset Name
description: The name of the dataset to use for storage.
schema:
type: string
show_if: [["type", "=", "ixVolume"]]
required: true
immutable: true
default: "storage_entry"
$ref:
- "normalize/ixVolume"
- variable: server
label: Server
description: The server for the SMB share.
schema:
type: string
show_if: [["type", "=", "smb-pv-pvc"]]
required: true
- variable: share
label: Share
description: The share name for the SMB share.
schema:
type: string
show_if: [["type", "=", "smb-pv-pvc"]]
required: true
- variable: domain
label: Domain (Optional)
description: The domain for the SMB share.
schema:
type: string
show_if: [["type", "=", "smb-pv-pvc"]]
- variable: username
label: Username
description: The username for the SMB share.
schema:
type: string
show_if: [["type", "=", "smb-pv-pvc"]]
required: true
- variable: password
label: Password
description: The password for the SMB share.
schema:
type: string
show_if: [["type", "=", "smb-pv-pvc"]]
required: true
private: true
- variable: size
label: Size (in Gi)
description: The size of the volume quota.
schema:
type: int
show_if: [["type", "=", "smb-pv-pvc"]]
required: true
min: 1
default: 1
- variable: resources
group: Resources Configuration
label: ""
schema:
type: dict
attrs:
- variable: limits
label: Limits
schema:
type: dict
attrs:
- variable: cpu
label: CPU
description: CPU limit for Paperless-ngx.
schema:
type: string
max_length: 6
valid_chars: '^(0\.[1-9]|[1-9][0-9]*)(\.[0-9]|m?)$'
valid_chars_error: |
Valid CPU limit formats are</br>
- Plain Integer - eg. 1</br>
- Float - eg. 0.5</br>
- Milicpu - eg. 500m
default: "4000m"
required: true
- variable: memory
label: Memory
description: Memory limit for Paperless-ngx.
schema:
type: string
max_length: 12
valid_chars: '^[1-9][0-9]*([EPTGMK]i?|e[0-9]+)?$'
valid_chars_error: |
Valid Memory limit formats are</br>
- Suffixed with E/P/T/G/M/K - eg. 1G</br>
- Suffixed with Ei/Pi/Ti/Gi/Mi/Ki - eg. 1Gi</br>
- Plain Integer in bytes - eg. 1024</br>
- Exponent - eg. 134e6
default: "8Gi"
required: true

View File

@@ -1,78 +0,0 @@
{{- define "paperless.persistence" -}}
persistence:
data:
enabled: true
type: {{ .Values.paperlessStorage.data.type }}
datasetName: {{ .Values.paperlessStorage.data.datasetName | default "" }}
hostPath: {{ .Values.paperlessStorage.data.hostPath | default "" }}
targetSelector:
paperless:
paperless:
mountPath: /usr/src/paperless/data
media:
enabled: true
type: {{ .Values.paperlessStorage.media.type }}
datasetName: {{ .Values.paperlessStorage.media.datasetName | default "" }}
hostPath: {{ .Values.paperlessStorage.media.hostPath | default "" }}
targetSelector:
paperless:
paperless:
mountPath: /usr/src/paperless/media
consume:
enabled: true
type: {{ .Values.paperlessStorage.consume.type }}
datasetName: {{ .Values.paperlessStorage.consume.datasetName | default "" }}
hostPath: {{ .Values.paperlessStorage.consume.hostPath | default "" }}
targetSelector:
paperless:
paperless:
mountPath: /usr/src/paperless/consume
trash:
enabled: true
type: {{ .Values.paperlessStorage.trash.type }}
datasetName: {{ .Values.paperlessStorage.trash.datasetName | default "" }}
hostPath: {{ .Values.paperlessStorage.trash.hostPath | default "" }}
targetSelector:
paperless:
paperless:
mountPath: /usr/src/paperless/trash
01-permissions:
mountPath: /mnt/directories/trash
tmp:
enabled: true
type: emptyDir
targetSelector:
paperless:
paperless:
mountPath: /tmp
{{- range $idx, $storage := .Values.paperlessStorage.additionalStorages }}
{{ printf "paperless-%v" (int $idx) }}:
{{- $size := "" -}}
{{- if $storage.size -}}
{{- $size = (printf "%vGi" $storage.size) -}}
{{- end }}
enabled: true
type: {{ $storage.type }}
datasetName: {{ $storage.datasetName | default "" }}
hostPath: {{ $storage.hostPath | default "" }}
server: {{ $storage.server | default "" }}
share: {{ $storage.share | default "" }}
domain: {{ $storage.domain | default "" }}
username: {{ $storage.username | default "" }}
password: {{ $storage.password | default "" }}
size: {{ $size }}
{{- if eq $storage.type "smb-pv-pvc" }}
mountOptions:
- key: noperm
{{- end }}
targetSelector:
paperless:
paperless:
mountPath: {{ $storage.mountPath }}
{{- end }}
{{- include "ix.v1.common.app.postgresPersistence"
(dict "pgData" .Values.paperlessStorage.pgData
"pgBackup" .Values.paperlessStorage.pgBackup
) | nindent 2 }}
{{- end -}}

View File

@@ -0,0 +1,6 @@
dependencies:
- name: common
repository: file://../../../common
version: 1.2.3
digest: sha256:e6ff49b06bf5d4d159e505ae6d153f36cd46170bb519caf90462cd5caebfd0fb
generated: "2023-11-20T15:52:31.791351612+02:00"

View File

@@ -3,7 +3,7 @@ description: Paperless-ngx is a document management system that transforms your
annotations:
title: Paperless-ngx
type: application
version: 1.1.3
version: 1.2.0
apiVersion: v2
appVersion: 1.17.4
kubeVersion: '>=1.16.0-0'
@@ -14,7 +14,7 @@ maintainers:
dependencies:
- name: common
repository: file://../../../common
version: 1.2.2
version: 1.2.3
home: https://docs.paperless-ngx.com
icon: https://media.sys.truenas.net/apps/paperless-ngx/icons/icon.svg
sources:

Binary file not shown.

View File

@@ -0,0 +1,25 @@
paperlessNetwork:
webPort: 31000
paperlessConfig:
adminUser: admin
adminPassword: supersecretpassword
adminMail: admin@example.com
paperlessID:
user: 1001
group: 1001
paperlessStorage:
data:
type: pvc
media:
type: pvc
consume:
type: pvc
trash:
type: pvc
pgData:
type: pvc
pgBackup:
type: emptyDir

View File

@@ -0,0 +1,36 @@
paperlessNetwork:
webPort: 31000
paperlessConfig:
adminUser: admin
adminPassword: supersecretpassword
adminMail: admin@example.com
enableTrash: false
additionalEnvs:
- name: PAPERLESS_OCR_LANGUAGES
value: deu+eng
- name: PAPERLESS_OCR_MODE
value: redo
paperlessID:
user: 1001
group: 1001
paperlessStorage:
data:
type: pvc
media:
type: pvc
consume:
type: pvc
trash:
type: pvc
pgData:
type: pvc
pgBackup:
type: emptyDir
additionalStorages:
- type: pvc
mountPath: /data1
- type: pvc
mountPath: /data2

View File

@@ -0,0 +1,22 @@
paperlessNetwork:
webPort: 31000
hostNetwork: true
paperlessConfig:
adminUser: admin
adminPassword: supersecretpassword
adminMail: admin@example.com
paperlessStorage:
data:
type: pvc
media:
type: pvc
consume:
type: pvc
trash:
type: pvc
pgData:
type: pvc
pgBackup:
type: emptyDir

View File

@@ -26,22 +26,28 @@ paperlessID:
paperlessStorage:
data:
type: ixVolume
datasetName: data
ixVolumeConfig:
datasetName: data
media:
type: ixVolume
datasetName: media
ixVolumeConfig:
datasetName: media
consume:
type: ixVolume
datasetName: consume
ixVolumeConfig:
datasetName: consume
trash:
type: ixVolume
datasetName: trash
ixVolumeConfig:
datasetName: trash
pgData:
type: ixVolume
datasetName: pgData
ixVolumeConfig:
datasetName: pgData
pgBackup:
type: ixVolume
datasetName: pgBackup
ixVolumeConfig:
datasetName: pgBackup
additionalStorages: []
notes:

View File

@@ -0,0 +1,73 @@
#!/usr/bin/python3
import json
import os
import sys
def storage_migrate(storage):
delete_keys = []
if storage['type'] == 'hostPath':
# Check if the key exists, if not we have already migrated
if not storage.get('hostPath'):
return storage
storage['hostPathConfig'] = {'hostPath': storage['hostPath']}
delete_keys.append('hostPath')
elif storage['type'] == 'ixVolume':
# Check if the key exists, if not we have already migrated
if not storage.get('datasetName'):
return storage
storage['ixVolumeConfig'] = {'datasetName': storage['datasetName']}
delete_keys.append('datasetName')
elif storage['type'] == 'smb-pv-pvc':
# Check if the key exists, if not we have already migrated
if not storage.get('server'):
return storage
storage['smbConfig'] = {
'server': storage['server'],
'share': storage['share'],
'domain': storage['domain'],
'username': storage['username'],
'password': storage['password'],
'size': storage['size'],
}
delete_keys.extend(['server', 'share', 'domain', 'username', 'password', 'size'])
for key in delete_keys:
storage.pop(key, None)
return storage
def migrate(values):
storage_key = 'paperlessStorage'
storages = ['data', 'media', 'consume', 'trash', 'pgData', 'pgBackup']
for storage in storages:
check_val = values.get(storage_key, {}).get(storage, {})
if not isinstance(check_val, dict) or not check_val:
raise Exception(f'Storage section {storage} is malformed')
values[storage_key][storage] = storage_migrate(check_val)
additionalStorages = values.get(storage_key, {}).get('additionalStorages', [])
for idx, storage in enumerate(additionalStorages):
if not isinstance(storage, dict) or not storage:
raise Exception(f'Item {idx} in additionalStorages is malformed')
values[storage_key]['additionalStorages'][idx] = storage_migrate(storage)
return values
if __name__ == '__main__':
if len(sys.argv) != 2:
exit(1)
if os.path.exists(sys.argv[1]):
with open(sys.argv[1], 'r') as f:
print(json.dumps(migrate(json.loads(f.read()))))

View File

@@ -0,0 +1,835 @@
groups:
- name: Paperless-ngx Configuration
description: Configure Paperless-ngx
- name: User and Group Configuration
description: Configure User and Group for Paperless-ngx
- name: Network Configuration
description: Configure Network for Paperless-ngx
- name: Storage Configuration
description: Configure Storage for Paperless-ngx
- name: Resources Configuration
description: Configure Resources for Paperless-ngx
portals:
web_portal:
protocols:
- "$kubernetes-resource_configmap_portal_protocol"
host:
- "$kubernetes-resource_configmap_portal_host"
ports:
- "$kubernetes-resource_configmap_portal_port"
path: "$kubernetes-resource_configmap_portal_path"
questions:
- variable: TZ
group: Paperless-ngx Configuration
label: Timezone
schema:
type: string
default: Etc/UTC
required: true
$ref:
- definitions/timezone
- variable: paperlessConfig
label: ""
group: Paperless-ngx Configuration
schema:
type: dict
attrs:
- variable: adminUser
label: Admin User
description: |
The admin user for Paperless-ngx.</br>
It is only used for the initial installation.
schema:
type: string
default: ""
immutable: true
required: true
- variable: adminPassword
label: Admin Password
description: |
The admin password for Paperless-ngx.</br>
It is only used for the initial installation.
schema:
type: string
default: ""
immutable: true
required: true
private: true
- variable: adminMail
label: Admin Mail
description: |
The admin mail for Paperless-ngx.</br>
It is only used for the initial installation.
schema:
type: string
default: ""
immutable: true
required: true
- variable: enableTrash
label: Enable Trash
description: |
Enable the trash feature for Paperless-ngx.</br>
When enabled, documents will be moved to the trash instead of being deleted.
schema:
type: boolean
default: true
- variable: additionalEnvs
label: Additional Environment Variables
description: Configure additional environment variables for Paperless-ngx.
schema:
type: list
default: []
items:
- variable: env
label: Environment Variable
schema:
type: dict
attrs:
- variable: name
label: Name
schema:
type: string
required: true
- variable: value
label: Value
schema:
type: string
required: true
- variable: paperlessID
label: ""
group: User and Group Configuration
schema:
type: dict
attrs:
- variable: user
label: User ID
description: The user id that Paperless-ngx files will be owned by.
schema:
type: int
min: 568
default: 568
required: true
- variable: group
label: Group ID
description: The group id that Paperless-ngx files will be owned by.
schema:
type: int
min: 568
default: 568
required: true
- variable: paperlessNetwork
label: ""
group: Network Configuration
schema:
type: dict
attrs:
- variable: webPort
label: Web Port
description: The port for the Paperless-ngx Web UI.
schema:
type: int
default: 30070
min: 9000
max: 65535
required: true
- variable: hostNetwork
label: Host Network
description: |
Bind to the host network. It's recommended to keep this disabled.</br>
schema:
type: boolean
default: false
- variable: paperlessStorage
label: ""
group: Storage Configuration
schema:
type: dict
attrs:
- variable: data
label: Paperless-ngx Data Storage
description: The path to store Paperless-ngx Data.
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.
schema:
type: string
required: true
immutable: true
default: "ixVolume"
enum:
- value: "hostPath"
description: Host Path (Path that already exists on the system)
- value: "ixVolume"
description: ixVolume (Dataset created automatically by the system)
- variable: ixVolumeConfig
label: ixVolume Configuration
description: The configuration for the ixVolume dataset.
schema:
type: dict
show_if: [["type", "=", "ixVolume"]]
$ref:
- "normalize/ixVolume"
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: datasetName
label: Dataset Name
description: The name of the dataset to use for storage.
schema:
type: string
required: true
immutable: true
hidden: true
default: "data"
- variable: aclEntries
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
- variable: hostPathConfig
label: hostPathConfig
schema:
type: dict
show_if: [["type", "=", "hostPath"]]
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: acl
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
$ref:
- "normalize/acl"
- variable: hostPath
label: Host Path
description: The host path to use for storage.
schema:
type: hostpath
show_if: [["aclEnable", "=", false]]
immutable: true
required: true
- variable: media
label: Paperless-ngx Media Storage
description: The path to store Paperless-ngx Media.
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.
schema:
type: string
required: true
immutable: true
default: "ixVolume"
enum:
- value: "hostPath"
description: Host Path (Path that already exists on the system)
- value: "ixVolume"
description: ixVolume (Dataset created automatically by the system)
- variable: ixVolumeConfig
label: ixVolume Configuration
description: The configuration for the ixVolume dataset.
schema:
type: dict
show_if: [["type", "=", "ixVolume"]]
$ref:
- "normalize/ixVolume"
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: datasetName
label: Dataset Name
description: The name of the dataset to use for storage.
schema:
type: string
required: true
immutable: true
hidden: true
default: "media"
- variable: aclEntries
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
- variable: hostPathConfig
label: hostPathConfig
schema:
type: dict
show_if: [["type", "=", "hostPath"]]
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: acl
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
$ref:
- "normalize/acl"
- variable: hostPath
label: Host Path
description: The host path to use for storage.
schema:
type: hostpath
show_if: [["aclEnable", "=", false]]
immutable: true
required: true
- variable: consume
label: Paperless-ngx Consumption Storage
description: The path to store Paperless-ngx Data for Consumption.
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.
schema:
type: string
required: true
immutable: true
default: "ixVolume"
enum:
- value: "hostPath"
description: Host Path (Path that already exists on the system)
- value: "ixVolume"
description: ixVolume (Dataset created automatically by the system)
- variable: ixVolumeConfig
label: ixVolume Configuration
description: The configuration for the ixVolume dataset.
schema:
type: dict
show_if: [["type", "=", "ixVolume"]]
$ref:
- "normalize/ixVolume"
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: datasetName
label: Dataset Name
description: The name of the dataset to use for storage.
schema:
type: string
required: true
immutable: true
hidden: true
default: "consume"
- variable: aclEntries
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
- variable: hostPathConfig
label: hostPathConfig
schema:
type: dict
show_if: [["type", "=", "hostPath"]]
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: acl
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
$ref:
- "normalize/acl"
- variable: hostPath
label: Host Path
description: The host path to use for storage.
schema:
type: hostpath
show_if: [["aclEnable", "=", false]]
immutable: true
required: true
- variable: trash
label: Paperless-ngx Trash Storage
description: |
The path to store Paperless-ngx Trash.</br>
This is only used when the trash feature is enabled.
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.
schema:
type: string
required: true
immutable: true
default: "ixVolume"
enum:
- value: "hostPath"
description: Host Path (Path that already exists on the system)
- value: "ixVolume"
description: ixVolume (Dataset created automatically by the system)
- variable: ixVolumeConfig
label: ixVolume Configuration
description: The configuration for the ixVolume dataset.
schema:
type: dict
show_if: [["type", "=", "ixVolume"]]
$ref:
- "normalize/ixVolume"
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: datasetName
label: Dataset Name
description: The name of the dataset to use for storage.
schema:
type: string
required: true
immutable: true
hidden: true
default: "trash"
- variable: aclEntries
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
- variable: hostPathConfig
label: hostPathConfig
schema:
type: dict
show_if: [["type", "=", "hostPath"]]
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: acl
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
$ref:
- "normalize/acl"
- variable: hostPath
label: Host Path
description: The host path to use for storage.
schema:
type: hostpath
show_if: [["aclEnable", "=", false]]
immutable: true
required: true
- variable: pgData
label: Paperless-ngx Postgres Data Storage
description: The path to store Paperless-ngx Postgres Data.
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.
schema:
type: string
required: true
immutable: true
default: ixVolume
enum:
- value: hostPath
description: Host Path (Path that already exists on the system)
- value: ixVolume
description: ixVolume (Dataset created automatically by the system)
- variable: ixVolumeConfig
label: ixVolume Configuration
description: The configuration for the ixVolume dataset.
schema:
type: dict
# Nothing to show for the user
hidden: true
show_if: [["type", "=", "ixVolume"]]
$ref:
- "normalize/ixVolume"
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
# Postgres does a CHMOD at startup
# Which fails with ACL
hidden: true
default: false
- variable: datasetName
label: Dataset Name
description: The name of the dataset to use for storage.
schema:
type: string
required: true
immutable: true
hidden: true
default: "pgData"
- variable: aclEntries
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
- variable: hostPathConfig
label: hostPathConfig
schema:
type: dict
show_if: [["type", "=", "hostPath"]]
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
# Postgres does a CHMOD at startup
# Which fails with ACL
hidden: true
default: false
- variable: acl
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
$ref:
- "normalize/acl"
- variable: hostPath
label: Host Path
description: The host path to use for storage.
schema:
type: hostpath
show_if: [["aclEnable", "=", false]]
immutable: true
required: true
- variable: pgBackup
label: Paperless-ngx Postgres Backup Storage
description: The path to store Paperless-ngx Postgres Backup.
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.
schema:
type: string
required: true
immutable: true
default: ixVolume
enum:
- value: hostPath
description: Host Path (Path that already exists on the system)
- value: ixVolume
description: ixVolume (Dataset created automatically by the system)
- variable: ixVolumeConfig
label: ixVolume Configuration
description: The configuration for the ixVolume dataset.
schema:
type: dict
# Nothing to show for the user
hidden: true
show_if: [["type", "=", "ixVolume"]]
$ref:
- "normalize/ixVolume"
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
# Postgres does a CHMOD at startup
# Which fails with ACL
hidden: true
default: false
- variable: datasetName
label: Dataset Name
description: The name of the dataset to use for storage.
schema:
type: string
required: true
immutable: true
hidden: true
default: "pgBackup"
- variable: aclEntries
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
- variable: hostPathConfig
label: hostPathConfig
schema:
type: dict
show_if: [["type", "=", "hostPath"]]
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
# Postgres does a CHMOD at startup
# Which fails with ACL
hidden: true
default: false
- variable: acl
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
$ref:
- "normalize/acl"
- variable: hostPath
label: Host Path
description: The host path to use for storage.
schema:
type: hostpath
show_if: [["aclEnable", "=", false]]
immutable: true
required: true
- variable: additionalStorages
label: Additional Storage
description: Additional storage for Paperless-ngx.
schema:
type: list
default: []
items:
- variable: storageEntry
label: Storage Entry
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.</br>
SMB Share: Is a SMB share that is mounted to a persistent volume claim.
schema:
type: string
required: true
default: "ixVolume"
immutable: true
enum:
- value: "hostPath"
description: Host Path (Path that already exists on the system)
- value: "ixVolume"
description: ixVolume (Dataset created automatically by the system)
- value: "smb-pv-pvc"
description: SMB Share (Mounts a persistent volume claim to a SMB share)
- variable: readOnly
label: Read Only
description: Mount the volume as read only.
schema:
type: boolean
default: false
- variable: mountPath
label: Mount Path
description: The path inside the container to mount the storage.
schema:
type: path
required: true
- variable: hostPathConfig
label: hostPathConfig
schema:
type: dict
show_if: [["type", "=", "hostPath"]]
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: acl
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
$ref:
- "normalize/acl"
- variable: hostPath
label: Host Path
description: The host path to use for storage.
schema:
type: hostpath
show_if: [["aclEnable", "=", false]]
immutable: true
required: true
- variable: ixVolumeConfig
label: ixVolume Configuration
description: The configuration for the ixVolume dataset.
schema:
type: dict
show_if: [["type", "=", "ixVolume"]]
$ref:
- "normalize/ixVolume"
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: datasetName
label: Dataset Name
description: The name of the dataset to use for storage.
schema:
type: string
required: true
immutable: true
default: "storage_entry"
- variable: aclEntries
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
- variable: smbConfig
label: SMB Share Configuration
description: The configuration for the SMB Share.
schema:
type: dict
show_if: [["type", "=", "smb-pv-pvc"]]
attrs:
- variable: server
label: Server
description: The server for the SMB share.
schema:
type: string
required: true
- variable: share
label: Share
description: The share name for the SMB share.
schema:
type: string
required: true
- variable: domain
label: Domain (Optional)
description: The domain for the SMB share.
schema:
type: string
- variable: username
label: Username
description: The username for the SMB share.
schema:
type: string
required: true
- variable: password
label: Password
description: The password for the SMB share.
schema:
type: string
required: true
private: true
- variable: size
label: Size (in Gi)
description: The size of the volume quota.
schema:
type: int
required: true
min: 1
default: 1
- variable: resources
group: Resources Configuration
label: ""
schema:
type: dict
attrs:
- variable: limits
label: Limits
schema:
type: dict
attrs:
- variable: cpu
label: CPU
description: CPU limit for Paperless-ngx.
schema:
type: string
max_length: 6
valid_chars: '^(0\.[1-9]|[1-9][0-9]*)(\.[0-9]|m?)$'
valid_chars_error: |
Valid CPU limit formats are</br>
- Plain Integer - eg. 1</br>
- Float - eg. 0.5</br>
- Milicpu - eg. 500m
default: "4000m"
required: true
- variable: memory
label: Memory
description: Memory limit for Paperless-ngx.
schema:
type: string
max_length: 12
valid_chars: '^[1-9][0-9]*([EPTGMK]i?|e[0-9]+)?$'
valid_chars_error: |
Valid Memory limit formats are</br>
- Suffixed with E/P/T/G/M/K - eg. 1G</br>
- Suffixed with Ei/Pi/Ti/Gi/Mi/Ki - eg. 1Gi</br>
- Plain Integer in bytes - eg. 1024</br>
- Exponent - eg. 134e6
default: "8Gi"
required: true

View File

@@ -52,14 +52,6 @@ workload:
port: {{ .Values.paperlessNetwork.webPort }}
path: /
initContainers:
{{- if .Values.paperlessConfig.enableTrash }}
{{/* Paperless entrypoint never chowns the trash and fails if the permissions are wrong */}}
{{- include "ix.v1.common.app.permissions" (dict "containerName" "01-permissions"
"UID" .Values.paperlessID.user
"GID" .Values.paperlessID.group
"mode" "check"
"type" "init") | nindent 8 }}
{{- end }}
{{- include "ix.v1.common.app.redisWait" (dict "name" "02-redis-wait"
"secretName" "redis-creds") | nindent 8 }}
{{- include "ix.v1.common.app.postgresWait" (dict "name" "03-postgres-wait"

View File

@@ -0,0 +1,69 @@
{{- define "paperless.persistence" -}}
persistence:
data:
enabled: true
{{- include "paperless.storage.ci.migration" (dict "storage" .Values.paperlessStorage.data) }}
{{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.paperlessStorage.data) | nindent 4 }}
targetSelector:
paperless:
paperless:
mountPath: /usr/src/paperless/data
media:
enabled: true
{{- include "paperless.storage.ci.migration" (dict "storage" .Values.paperlessStorage.media) }}
{{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.paperlessStorage.media) | nindent 4 }}
targetSelector:
paperless:
paperless:
mountPath: /usr/src/paperless/media
consume:
enabled: true
{{- include "paperless.storage.ci.migration" (dict "storage" .Values.paperlessStorage.consume) }}
{{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.paperlessStorage.consume) | nindent 4 }}
targetSelector:
paperless:
paperless:
mountPath: /usr/src/paperless/consume
trash:
enabled: true
{{- include "paperless.storage.ci.migration" (dict "storage" .Values.paperlessStorage.trash) }}
{{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.paperlessStorage.trash) | nindent 4 }}
targetSelector:
paperless:
paperless:
mountPath: /usr/src/paperless/trash
tmp:
enabled: true
type: emptyDir
targetSelector:
paperless:
paperless:
mountPath: /tmp
{{- range $idx, $storage := .Values.paperlessStorage.additionalStorages }}
{{ printf "paperless-%v:" (int $idx) }}
enabled: true
{{- include "paperless.storage.ci.migration" (dict "storage" $storage) }}
{{- include "ix.v1.common.app.storageOptions" (dict "storage" $storage) | nindent 4 }}
targetSelector:
paperless:
paperless:
mountPath: {{ $storage.mountPath }}
{{- end }}
{{- include "paperless.storage.ci.migration" (dict "storage" .Values.paperlessStorage.pgData) }}
{{- include "paperless.storage.ci.migration" (dict "storage" .Values.paperlessStorage.pgBackup) }}
{{- include "ix.v1.common.app.postgresPersistence"
(dict "pgData" .Values.paperlessStorage.pgData
"pgBackup" .Values.paperlessStorage.pgBackup
) | nindent 2 }}
{{- end -}}
{{/* TODO: Remove on the next version bump, eg 1.2.0+ */}}
{{- define "paperless.storage.ci.migration" -}}
{{- $storage := .storage -}}
{{- if $storage.hostPath -}}
{{- $_ := set $storage "hostPathConfig" dict -}}
{{- $_ := set $storage.hostPathConfig "hostPath" $storage.hostPath -}}
{{- end -}}
{{- end -}}