From bcebb4df911d56181903ee05c464b6e28e44548c Mon Sep 17 00:00:00 2001 From: Gabor Pichner Date: Wed, 30 Nov 2022 23:55:37 +0100 Subject: [PATCH] docs: add missing image option --- README.md | 231 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 118 insertions(+), 113 deletions(-) diff --git a/README.md b/README.md index 135258a..f81ed3e 100644 --- a/README.md +++ b/README.md @@ -141,134 +141,139 @@ letting some customization to fit the resource inside your cluster. ### Plex -| Config path | Meaning | Default | -|-----------------------------|---------------------------------------------------------------------------------------------------------------|-----------| -| plex.enabled | Flag if you want to enable plex | true | -| plex.claim | **IMPORTANT** Token from your account, needed to claim the server | CHANGEME | -| plex.replicaCount | Number of replicas serving plex | 1 | -| plex.container.port | The port in use by the container | 32400 | -| plex.container.tag | The tag used by the container | null | -| plex.service.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) | ClusterIP | -| plex.service.port | The port assigned to the service | 32400 | -| plex.service.nodePort | In case of service.type NodePort, the nodePort to use | "" | -| plex.service.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false | -| plex.ingress.enabled | If true, creates the ingress resource for the application | true | -| plex.ingress.annotations | Additional field for annotations, if needed | {} | -| plex.ingress.path | The path where the application is exposed | /plex | -| plex.ingress.tls.enabled | If true, tls is enabled | false | -| plex.ingress.tls.secretName | Name of the secret holding certificates for the secure ingress | "" | -| plex.resources | Limits and Requests for the container | {} | -| plex.volume | If set, Plex will create a PVC for it's config volume, else it will be put on general.storage.subPaths.config | {} | +| Config path | Meaning | Default | +| --------------------------- | ------------------------------------------------------------------------------------------------------------- | -------------------------- | +| plex.enabled | Flag if you want to enable plex | true | +| plex.claim | **IMPORTANT** Token from your account, needed to claim the server | CHANGEME | +| plex.replicaCount | Number of replicas serving plex | 1 | +| plex.container.port | The port in use by the container | 32400 | +| plex.container.image | The image used by the container | docker.io/linuxserver/plex | +| plex.container.tag | The tag used by the container | null | +| plex.service.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) | ClusterIP | +| plex.service.port | The port assigned to the service | 32400 | +| plex.service.nodePort | In case of service.type NodePort, the nodePort to use | "" | +| plex.service.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false | +| plex.ingress.enabled | If true, creates the ingress resource for the application | true | +| plex.ingress.annotations | Additional field for annotations, if needed | {} | +| plex.ingress.path | The path where the application is exposed | /plex | +| plex.ingress.tls.enabled | If true, tls is enabled | false | +| plex.ingress.tls.secretName | Name of the secret holding certificates for the secure ingress | "" | +| plex.resources | Limits and Requests for the container | {} | +| plex.volume | If set, Plex will create a PVC for it's config volume, else it will be put on general.storage.subPaths.config | {} | ### Sonarr -| Config path | Meaning | Default | -|-------------------------------|----------------------------------------------------------------------------------------------------------------|-----------| -| sonarr.enabled | Flag if you want to enable sonarr | true | -| sonarr.container.port | The port in use by the container | 8989 | -| sonarr.container.tag | The tag used by the container | null | -| sonarr.service.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) | ClusterIP | -| sonarr.service.port | The port assigned to the service | 8989 | -| sonarr.service.nodePort | In case of service.type NodePort, the nodePort to use | "" | -| sonarr.service.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false | -| sonarr.ingress.enabled | If true, creates the ingress resource for the application | true | -| sonarr.ingress.annotations | Additional field for annotations, if needed | {} | -| sonarr.ingress.path | The path where the application is exposed | /sonarr | -| sonarr.ingress.tls.enabled | If true, tls is enabled | false | -| sonarr.ingress.tls.secretName | Name of the secret holding certificates for the secure ingress | "" | -| sonarr.resources | Limits and Requests for the container | {} | -| sonarr.volume | If set, Plex will create a PVC for it's config volume, else it will be put on general.storage.subPaths.config | {} | +| Config path | Meaning | Default | +| ----------------------------- | ------------------------------------------------------------------------------------------------------------- | ---------------------------- | +| sonarr.enabled | Flag if you want to enable sonarr | true | +| sonarr.container.port | The port in use by the container | 8989 | +| sonarr.container.image | The image used by the container | docker.io/linuxserver/sonarr | +| sonarr.container.tag | The tag used by the container | null | +| sonarr.service.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) | ClusterIP | +| sonarr.service.port | The port assigned to the service | 8989 | +| sonarr.service.nodePort | In case of service.type NodePort, the nodePort to use | "" | +| sonarr.service.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false | +| sonarr.ingress.enabled | If true, creates the ingress resource for the application | true | +| sonarr.ingress.annotations | Additional field for annotations, if needed | {} | +| sonarr.ingress.path | The path where the application is exposed | /sonarr | +| sonarr.ingress.tls.enabled | If true, tls is enabled | false | +| sonarr.ingress.tls.secretName | Name of the secret holding certificates for the secure ingress | "" | +| sonarr.resources | Limits and Requests for the container | {} | +| sonarr.volume | If set, Plex will create a PVC for it's config volume, else it will be put on general.storage.subPaths.config | {} | ### Radarr -| Config path | Meaning | Default | -|-------------------------------|----------------------------------------------------------------------------------------------------------------|-----------| -| radarr.enabled | Flag if you want to enable radarr | true | -| radarr.container.port | The port in use by the container | 7878 | -| radarr.container.tag | The tag used by the container | null | -| radarr.service.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) | ClusterIP | -| radarr.service.port | The port assigned to the service | 7878 | -| radarr.service.nodePort | In case of service.type NodePort, the nodePort to use | "" | -| radarr.service.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false | -| radarr.ingress.enabled | If true, creates the ingress resource for the application | true | -| radarr.ingress.annotations | Additional field for annotations, if needed | {} | -| radarr.ingress.path | The path where the application is exposed | /radarr | -| radarr.ingress.tls.enabled | If true, tls is enabled | false | -| radarr.ingress.tls.secretName | Name of the secret holding certificates for the secure ingress | "" | -| radarr.resources | Limits and Requests for the container | {} | -| radarr.volume | If set, Plex will create a PVC for it's config volume, else it will be put on general.storage.subPaths.config | {} | +| Config path | Meaning | Default | +| ----------------------------- | ------------------------------------------------------------------------------------------------------------- | ---------------------------- | +| radarr.enabled | Flag if you want to enable radarr | true | +| radarr.container.port | The port in use by the container | 7878 | +| radarr.container.image | The image used by the container | docker.io/linuxserver/radarr | +| radarr.container.tag | The tag used by the container | null | +| radarr.service.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) | ClusterIP | +| radarr.service.port | The port assigned to the service | 7878 | +| radarr.service.nodePort | In case of service.type NodePort, the nodePort to use | "" | +| radarr.service.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false | +| radarr.ingress.enabled | If true, creates the ingress resource for the application | true | +| radarr.ingress.annotations | Additional field for annotations, if needed | {} | +| radarr.ingress.path | The path where the application is exposed | /radarr | +| radarr.ingress.tls.enabled | If true, tls is enabled | false | +| radarr.ingress.tls.secretName | Name of the secret holding certificates for the secure ingress | "" | +| radarr.resources | Limits and Requests for the container | {} | +| radarr.volume | If set, Plex will create a PVC for it's config volume, else it will be put on general.storage.subPaths.config | {} | ### Jackett -| Config path | Meaning | Default | -|--------------------------------|-----------------------------------------------------------------------------------------------------------------|-----------| -| jackett.enabled | Flag if you want to enable jackett | true | -| jackett.container.port | The port in use by the container | 9117 | -| jackett.container.tag | The tag used by the container | null | -| jackett.service.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) | ClusterIP | -| jackett.service.port | The port assigned to the service | 9117 | -| jackett.service.nodePort | In case of service.type NodePort, the nodePort to use | "" | -| jackett.service.extraLBService | If true, it creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false | -| jackett.ingress.enabled | If true, creates the ingress resource for the application | true | -| jackett.ingress.annotations | Additional field for annotations, if needed | {} | -| jackett.ingress.path | The path where the application is exposed | /jackett | -| jackett.ingress.tls.enabled | If true, tls is enabled | false | -| jackett.ingress.tls.secretName | Name of the secret holding certificates for the secure ingress | "" | -| jackett.resources | Limits and Requests for the container | {} | -| jackett.volume | If set, Plex will create a PVC for it's config volume, else it will be put on general.storage.subPaths.config | {} | +| Config path | Meaning | Default | +| ------------------------------ | --------------------------------------------------------------------------------------------------------------- | ----------------------------- | +| jackett.enabled | Flag if you want to enable jackett | true | +| jackett.container.port | The port in use by the container | 9117 | +| jackett.container.image | The image used by the container | docker.io/linuxserver/jackett | +| jackett.container.tag | The tag used by the container | null | +| jackett.service.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) | ClusterIP | +| jackett.service.port | The port assigned to the service | 9117 | +| jackett.service.nodePort | In case of service.type NodePort, the nodePort to use | "" | +| jackett.service.extraLBService | If true, it creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false | +| jackett.ingress.enabled | If true, creates the ingress resource for the application | true | +| jackett.ingress.annotations | Additional field for annotations, if needed | {} | +| jackett.ingress.path | The path where the application is exposed | /jackett | +| jackett.ingress.tls.enabled | If true, tls is enabled | false | +| jackett.ingress.tls.secretName | Name of the secret holding certificates for the secure ingress | "" | +| jackett.resources | Limits and Requests for the container | {} | +| jackett.volume | If set, Plex will create a PVC for it's config volume, else it will be put on general.storage.subPaths.config | {} | ### Transmission -| Config path | Meaning | Default | -|------------------------------------------|----------------------------------------------------------------------------------------------------------------|---------------| -| transmission.enabled | Flag if you want to enable transmission | true | -| transmission.container.port.utp | The port in use by the container | 9091 | -| transmission.container.port.peer | The port in use by the container for peer connection | 51413 | -| transmission.container.tag | The tag used by the container | null | -| transmission.service.utp.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) for transmission itself | ClusterIP | -| transmission.service.utp.port | The port assigned to the service for transmission itself | 9091 | -| transmission.service.utp.nodePort | In case of service.type NodePort, the nodePort to use for transmission itself | "" | -| transmission.service.utp.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false | -| transmission.service.peer.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) for peer port | ClusterIP | -| transmission.service.peer.port | The port assigned to the service for peer port | 51413 | -| transmission.service.peer.nodePort | In case of service.type NodePort, the nodePort to use for peer port | "" | -| transmission.service.peer.nodePortUDP | In case of service.type NodePort, the nodePort to use for peer port UDP service | "" | -| transmission.service.peer.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false | -| transmission.ingress.enabled | If true, creates the ingress resource for the application | true | -| transmission.ingress.annotations | Additional field for annotations, if needed | {} | -| transmission.ingress.path | The path where the application is exposed | /transmission | -| transmission.ingress.tls.enabled | If true, tls is enabled | false | -| transmission.ingress.tls.secretName | Name of the secret holding certificates for the secure ingress | "" | -| transmission.config.auth.enabled | Enables authentication for transmission | false | -| transmission.config.auth.username | Username for transmission | "" | -| transmission.config.auth.password | Password for transmission | "" | -| transmission.resources | Limits and Requests for the container | {} | -| transmission.volume | If set, Plex will create a PVC for it's config volume, else it will be put on general.storage.subPaths.config | {} | +| Config path | Meaning | Default | +| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ---------------------------------- | +| transmission.enabled | Flag if you want to enable transmission | true | +| transmission.container.port.utp | The port in use by the container | 9091 | +| transmission.container.port.peer | The port in use by the container for peer connection | 51413 | +| transmission.container.image | The image used by the container | docker.io/linuxserver/transmission | +| transmission.container.tag | The tag used by the container | null | +| transmission.service.utp.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) for transmission itself | ClusterIP | +| transmission.service.utp.port | The port assigned to the service for transmission itself | 9091 | +| transmission.service.utp.nodePort | In case of service.type NodePort, the nodePort to use for transmission itself | "" | +| transmission.service.utp.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false | +| transmission.service.peer.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) for peer port | ClusterIP | +| transmission.service.peer.port | The port assigned to the service for peer port | 51413 | +| transmission.service.peer.nodePort | In case of service.type NodePort, the nodePort to use for peer port | "" | +| transmission.service.peer.nodePortUDP | In case of service.type NodePort, the nodePort to use for peer port UDP service | "" | +| transmission.service.peer.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false | +| transmission.ingress.enabled | If true, creates the ingress resource for the application | true | +| transmission.ingress.annotations | Additional field for annotations, if needed | {} | +| transmission.ingress.path | The path where the application is exposed | /transmission | +| transmission.ingress.tls.enabled | If true, tls is enabled | false | +| transmission.ingress.tls.secretName | Name of the secret holding certificates for the secure ingress | "" | +| transmission.config.auth.enabled | Enables authentication for transmission | false | +| transmission.config.auth.username | Username for transmission | "" | +| transmission.config.auth.password | Password for transmission | "" | +| transmission.resources | Limits and Requests for the container | {} | +| transmission.volume | If set, Plex will create a PVC for it's config volume, else it will be put on general.storage.subPaths.config | {} | ### Sabnzbd -| Config path | Meaning | Default | -|--------------------------------------|----------------------------------------------------------------------------------------------------------------|-----------| -| sabnzbd.enabled | Flag if you want to enable sabnzbd | true | -| sabnzbd.container.port.http | The port in use by the container | 8080 | -| sabnzbd.container.port.https | The port in use by the container for peer connection | 9090 | -| sabnzbd.container.tag | The tag used by the container | null | -| sabnzbd.service.http.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) for sabnzbd itself | ClusterIP | -| sabnzbd.service.http.port | The port assigned to the service for sabnzbd itself | 9091 | -| sabnzbd.service.http.nodePort | In case of service.type NodePort, the nodePort to use for sabnzbd itself | "" | -| sabnzbd.service.http.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false | -| sabnzbd.service.https.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) for https port | ClusterIP | -| sabnzbd.service.https.port | The port assigned to the service for peer port | 51413 | -| sabnzbd.service.https.nodePort | In case of service.type NodePort, the nodePort to use for https port | "" | -| sabnzbd.service.https.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false | -| sabnzbd.ingress.enabled | If true, creates the ingress resource for the application | true | -| sabnzbd.ingress.annotations | Additional field for annotations, if needed | {} | -| sabnzbd.ingress.path | The path where the application is exposed | /sabnzbd | -| sabnzbd.ingress.tls.enabled | If true, tls is enabled | false | -| sabnzbd.ingress.tls.secretName | Name of the secret holding certificates for the secure ingress | "" | -| sabnzbd.resources | Limits and Requests for the container | {} | -| sabnzbd.volume | If set, Plex will create a PVC for it's config volume, else it will be put on general.storage.subPaths.config | {} | - +| Config path | Meaning | Default | +| ------------------------------------ | ------------------------------------------------------------------------------------------------------------- | ----------------------------- | +| sabnzbd.enabled | Flag if you want to enable sabnzbd | true | +| sabnzbd.container.port.http | The port in use by the container | 8080 | +| sabnzbd.container.port.https | The port in use by the container for peer connection | 9090 | +| sabnzbd.container.image | The image used by the container | docker.io/linuxserver/sabnzbd | +| sabnzbd.container.tag | The tag used by the container | null | +| sabnzbd.service.http.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) for sabnzbd itself | ClusterIP | +| sabnzbd.service.http.port | The port assigned to the service for sabnzbd itself | 9091 | +| sabnzbd.service.http.nodePort | In case of service.type NodePort, the nodePort to use for sabnzbd itself | "" | +| sabnzbd.service.http.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false | +| sabnzbd.service.https.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) for https port | ClusterIP | +| sabnzbd.service.https.port | The port assigned to the service for peer port | 51413 | +| sabnzbd.service.https.nodePort | In case of service.type NodePort, the nodePort to use for https port | "" | +| sabnzbd.service.https.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false | +| sabnzbd.ingress.enabled | If true, creates the ingress resource for the application | true | +| sabnzbd.ingress.annotations | Additional field for annotations, if needed | {} | +| sabnzbd.ingress.path | The path where the application is exposed | /sabnzbd | +| sabnzbd.ingress.tls.enabled | If true, tls is enabled | false | +| sabnzbd.ingress.tls.secretName | Name of the secret holding certificates for the secure ingress | "" | +| sabnzbd.resources | Limits and Requests for the container | {} | +| sabnzbd.volume | If set, Plex will create a PVC for it's config volume, else it will be put on general.storage.subPaths.config | {} | ## About the project