Files
truecharts/charts/enterprise/cert-manager/docs/how-to.md
T
MalcolmandGitHub 8d53557d71 Add prerequisite (#8089)
**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.
-->
Added prerequisite to have traefik installed as it's required for
Ingress.

⚒️ Fixes  # <!--(issue)-->

**⚙️ 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
-->
N/A

**📃 Notes:**
<!-- Please enter any other relevant information here -->
Just helped a user setting up cert-manager and this situation arose.

**✔️ Checklist:**

- [ ] ⚖️ 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
- [ ] ⬆️ 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: Malcolm <56974882+malcolmcdixon@users.noreply.github.com>
2023-04-19 08:05:17 +02:00

2.1 KiB

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.

Ensure you have traefik installed, required for Ingress.

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.

  • 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

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

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

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 cert-manager5

All is automated by cert-manager