change name to clusterissuer, update screenshots (#9337)

**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.
-->
Updated clusterissuer how to documentation (copy of cert-manager
documentation) by renaming to clusterissuer where appropriate and
providing updated screenshots where needed.

⚒️ 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
-->
Reviewed at
https://truecharts-review.netlify.app/charts/enterprise/clusterissuer/docs/how-to

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

**✔️ 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._
This commit is contained in:
Malcolm 2023-06-03 12:17:12 +01:00 committed by GitHub
parent 3115f079ad
commit 30b6c364e7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 25 additions and 20 deletions

View File

@ -1,6 +1,6 @@
# Cert-Manager Setup Guide
# clusterissuer Setup Guide
This guide will walk you through setting up `cert-manager`, certificate management for Kubernetes.
This guide will walk you through setting up `clusterissuer`, certificate management for Kubernetes.
## Prerequisites
@ -8,11 +8,11 @@ Ensure you have the `enterprise` train enabled for `TrueCharts` as discussed [he
Ensure you have traefik installed, required for Ingress.
Search for cert-manager in the `Apps` menu | `Available Applications` tab and click **Install**.
Search for clusterissuer 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).
You can setup multiple domains with a single `clusterissuer` 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`.
@ -21,34 +21,39 @@ You can setup multiple domains with a single cert-manager app, all you have to d
- Optionally set Cloudflare API key (**not recommended**)
- Set the Cloudflare API Token to the one created earlier.
![cert-manager1](img/cert-manager1.png)
![clusterissuer edit dialog](img/clusterissuer1.png)
## cert-manager App
## clusterissuer App
> **Note**
>
> It is normal that the app does not run, there are no events, no logs and no shell. This is by design.
:::note
![cert-manager3](img/cert-manager3.png)
It is by design that the app does not run, there are no events, no logs and no shell.
## 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.
![clusterissuer app card](img/clusterissuer2.png)
## How to Add Ingress to Apps with clusterissuer
Here's an example on how to add ingress to an app with clusterissuer 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`.
:::warning
![cert-manager2](img/cert-manager2.png)
Do **NOT** use this combined with the `TLS-Settings`.
:::
![how to add ingress using clusterissuer ](img/clusterissuer3.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
## Verifying clusterissuer 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:
Once installed 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)
![clusterissuer4](img/clusterissuer4.png)
![clusterissuer5](img/clusterissuer5.png)
All is automated by `cert-manager`
All is automated by `clusterissuer`

Binary file not shown.

Before

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

View File

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

View File

Before

Width:  |  Height:  |  Size: 126 KiB

After

Width:  |  Height:  |  Size: 126 KiB

View File

Before

Width:  |  Height:  |  Size: 124 KiB

After

Width:  |  Height:  |  Size: 124 KiB