Skip to content

Commit 7206fa2

Browse files
ShaunaDiazShaunaDiaz
authored
Merge pull request #97364 from tmalove/ms-osdocs-14883-tlove
OSDOCS#14883: Add MicroShift certificate manager information
2 parents 6c3ef83 + 644e487 commit 7206fa2

File tree

5 files changed

+122
-0
lines changed

5 files changed

+122
-0
lines changed

‎_topic_maps/_topic_map_ms.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,8 @@ Topics:
227227
File: microshift-applications
228228
- Name: Deleting or updating Kustomize manifest resources
229229
File: microshift-deleting-resource-manifests
230+
- Name: Using MicroShift certificate manager
231+
File: microshift-cert-manager
230232
- Name: Configuring Observability
231233
File: microshift-observability-service
232234
- Name: Embedding applications on RHEL for Edge

‎microshift_running_apps/microshift-cert-manager.adoc‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="microshift-cert-manager"]
3+
= Using certificate manager on a {microshift-short} node
4+
include::_attributes/attributes-microshift.adoc[]
5+
:context: microshift-cert-manager
6+
7+
toc::[]
8+
9+
[role="_abstract"]
10+
The {microshift-short} certificate manager supports managing TLS certificates. This integration results in the issue, renewal, and management of certificate from certificate authorities.
11+
12+
include::modules/microshift-cert-manager-tasks.adoc[leveloffset=+1]
13+
14+
include::modules/microshift-install-cert-manager.adoc[leveloffset=+1]
15+
16+
include::modules/microshift-install-cert-manager-olm.adoc[leveloffset=+1]

‎modules/microshift-cert-manager-tasks.adoc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * microshift_running_apps/microshift-cert-manager.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="microshift-cert-manager-tasks_{context}"]
7+
= {microshift-short} certificate manager functions
8+
9+
[role="_abstract"]
10+
With {microshift-short} certificate manager, you can complete the following tasks:
11+
12+
* Automates certificate management: cert-manager creates or updates certificates and detects Kubernetes resources that are annotated with `cert-manager.io/kind`.
13+
* Supports multiple CAs: provides flexibility to select one that fits the security and operational needs.
14+
* Simplifies ingress certificates: cert-manager handles certificates for an ingress controller, which simplifies the configuration and management of secure communication channels.
15+
* Enhances security: certificate management is automated and the risk of error is reduced. Certificates are current and valid, which contribute to a secure environment.

‎modules/microshift-install-cert-manager-olm.adoc‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// Module included in the following assemblies:
2+
//
3+
// microshift_running_apps/microshift-cert-manager.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="microshift-install-cert-manager-olm_{context}"]
7+
= Installing and enabling the cert-manager Operator using OLM
8+
9+
[role="_abstract"]
10+
You can install the optional `microshift-cert-manager` by using OLM at any time. For more information, see link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/{ocp-version}/html/running_applications/operators#microshift-operators-olm[Using Operator Lifecycle Manager with MicroShift] and link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/security_and_compliance/cert-manager-operator-for-red-hat-openshift#cert-manager-operator-install[Installing the cert-manager Operator for Red Hat OpenShift].

‎modules/microshift-install-cert-manager.adoc‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
// Module included in the following assemblies:
2+
//
3+
// microshift_running_apps/microshift-cert-manager.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="microshift-install-cert-manager_{context}"]
7+
= Installing and enabling the cert-manager Operator using RPM
8+
9+
[role="_abstract"]
10+
The microshift-cert-manager RPM is an optional component that can be installed at any time. Follow these steps to install and verify the certificate manager:
11+
12+
.Procedure
13+
14+
. Install the `cert-manager-operator` using the `microshift-cert-manager` RPM by running the following command:
15+
+
16+
[source,terminal]
17+
----
18+
$ sudo dnf install microshift-cert-manager
19+
----
20+
21+
. Verify the certificate manager versions that are used by running the following command:
22+
+
23+
[source,terminal]
24+
----
25+
$ rpm -qi microshift-cert-manager
26+
----
27+
28+
. Restart {microshift-short} by running the following command:
29+
+
30+
[source,terminal]
31+
----
32+
$ systemctl microshift restart
33+
----
34+
35+
. Verify that the `microshift-cert-manager` RPM is installed by running the following command:
36+
+
37+
[source,terminal]
38+
----
39+
$ oc get deployment -n cert-manager-operator
40+
----
41+
+
42+
.Example output
43+
[source,terminal]
44+
----
45+
NAME READY UP-TO-DATE AVAILABLE AGE
46+
cert-manager-operator-controller-manager 1/1 1 1 2d22h
47+
----
48+
49+
. Verify that the`cert-manager` deployments are in a ready state and are up-to-date in the cert-manager namespace by running the following command:
50+
+
51+
[source,terminal]
52+
----
53+
$ oc get deployment -n cert-manager
54+
----
55+
+
56+
.Example output
57+
[source,terminal]
58+
----
59+
NAME READY UP-TO-DATE AVAILABLE AGE
60+
cert-manager 1/1 1 1 2d22h
61+
cert-manager-cainjector 1/1 1 1 2d22h
62+
cert-manager-webhook 1/1 1 1 2d22h
63+
----
64+
65+
. Verify that the pods are running in the `cert-manager` namespace by running the following command:
66+
+
67+
[source,terminal]
68+
----
69+
$ oc get pods -n cert-manager
70+
----
71+
+
72+
.Example output
73+
[source,terminal]
74+
----
75+
NAME READY STATUS RESTARTS AGE
76+
cert-manager-7cfb4fbb84-qdmk8 1/1 Running 2 2d22h
77+
cert-manager-cainjector-854f669657-xzs8b 1/1 Running 2 2d22h
78+
cert-manager-webhook-68fd6d5f5c-j942h 1/1 Running 2 2d22h
79+
----

0 commit comments

Comments
 (0)