docs(cert-manager): Add How-To guide (#8084)

**Description**

Added docs for `cert-manager`, thanks to @xstar97 and @malcolmcdixon for
contributions to the doc also

⚒️ 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
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [X] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 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
- [ ] ⚠️ My changes generate no new warnings
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [X] ⬆️ 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._
This commit is contained in:
StevenMcElligott 2023-04-18 03:31:03 -04:00 committed by GitHub
parent 218793f454
commit 38b4b407f4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 52 additions and 0 deletions

View File

@ -0,0 +1,52 @@
# Cert-Manager Setup Guide
This guide will walk you through setting up `cert-manager`, certificate management for Kubernetes.
## Prerequisites
Ensure you have the `enterprise` train enabled for `TrueCharts` as discussed [here](https://truecharts.org/manual/SCALE/guides/getting-started/#adding-truecharts).
Search for cert-manager in the `Apps` menu | `Available Applications` tab and click **Install**.
## Cloudflare DNS-Provider
You can setup multiple domains with a single cert-manager app, all you have to do is either add the global API key (**not recommended**) or `Add` multiple `ACME Issuer` entries for each domain and create an API token for each at [Cloudflare API Tokens](https://dash.cloudflare.com/profile/api-tokens).
- Give the certificate a name (eg domain or "maincert", etc).
- Select the correct provider, for example `Cloudflare`.
- Set **Server** to **Letsencrypt-Production**.
- Set Email to the account email.
- Optionally set Cloudflare API key (**not recommended**)
- Set the Cloudflare API Token to the one created earlier.
![cert-manager1](img/cert-manager1.png)
## cert-manager App
> **Note**
>
> It is normal that the app does not run, there are no events, no logs and no shell. This is by design.
![cert-manager3](img/cert-manager3.png)
## How to Add Ingress to Apps with cert-manager
Here's an example on how to add ingress to an app with cert-manager for a single domain only.
Add the name of the `ACME Issuer` into `Cert-Manager clusterIssuer`
> **Warning**
> Do **NOT** use this combined with the `TLS-Settings`.
![cert-manager2](img/cert-manager2.png)
If you want to support multiple domains, use the `TLS-Settings` option to create each one, basically an extra step each time.
## Verifying cert-manager is working
Once install using the Ingress settings above, you can see the `Application Events` for the app in question to pull the certificate and issue the challenge directly. See the example below:
![cert-manager4](img/cert-manager4.png)
![cert-manager5](img/cert-manager5.png)
All is automated by `cert-manager`

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 126 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 124 KiB