TrueChartsClone/templates/questions/ingress/ingressList.yaml

170 lines
7.2 KiB
YAML
Raw Normal View History

2022-11-11 17:51:30 +00:00
- variable: ingressList
label: Add Manual Custom Ingresses
group: Ingress
schema:
type: list
default: []
items:
- variable: ingressListEntry
label: Custom Ingress
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: Enable Ingress
schema:
type: boolean
default: true
hidden: true
- variable: name
label: Name
schema:
type: string
default: ""
- variable: ingressClassName
label: IngressClass Name
schema:
type: string
default: ""
feat(ingressAdvanced): use tc-opencors-chain if allow-cors is enabled (#13240) **Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> ⚒️ Allows for the optional use of the existing Traefik CORS setup for Apps as CORS is required to use the official [jellyfin-vue client](https://github.com/jellyfin/jellyfin-vue). Has been updated to rely on https://github.com/truecharts/library-charts/pull/530 **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [x] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** Manually edited the chart's files on my own TrueNas Scale Server. Checked that jellyffin was using the tf-opencors-chain in Traefik rather than basic-chain and ensured I could connect to jellyfin via a custom app of [jellyfin-vue client](https://github.com/jellyfin/jellyfin-vue) when the added config was enabled but not if disabled. <img width="447" alt="Evidence of the correct chain being used in Traefik" src="https://github.com/truecharts/charts/assets/9092863/19a44a4e-fe95-4659-998b-753f4c4dbb4b"> <br> <img width="213" alt="Added config option" src="https://github.com/truecharts/charts/assets/9092863/a254c469-add2-49bf-85da-d0d17b371d7a"> **📃 Notes:** <!-- Please enter any other relevant information here --> This PR uses the same cors middleware setup as the existing [audiobookshelf](https://github.com/truecharts/charts/tree/eec761785c474f47dc76124f0d2491d16bf60715/charts/stable/audiobookshelf) app to ensure conistancy. While it may be expected that the `tf-opencors-headers` middleware could be added within the UI this unfortunately results in the `Access-Control-Allow-Origin` header still being missing as the common chain conflicts. **✔️ Checklist:** - [x] ⚖️ My code follows the style guidelines of this project - [x] 👀 I have performed a self-review of my own code - [x] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [x] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --------- Signed-off-by: Michael Walter Van Der Velden <mikevdv@vandie.co.uk>
2023-11-03 11:30:20 +00:00
- variable: allowCors
label: "Allow Cross Origin Requests"
schema:
type: boolean
show_if: [["advanced", "=", true]]
default: false
2022-11-11 17:51:30 +00:00
- variable: hosts
label: Hosts
schema:
type: list
default: []
items:
- variable: hostEntry
label: Host
schema:
additional_attrs: true
type: dict
attrs:
- variable: host
label: HostName
schema:
type: string
default: ""
required: true
- variable: paths
label: Paths
schema:
type: list
default: []
items:
- variable: pathEntry
label: Host
schema:
additional_attrs: true
type: dict
attrs:
- variable: path
label: Path
schema:
type: string
required: true
default: "/"
- variable: pathType
label: Path Type
schema:
type: string
required: true
default: Prefix
- variable: service
label: Linked Service
schema:
additional_attrs: true
type: dict
attrs:
- variable: name
label: Service Name
schema:
type: string
default: ""
- variable: port
label: Service Port
schema:
type: int
fix(scale): Fix ingress clustercert var name (#14308) **Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> ⚒️ Fixes # <!--(issue)--> Fixes some oversights in the ingress clustercertificate var **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [X] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> **📃 Notes:** <!-- Please enter any other relevant information here --> **✔️ Checklist:** - [X] ⚖️ My code follows the style guidelines of this project - [X] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [X] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --------- Signed-off-by: Kjeld Schouten <kjeld@schouten-lebbing.nl> Co-authored-by: Kjeld Schouten <kjeld@schouten-lebbing.nl>
2023-11-03 19:35:21 +00:00
- variable: certificateIssuer
label: certificateIssuer
description: 'add the name of your cert-manager clusterIssuer here for automatic tls certificates. Cannot be used combined with tls option below'
schema:
type: string
default: ""
2022-11-11 17:51:30 +00:00
- variable: tls
label: TLS-Settings
schema:
type: list
default: []
show_if: [["certificateIssuer", "=", ""]]
2022-11-11 17:51:30 +00:00
items:
- variable: tlsEntry
label: Host
schema:
additional_attrs: true
type: dict
attrs:
- variable: hosts
label: Certificate Hosts
schema:
type: list
default: []
items:
- variable: host
label: Host
schema:
type: string
default: ""
required: true
fix(scale): Fix ingress clustercert var name (#14308) **Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> ⚒️ Fixes # <!--(issue)--> Fixes some oversights in the ingress clustercertificate var **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [X] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> **📃 Notes:** <!-- Please enter any other relevant information here --> **✔️ Checklist:** - [X] ⚖️ My code follows the style guidelines of this project - [X] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [X] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --------- Signed-off-by: Kjeld Schouten <kjeld@schouten-lebbing.nl> Co-authored-by: Kjeld Schouten <kjeld@schouten-lebbing.nl>
2023-11-03 19:35:21 +00:00
- variable: certificateIssuer
label: Use Cert-Manager clusterIssuer
description: 'add the name of your Cert-Manager clusterIssuer here for automatic tls certificates.'
schema:
type: string
default: ""
2022-11-11 17:51:30 +00:00
- variable: scaleCert
label: Use TrueNAS SCALE Certificate (Deprecated)
2022-11-11 17:51:30 +00:00
schema:
show_if: [["certificateIssuer", "=", ""]]
2022-11-11 17:51:30 +00:00
type: int
$ref:
- "definitions/certificate"
feat(scale): Add experimental cluster cert questions support (#14055) **Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> Adding experimental support for the cluster certs in the SCALE UI. Ties in with PR #13852 . ⚒️ Fixes # <!--(issue)--> **⚙️ Type of change** - [x] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> Not tested on SCALE. I just checked the common lib and if I understand correctly it looks for `certificateIssuer` entry and if empty eventually looks for a `secretName` entry **📃 Notes:** <!-- Please enter any other relevant information here --> For now, Common Lib has no knowledge of cluster-wide certificates. Thus: 1. It wouldn't know how to resolve the full secret name from just the cert name. I.e. it doesn't know what the ClusterIssuer deployment is called and what the certificate naming scheme is. So, for now, the user must provide the full secret name in the form of `<CLUSTERISSUER_APP_NAME>-clusterissuer-<CLUSTER_CERT_NAME>`. 2. It wouldn't be able to enforce cluster-issuer and Kubernetes-reflector being installed if the user provides a cluster certificate name Nevertheless, I think it's fine to have this listed as an experimental feature since having it in the SCALE GUI makes it much easier to test the cluster certificates support. **QUESTION:** Why is the Cert Manager clusterIssuer option variable named `certificateIssuer` in `IngressTls.yaml` and `clusterIssuer` in `IngressList.yaml`. I think it should be `certificateIssuer` in both places. **✔️ Checklist:** - [X] ⚖️ My code follows the style guidelines of this project - [X] 👀 I have performed a self-review of my own code - [X] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [X] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --------- Signed-off-by: sdimovv <36302090+sdimovv@users.noreply.github.com> Signed-off-by: Kjeld Schouten <kjeld@schouten-lebbing.nl> Co-authored-by: Kjeld Schouten <kjeld@schouten-lebbing.nl>
2023-10-29 11:15:32 +00:00
- variable: clusterCertificate
fix(scale): Fix ingress clustercert var name (#14308) **Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> ⚒️ Fixes # <!--(issue)--> Fixes some oversights in the ingress clustercertificate var **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [X] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> **📃 Notes:** <!-- Please enter any other relevant information here --> **✔️ Checklist:** - [X] ⚖️ My code follows the style guidelines of this project - [X] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [X] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --------- Signed-off-by: Kjeld Schouten <kjeld@schouten-lebbing.nl> Co-authored-by: Kjeld Schouten <kjeld@schouten-lebbing.nl>
2023-11-03 19:35:21 +00:00
label: 'Cluster Certificate (Advanced)'
description: 'Add the name of your cluster-wide certificate, that you set up in the ClusterIssuer chart.'
feat(scale): Add experimental cluster cert questions support (#14055) **Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> Adding experimental support for the cluster certs in the SCALE UI. Ties in with PR #13852 . ⚒️ Fixes # <!--(issue)--> **⚙️ Type of change** - [x] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> Not tested on SCALE. I just checked the common lib and if I understand correctly it looks for `certificateIssuer` entry and if empty eventually looks for a `secretName` entry **📃 Notes:** <!-- Please enter any other relevant information here --> For now, Common Lib has no knowledge of cluster-wide certificates. Thus: 1. It wouldn't know how to resolve the full secret name from just the cert name. I.e. it doesn't know what the ClusterIssuer deployment is called and what the certificate naming scheme is. So, for now, the user must provide the full secret name in the form of `<CLUSTERISSUER_APP_NAME>-clusterissuer-<CLUSTER_CERT_NAME>`. 2. It wouldn't be able to enforce cluster-issuer and Kubernetes-reflector being installed if the user provides a cluster certificate name Nevertheless, I think it's fine to have this listed as an experimental feature since having it in the SCALE GUI makes it much easier to test the cluster certificates support. **QUESTION:** Why is the Cert Manager clusterIssuer option variable named `certificateIssuer` in `IngressTls.yaml` and `clusterIssuer` in `IngressList.yaml`. I think it should be `certificateIssuer` in both places. **✔️ Checklist:** - [X] ⚖️ My code follows the style guidelines of this project - [X] 👀 I have performed a self-review of my own code - [X] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [X] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --------- Signed-off-by: sdimovv <36302090+sdimovv@users.noreply.github.com> Signed-off-by: Kjeld Schouten <kjeld@schouten-lebbing.nl> Co-authored-by: Kjeld Schouten <kjeld@schouten-lebbing.nl>
2023-10-29 11:15:32 +00:00
schema:
type: string
show_if: [["certificateIssuer", "=", ""]]
feat(scale): Add experimental cluster cert questions support (#14055) **Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> Adding experimental support for the cluster certs in the SCALE UI. Ties in with PR #13852 . ⚒️ Fixes # <!--(issue)--> **⚙️ Type of change** - [x] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> Not tested on SCALE. I just checked the common lib and if I understand correctly it looks for `certificateIssuer` entry and if empty eventually looks for a `secretName` entry **📃 Notes:** <!-- Please enter any other relevant information here --> For now, Common Lib has no knowledge of cluster-wide certificates. Thus: 1. It wouldn't know how to resolve the full secret name from just the cert name. I.e. it doesn't know what the ClusterIssuer deployment is called and what the certificate naming scheme is. So, for now, the user must provide the full secret name in the form of `<CLUSTERISSUER_APP_NAME>-clusterissuer-<CLUSTER_CERT_NAME>`. 2. It wouldn't be able to enforce cluster-issuer and Kubernetes-reflector being installed if the user provides a cluster certificate name Nevertheless, I think it's fine to have this listed as an experimental feature since having it in the SCALE GUI makes it much easier to test the cluster certificates support. **QUESTION:** Why is the Cert Manager clusterIssuer option variable named `certificateIssuer` in `IngressTls.yaml` and `clusterIssuer` in `IngressList.yaml`. I think it should be `certificateIssuer` in both places. **✔️ Checklist:** - [X] ⚖️ My code follows the style guidelines of this project - [X] 👀 I have performed a self-review of my own code - [X] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [X] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --------- Signed-off-by: sdimovv <36302090+sdimovv@users.noreply.github.com> Signed-off-by: Kjeld Schouten <kjeld@schouten-lebbing.nl> Co-authored-by: Kjeld Schouten <kjeld@schouten-lebbing.nl>
2023-10-29 11:15:32 +00:00
default: ""
- variable: secretName
label: Use Custom Secret (Advanced)
schema:
type: string
show_if: [["certificateIssuer", "=", ""]]
default: ""
2022-11-11 17:51:30 +00:00
- variable: entrypoint
label: Traefik Entrypoint
description: Entrypoint used by Traefik when using Traefik as Ingress Provider
schema:
type: string
default: websecure
required: true
- variable: middlewares
label: Traefik Middlewares
description: Add previously created Traefik Middlewares to this Ingress
schema:
type: list
default: []
items:
- variable: name
label: Name
schema:
type: string
default: ""
required: true