mirror of
https://github.com/zoriya/Kyoo.git
synced 2025-07-09 03:04:20 -04:00
Improve helm values documentation (#654)
This commit is contained in:
commit
55515ccc52
@ -48,7 +48,7 @@ spec:
|
|||||||
{{- end }}
|
{{- end }}
|
||||||
env:
|
env:
|
||||||
- name: SCANNER_LIBRARY_ROOT
|
- name: SCANNER_LIBRARY_ROOT
|
||||||
value: /data
|
value: {{ .Values.media.baseMountPath | quote }}
|
||||||
- name: LIBRARY_IGNORE_PATTERN
|
- name: LIBRARY_IGNORE_PATTERN
|
||||||
value: {{ .Values.kyoo.libraryIgnorePattern | quote }}
|
value: {{ .Values.kyoo.libraryIgnorePattern | quote }}
|
||||||
- name: KYOO_APIKEYS
|
- name: KYOO_APIKEYS
|
||||||
|
@ -58,7 +58,7 @@ spec:
|
|||||||
- name: GOCODER_PREFIX
|
- name: GOCODER_PREFIX
|
||||||
value: "/video"
|
value: "/video"
|
||||||
- name: GOCODER_SAFE_PATH
|
- name: GOCODER_SAFE_PATH
|
||||||
value: "/data"
|
value: {{ .Values.media.baseMountPath | quote }}
|
||||||
- name: POSTGRES_USER
|
- name: POSTGRES_USER
|
||||||
valueFrom:
|
valueFrom:
|
||||||
secretKeyRef:
|
secretKeyRef:
|
||||||
|
@ -1,4 +1,7 @@
|
|||||||
# Default values for kyoo.
|
# Kyoo consists of multiple services, please view diagrams for additional context
|
||||||
|
# https://github.com/zoriya/Kyoo/blob/master/DIAGRAMS.md
|
||||||
|
|
||||||
|
# global configures shared microservices and subcharts settings
|
||||||
global:
|
global:
|
||||||
image:
|
image:
|
||||||
repositoryBase: "ghcr.io/zoriya"
|
repositoryBase: "ghcr.io/zoriya"
|
||||||
@ -10,37 +13,47 @@ global:
|
|||||||
podLabels: {}
|
podLabels: {}
|
||||||
extraEnv: []
|
extraEnv: []
|
||||||
|
|
||||||
|
# kyoo connectivity & subchart settings for meilisearch
|
||||||
|
# subchart configuration can be found at .meilisearch
|
||||||
meilisearch:
|
meilisearch:
|
||||||
proto: http
|
proto: http
|
||||||
host: kyoo-meilisearch
|
host: kyoo-meilisearch
|
||||||
port: 7700
|
port: 7700
|
||||||
#infra is only used by subchart deployment
|
# subchart specific settings
|
||||||
infra:
|
infra:
|
||||||
# DOES NOT SUPPORT SPECIFYING KEY. MUST BE NAMED `MEILI_MASTER_KEY`
|
# subchart does not support specifying keyname.
|
||||||
|
# key must be named `MEILI_MASTER_KEY`
|
||||||
existingSecret: bigsecret
|
existingSecret: bigsecret
|
||||||
|
# kyoo_back workload specific settings
|
||||||
kyoo_back:
|
kyoo_back:
|
||||||
masterkeyKey: MEILI_MASTER_KEY
|
masterkeyKey: MEILI_MASTER_KEY
|
||||||
existingSecret: bigsecret
|
existingSecret: bigsecret
|
||||||
|
# kyoo connectivity & subchart settings for postgres
|
||||||
|
# subchart configuration can be found at .postgresql
|
||||||
postgres:
|
postgres:
|
||||||
#infra is only used by subchart deployment
|
# subchart specific settings
|
||||||
infra:
|
infra:
|
||||||
# subchart does not accept this global value in one place
|
# subchart does not accept this global value in one place
|
||||||
# if updating be sure to also update postgresql.auth.username
|
# if updating be sure to also update .postgresql.auth.username
|
||||||
user: kyoo_all
|
user: kyoo_all
|
||||||
passwordKey: postgres_password
|
passwordKey: postgres_password
|
||||||
existingSecret: bigsecret
|
existingSecret: bigsecret
|
||||||
|
# kyoo settings for connecting to kyoo_back database
|
||||||
kyoo_back:
|
kyoo_back:
|
||||||
host: kyoo-postgresql
|
host: kyoo-postgresql
|
||||||
port: 5432
|
port: 5432
|
||||||
database: kyoo_back
|
database: kyoo_back
|
||||||
|
# kyoo_migrations workload specific settings
|
||||||
kyoo_migrations:
|
kyoo_migrations:
|
||||||
userKey: postgres_user
|
userKey: postgres_user
|
||||||
passwordKey: postgres_password
|
passwordKey: postgres_password
|
||||||
existingSecret: bigsecret
|
existingSecret: bigsecret
|
||||||
|
# kyoo_back workload specific settings
|
||||||
kyoo_back:
|
kyoo_back:
|
||||||
userKey: postgres_user
|
userKey: postgres_user
|
||||||
passwordKey: postgres_password
|
passwordKey: postgres_password
|
||||||
existingSecret: bigsecret
|
existingSecret: bigsecret
|
||||||
|
# kyoo settings for connecting to kyoo_transcoder database
|
||||||
kyoo_transcoder:
|
kyoo_transcoder:
|
||||||
host: kyoo-postgresql
|
host: kyoo-postgresql
|
||||||
port: 5432
|
port: 5432
|
||||||
@ -48,43 +61,56 @@ global:
|
|||||||
# POSTGRES_SCHEMA disabled means application will not create the schema
|
# POSTGRES_SCHEMA disabled means application will not create the schema
|
||||||
# and will instead use the user's search path
|
# and will instead use the user's search path
|
||||||
schema: disabled
|
schema: disabled
|
||||||
|
# kyoo_transcoder workload specific settings
|
||||||
kyoo_transcoder:
|
kyoo_transcoder:
|
||||||
userKey: postgres_user
|
userKey: postgres_user
|
||||||
passwordKey: postgres_password
|
passwordKey: postgres_password
|
||||||
existingSecret: bigsecret
|
existingSecret: bigsecret
|
||||||
|
# kyoo connectivity & subchart settings for rabbitmq
|
||||||
|
# subchart configuration can be found at .rabbitmq
|
||||||
rabbitmq:
|
rabbitmq:
|
||||||
host: kyoo-rabbitmq
|
host: kyoo-rabbitmq
|
||||||
port: 5672
|
port: 5672
|
||||||
# vhost is not used yet
|
# vhost is not used yet https://github.com/zoriya/Kyoo/issues/537
|
||||||
# vhost: ""
|
# vhost: ""
|
||||||
#infra is only used by subchart deployment
|
# subchart specific settings
|
||||||
infra:
|
infra:
|
||||||
# user must be manually aligned via rabbitmq.auth.user
|
# user must be manually aligned via rabbitmq.auth.user
|
||||||
passwordKey: rabbitmq_password
|
passwordKey: rabbitmq_password
|
||||||
keyErlangCookie: rabbitmq_cookie
|
keyErlangCookie: rabbitmq_cookie
|
||||||
existingSecret: bigsecret
|
existingSecret: bigsecret
|
||||||
|
# kyoo_autosync workload specific settings
|
||||||
kyoo_autosync:
|
kyoo_autosync:
|
||||||
userKey: rabbitmq_user
|
userKey: rabbitmq_user
|
||||||
passwordKey: rabbitmq_password
|
passwordKey: rabbitmq_password
|
||||||
existingSecret: bigsecret
|
existingSecret: bigsecret
|
||||||
|
# kyoo_back workload specific settings
|
||||||
kyoo_back:
|
kyoo_back:
|
||||||
userKey: rabbitmq_user
|
userKey: rabbitmq_user
|
||||||
passwordKey: rabbitmq_password
|
passwordKey: rabbitmq_password
|
||||||
existingSecret: bigsecret
|
existingSecret: bigsecret
|
||||||
|
# kyoo_matcher workload specific settings
|
||||||
kyoo_matcher:
|
kyoo_matcher:
|
||||||
userKey: rabbitmq_user
|
userKey: rabbitmq_user
|
||||||
passwordKey: rabbitmq_password
|
passwordKey: rabbitmq_password
|
||||||
existingSecret: bigsecret
|
existingSecret: bigsecret
|
||||||
|
# kyoo_scanner workload specific settings
|
||||||
kyoo_scanner:
|
kyoo_scanner:
|
||||||
userKey: rabbitmq_user
|
userKey: rabbitmq_user
|
||||||
passwordKey: rabbitmq_password
|
passwordKey: rabbitmq_password
|
||||||
existingSecret: bigsecret
|
existingSecret: bigsecret
|
||||||
|
|
||||||
|
# kyoo application settings
|
||||||
kyoo:
|
kyoo:
|
||||||
|
# The url you can use to reach your kyoo instance. This is used during oidc to redirect users to your instance.
|
||||||
address: "https://kyoo.mydomain.com"
|
address: "https://kyoo.mydomain.com"
|
||||||
|
# If this is true, new accounts wont have any permissions before you approve them in your admin dashboard.
|
||||||
requireAccountVerification: true
|
requireAccountVerification: true
|
||||||
|
# Specify permissions of new accounts.
|
||||||
defaultPermissions: "overall.read,overall.play"
|
defaultPermissions: "overall.read,overall.play"
|
||||||
|
# Specify permissions of guest accounts, default is no permissions.
|
||||||
unloggedPermissions: ""
|
unloggedPermissions: ""
|
||||||
|
# A pattern (regex) to ignore video files.
|
||||||
libraryIgnorePattern: ".*/[dD]ownloads?/.*"
|
libraryIgnorePattern: ".*/[dD]ownloads?/.*"
|
||||||
languages: "en"
|
languages: "en"
|
||||||
# hardware acceleration profile (valid values: disabled, vaapi, qsv, nvidia)
|
# hardware acceleration profile (valid values: disabled, vaapi, qsv, nvidia)
|
||||||
@ -108,17 +134,23 @@ kyoo:
|
|||||||
scope: "email openid profile"
|
scope: "email openid profile"
|
||||||
authMethod: ClientSecretBasic
|
authMethod: ClientSecretBasic
|
||||||
|
|
||||||
|
# configures workloads that require access to media
|
||||||
media:
|
media:
|
||||||
|
# specifies the volumes to use
|
||||||
volumes:
|
volumes:
|
||||||
- name: media
|
- name: media
|
||||||
persistentVolumeClaim:
|
persistentVolumeClaim:
|
||||||
claimName: media
|
claimName: media
|
||||||
# mounts should always be mounted to /data
|
# specifies where to mount the volumes
|
||||||
|
# note that this should align with .media.baseMountPath
|
||||||
volumeMounts:
|
volumeMounts:
|
||||||
- mountPath: /data
|
- mountPath: /data
|
||||||
name: media
|
name: media
|
||||||
subPath: media
|
# configures kyoo workloads to search
|
||||||
|
# note that this should align with .media.volumeMounts[].mountPath
|
||||||
|
baseMountPath: "/data"
|
||||||
|
|
||||||
|
# configures workloads that require access to contentdatabase
|
||||||
contentdatabase:
|
contentdatabase:
|
||||||
# TheMovieDB
|
# TheMovieDB
|
||||||
tmdb:
|
tmdb:
|
||||||
@ -130,17 +162,10 @@ contentdatabase:
|
|||||||
pinKey: tvdb_pin
|
pinKey: tvdb_pin
|
||||||
existingSecret: bigsecret
|
existingSecret: bigsecret
|
||||||
|
|
||||||
ingress:
|
# autosync deployment configuration
|
||||||
enabled: false
|
|
||||||
ingressClassName: ~
|
|
||||||
annotations: {}
|
|
||||||
extraAnnotations: {}
|
|
||||||
host: kyoo.mydomain.com
|
|
||||||
tls: false
|
|
||||||
tlsSecret: ~
|
|
||||||
|
|
||||||
autosync:
|
autosync:
|
||||||
name: autosync
|
name: autosync
|
||||||
|
# kyoo_autosync container configuration
|
||||||
kyoo_autosync:
|
kyoo_autosync:
|
||||||
livenessProbe: {}
|
livenessProbe: {}
|
||||||
readinessProbe: {}
|
readinessProbe: {}
|
||||||
@ -166,8 +191,10 @@ autosync:
|
|||||||
extraInitContainers: []
|
extraInitContainers: []
|
||||||
extraVolumes: []
|
extraVolumes: []
|
||||||
|
|
||||||
|
# back deployment configuration
|
||||||
back:
|
back:
|
||||||
name: back
|
name: back
|
||||||
|
# kyoo_migrations init container configuration
|
||||||
kyoo_migrations:
|
kyoo_migrations:
|
||||||
livenessProbe: {}
|
livenessProbe: {}
|
||||||
readinessProbe: {}
|
readinessProbe: {}
|
||||||
@ -179,6 +206,7 @@ back:
|
|||||||
image:
|
image:
|
||||||
repository: ~
|
repository: ~
|
||||||
tag: ~
|
tag: ~
|
||||||
|
# kyoo_back container configuration
|
||||||
kyoo_back:
|
kyoo_back:
|
||||||
livenessProbe: {}
|
livenessProbe: {}
|
||||||
readinessProbe: {}
|
readinessProbe: {}
|
||||||
@ -215,8 +243,10 @@ back:
|
|||||||
extraInitContainers: []
|
extraInitContainers: []
|
||||||
extraVolumes: []
|
extraVolumes: []
|
||||||
|
|
||||||
|
# front deployment configuration
|
||||||
front:
|
front:
|
||||||
name: front
|
name: front
|
||||||
|
# kyoo_front container configuration
|
||||||
kyoo_front:
|
kyoo_front:
|
||||||
livenessProbe: {}
|
livenessProbe: {}
|
||||||
readinessProbe: {}
|
readinessProbe: {}
|
||||||
@ -246,20 +276,23 @@ front:
|
|||||||
extraInitContainers: []
|
extraInitContainers: []
|
||||||
extraVolumes: []
|
extraVolumes: []
|
||||||
|
|
||||||
|
# matcher deployment configuration
|
||||||
matcher:
|
matcher:
|
||||||
name: matcher
|
name: matcher
|
||||||
|
# kyoo_matcher container configuration
|
||||||
kyoo_matcher:
|
kyoo_matcher:
|
||||||
livenessProbe: {}
|
livenessProbe: {}
|
||||||
readinessProbe: {}
|
readinessProbe: {}
|
||||||
resources: {}
|
resources: {}
|
||||||
containerSecurityContext: {}
|
containerSecurityContext: {}
|
||||||
extraVolumeMounts: []
|
extraVolumeMounts: []
|
||||||
# workaround until dedicated image is created
|
# kyoo_matcher uses the same image as kyoo_scanner
|
||||||
extraArgs:
|
# requires an additional argument to function as matcher
|
||||||
|
extraArgs:
|
||||||
- matcher
|
- matcher
|
||||||
extraEnv: []
|
extraEnv: []
|
||||||
image:
|
image:
|
||||||
# workaround until dedicated image is created
|
# kyoo_matcher uses the same image as kyoo_scanner
|
||||||
repository: ghcr.io/zoriya/kyoo_scanner
|
repository: ghcr.io/zoriya/kyoo_scanner
|
||||||
tag: ~
|
tag: ~
|
||||||
# matcher does not support multiple replicas
|
# matcher does not support multiple replicas
|
||||||
@ -277,8 +310,10 @@ matcher:
|
|||||||
extraInitContainers: []
|
extraInitContainers: []
|
||||||
extraVolumes: []
|
extraVolumes: []
|
||||||
|
|
||||||
|
# scanner deployment configuration
|
||||||
scanner:
|
scanner:
|
||||||
name: scanner
|
name: scanner
|
||||||
|
# kyoo_scanner container configuration
|
||||||
kyoo_scanner:
|
kyoo_scanner:
|
||||||
livenessProbe: {}
|
livenessProbe: {}
|
||||||
readinessProbe: {}
|
readinessProbe: {}
|
||||||
@ -305,8 +340,10 @@ scanner:
|
|||||||
extraInitContainers: []
|
extraInitContainers: []
|
||||||
extraVolumes: []
|
extraVolumes: []
|
||||||
|
|
||||||
|
# scanner deployment configuration
|
||||||
transcoder:
|
transcoder:
|
||||||
name: transcoder
|
name: transcoder
|
||||||
|
# kyoo_transcoder container configuration
|
||||||
kyoo_transcoder:
|
kyoo_transcoder:
|
||||||
livenessProbe: {}
|
livenessProbe: {}
|
||||||
readinessProbe: {}
|
readinessProbe: {}
|
||||||
@ -347,13 +384,23 @@ transcoder:
|
|||||||
extraInitContainers: []
|
extraInitContainers: []
|
||||||
extraVolumes: []
|
extraVolumes: []
|
||||||
|
|
||||||
|
ingress:
|
||||||
|
enabled: false
|
||||||
|
ingressClassName: ~
|
||||||
|
annotations: {}
|
||||||
|
extraAnnotations: {}
|
||||||
|
host: kyoo.mydomain.com
|
||||||
|
tls: false
|
||||||
|
tlsSecret: ~
|
||||||
|
|
||||||
# subchart settings
|
# subchart settings
|
||||||
meilisearch:
|
meilisearch:
|
||||||
enabled: false
|
enabled: false
|
||||||
environment:
|
environment:
|
||||||
MEILI_ENV: production
|
MEILI_ENV: production
|
||||||
auth:
|
auth:
|
||||||
# DOES NOT SUPPORT SPECIFYING KEY. MUST BE NAMED `MEILI_MASTER_KEY`
|
# subchart does not support specifying keyname.
|
||||||
|
# key must be named `MEILI_MASTER_KEY`
|
||||||
existingMasterKeySecret: "{{ .Values.global.meilisearch.infra.existingSecret }}"
|
existingMasterKeySecret: "{{ .Values.global.meilisearch.infra.existingSecret }}"
|
||||||
persistence:
|
persistence:
|
||||||
enabled: true
|
enabled: true
|
||||||
@ -363,8 +410,9 @@ meilisearch:
|
|||||||
postgresql:
|
postgresql:
|
||||||
enabled: false
|
enabled: false
|
||||||
auth:
|
auth:
|
||||||
# username is unable to reference global value
|
# default user to be created by postgres subchart
|
||||||
username: kyoo_all
|
# subchart is unable to consume a secret for specifying user
|
||||||
|
username: kyoo_all
|
||||||
existingSecret: "{{ .Values.global.postgres.infra.existingSecret }}"
|
existingSecret: "{{ .Values.global.postgres.infra.existingSecret }}"
|
||||||
secretKeys:
|
secretKeys:
|
||||||
# set the postgres user password to the same as our user
|
# set the postgres user password to the same as our user
|
||||||
@ -397,7 +445,8 @@ postgresql:
|
|||||||
rabbitmq:
|
rabbitmq:
|
||||||
enabled: false
|
enabled: false
|
||||||
auth:
|
auth:
|
||||||
# this will not read from a secret. just manually make the same
|
# default user to be created by rabbitmq subchart
|
||||||
|
# subchart is unable to consume a secret for specifying user
|
||||||
username: kyoo_all
|
username: kyoo_all
|
||||||
existingPasswordSecret: "{{ .Values.global.rabbitmq.infra.existingSecret }}"
|
existingPasswordSecret: "{{ .Values.global.rabbitmq.infra.existingSecret }}"
|
||||||
existingSecretPasswordKey: "{{ .Values.global.rabbitmq.infra.passwordKey }}"
|
existingSecretPasswordKey: "{{ .Values.global.rabbitmq.infra.passwordKey }}"
|
||||||
@ -407,4 +456,4 @@ rabbitmq:
|
|||||||
# create extraObjects
|
# create extraObjects
|
||||||
# create secret bigsecret
|
# create secret bigsecret
|
||||||
# create pvc for each object
|
# create pvc for each object
|
||||||
extraObjects: []
|
extraObjects: []
|
||||||
|
Loading…
x
Reference in New Issue
Block a user