ant385525andGitHub
2f3e5c2653
**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)--> Current image used in the cluster-wide cert guide uses "letsencrypt" as the ACME Issuer name but doesn't show the ACME issuer section for their config. This leads users to misconfigure cluster certs as the installation guide used "cert" as the ACME issuer name. This way another image doesn't need to be added to the page as it's assumed users followed the installation guide or would at least look there to troubleshoot. **⚙️ Type of change** - [ ] ⚙️ 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 --> **📃 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 - [x] 📄 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: ant385525 <121154142+ant385525@users.noreply.github.com>
2.1 KiB
title
| title |
|---|
| Cluster Certificates Setup Guide |
This guide will walk you through setting up and using cluster certificates.
:::note
Since this is an advanced feature, it is not covered by Truecharts support.
:::
Prerequisites
- Ensure you have completed the clusterissuer Setup Guide
- Install the
kubernetes-reflectorapp from theenterprisetrain
Creating a cluster certificate
In the clusterissuer app settings create a new "Cluster-Wide certificate". As with a single domain certificate, input a cert-manager issuer (for example an ACME issuer you configured previously), a list of hosts for which the certificate is valid (you can use wildcards), and a name you will use to reference it.
:::note
In order for an ACME issuer to issue a wildcard certificate, you need to have a DNS01 challenge solver configured.
:::
After creating the cluster certificate, verify it is working by checking the Application Events created in the clusterissuer app (see how to verify a single app certificate is working for more information).
Using a cluster certificate
After you have verified the certificate was created successfully, edit the settings of the app you wish to use it for and go to the Ingress section.
If you have previously used a single domain certificate from clusterissuer, remove the specified issuer name. Then, click on Show Advanced Settings and add a TLS entry. Enter the name of your cluster certificate, and the certificate host(s) which it will be used for. These are usually the same as your app host(s), unless you wish to use more than one certificate. Save the chart.
:::note
In order for your cluster certificate to show up as valid, the certificate hosts it is used for must match the ones specified when creating it in the clusterissuer app settings. For example, in this case we configure the certificate host jellyfin.example.com, which matches the configured wildcard certificate host (*.example.com).
:::
