Skip to content

Commit 7f12144

Browse files
bergerhofferbergerhoffer
committed
OSDOCS-3142: Adding docs for cert-manager
1 parent b0326aa commit 7f12144

15 files changed

+268
-1
lines changed

‎_attributes/common-attributes.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ endif::[]
3535
:sandboxed-containers-operator: OpenShift sandboxed containers Operator
3636
:sandboxed-containers-version: 1.1
3737
:sandboxed-containers-legacy-version: 1.0.2
38+
:cert-manager-operator: cert-manager Operator for Red Hat OpenShift
3839
:rh-virtualization-first: Red Hat Virtualization (RHV)
3940
:rh-virtualization: RHV
4041
:rh-virtualization-engine-name: Manager

‎_topic_maps/_topic_map.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -840,6 +840,19 @@ Topics:
840840
File: file-integrity-operator-advanced-usage
841841
- Name: Troubleshooting the File Integrity Operator
842842
File: file-integrity-operator-troubleshooting
843+
- Name: cert-manager Operator for Red Hat OpenShift
844+
Dir: cert_manager_operator
845+
Distros: openshift-enterprise
846+
Topics:
847+
- Name: cert-manager Operator for Red Hat OpenShift overview
848+
File: index
849+
- Name: cert-manager Operator for Red Hat OpenShift release notes
850+
File: cert-manager-operator-release-notes
851+
- Name: Installing the cert-manager Operator for Red Hat OpenShift
852+
File: cert-manager-operator-install
853+
# For GA release, add details here on requesting certificates, etc.
854+
- Name: Uninstalling the cert-manager Operator for Red Hat OpenShift
855+
File: cert-manager-operator-uninstall
843856
- Name: Viewing audit logs
844857
File: audit-log-view
845858
- Name: Configuring the audit log policy

‎modules/cert-manager-about.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/cert_manager_operator/index.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="cert-manager-about_{context}"]
7+
= About the {cert-manager-operator}
8+
9+
The link:https://cert-manager.io/[cert-manager] project introduces certificate authorities and certificates as resource types in the Kubernetes API, which makes it possible to provide certificates on demand to developers working within your cluster. The {cert-manager-operator} provides a supported way to integrate cert-manager into your {product-title} cluster.
10+
11+
The {cert-manager-operator} provides the following features:
12+
13+
* Support for integrating with external certificate authorities
14+
* Tools to manage certificates
15+
* Ability for developers to self-serve certificates
16+
* Automatic certificate renewal
17+
18+
[IMPORTANT]
19+
====
20+
Do not attempt to use more than one cert-manager Operator in your cluster. If you have a community cert-manager Operator installed in your cluster, you must uninstall it before installing the {cert-manager-operator}.
21+
====

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

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/cert_manager_operator/cert-manager-operator-install.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="cert-manager-install-console_{context}"]
7+
= Installing the {cert-manager-operator} using the web console
8+
9+
You can use the web console to install the {cert-manager-operator}.
10+
11+
.Prerequisites
12+
13+
* You have access to the cluster with `cluster-admin` privileges.
14+
* You have access to the {product-title} web console.
15+
16+
.Procedure
17+
18+
. Log in to the {product-title} web console.
19+
20+
. Navigate to *Operators* -> *OperatorHub*.
21+
22+
. Enter *{cert-manager-operator}* into the filter box.
23+
24+
. Select the *{cert-manager-operator}* and click *Install*.
25+
26+
. On the *Install Operator* page:
27+
.. The *Update channel* is set to *tech-preview*, which installs the latest Technology Preview release of the {cert-manager-operator}.
28+
.. The *Installation Mode* is set to *All namespaces on the cluster (default)*. This mode installs the Operator in the Operator-recommended `openshift-cert-manager-operator` namespace to watch and be made available to all namespaces in the cluster.
29+
.. Choose the *Installed Namespace* for the Operator. The default Operator recommended namespace is `openshift-cert-manager-operator`.
30+
+
31+
If the `openshift-cert-manager-operator` namespace does not exist, it is created for you.
32+
.. Click the *Enable Operator recommended cluster monitoring on the Namespace* checkbox to enable cluster monitoring for the Operator.
33+
.. Select an *Update approval* strategy.
34+
+
35+
* The *Automatic* strategy allows Operator Lifecycle Manager (OLM) to automatically update the Operator when a new version is available.
36+
+
37+
* The *Manual* strategy requires a user with appropriate credentials to approve the Operator update.
38+
39+
.. Click *Install*.
40+
41+
.Verification
42+
43+
. Navigate to *Operators* -> *Installed Operators*.
44+
. Verify that *{cert-manager-operator}* is listed with a *Status* of *Succeeded*.

‎modules/cert-manager-remove-resources-console.adoc

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/cert-manager-operator-uninstall.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="cert-manager-remove-resources-console_{context}"]
7+
= Removing {cert-manager-operator} resources
8+
9+
Optionally, after uninstalling the {cert-manager-operator}, you can remove its related resources from your cluster.
10+
11+
.Prerequisites
12+
13+
* You have access to the cluster with `cluster-admin` privileges.
14+
* You have access to the {product-title} web console.
15+
16+
.Procedure
17+
18+
. Log in to the {product-title} web console.
19+
20+
. Remove CRDs that were installed by the {cert-manager-operator}:
21+
22+
.. Navigate to *Administration* -> *CustomResourceDefinitions*.
23+
24+
.. Enter `certmanager` in the *Name* field to filter the CRDs.
25+
26+
.. Click the Options menu {kebab} next to each of the following CRDs, and select *Delete Custom Resource Definition*:
27+
28+
*** `Certificate`
29+
*** `CertificateRequest`
30+
*** `CertManager` (`config.openshift.io`)
31+
*** `CertManager` (`operator.openshift.io`)
32+
*** `Challenge`
33+
*** `ClusterIssuer`
34+
*** `Issuer`
35+
*** `Order`
36+
37+
. Remove the `openshift-cert-manager-operator` namespace.
38+
.. Navigate to *Administration* -> *Namespaces*.
39+
.. Click the Options menu {kebab} next to the *openshift-cert-manager-operator* and select *Delete Namespace*.
40+
.. In the confirmation dialog, enter `openshift-cert-manager-operator` in the field and click *Delete*.

‎modules/cert-manager-request-methods.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/cert_manager_operator/index.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="cert-manager-request-methods_{context}"]
7+
= Certificate request methods
8+
9+
There are two ways to request a certificate using the {cert-manager-operator}:
10+
11+
Using the `cert-manager.io/CertificateRequest` object:: With this method a service developer creates a `CertificateRequest` object with a valid `issuerRef` pointing to a configured issuer (configured by a service infrastructure administrator). A service infrastructure administrator then accepts or denies the certificate request. Only accepted certificate requests create a corresponding certificate.
12+
13+
Using the `cert-manager.io/Certificate` object:: With this method, a service developer creates a `Certificate` object with a valid `issuerRef` and obtains a certificate from a secret that they pointed to the `Certificate` object.

‎modules/cert-manager-uninstall-console.adoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/cert_manager_operator/cert-manager-operator-uninstall.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="cert-manager-uninstall-console_{context}"]
7+
= Uninstalling the {cert-manager-operator}
8+
9+
You can uninstall the {cert-manager-operator} by using the web console.
10+
11+
.Prerequisites
12+
13+
* You have access to the cluster with `cluster-admin` privileges.
14+
* You have access to the {product-title} web console.
15+
* The {cert-manager-operator} is installed.
16+
// TODO: Any other prereqs, like removing anything that is using it?
17+
18+
.Procedure
19+
20+
. Log in to the {product-title} web console.
21+
. Uninstall the {cert-manager-operator} Operator.
22+
.. Navigate to *Operators* -> *Installed Operators*.
23+
.. Click the Options menu {kebab} next to the *{cert-manager-operator}* entry and click *Uninstall Operator*.
24+
.. In the confirmation dialog, click *Uninstall*.

‎modules/nodes-descheduler-uninstalling.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ You can remove the descheduler from your cluster by removing the descheduler ins
2222
.. Click the Options menu {kebab} next to the *cluster* entry and select *Delete KubeDescheduler*.
2323
.. In the confirmation dialog, click *Delete*.
2424
. Uninstall the Kube Descheduler Operator.
25-
.. Navigate to *Operators* -> *Installed Operators*,
25+
.. Navigate to *Operators* -> *Installed Operators*.
2626
.. Click the Options menu {kebab} next to the *Kube Descheduler Operator* entry and select *Uninstall Operator*.
2727
.. In the confirmation dialog, click *Uninstall*.
2828
. Delete the `openshift-kube-descheduler-operator` namespace.

‎security/cert_manager_operator/cert-manager-operator-install.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
:_content-type: ASSEMBLY
2+
[id="cert-manager-operator-install"]
3+
= Installing the {cert-manager-operator}
4+
include::_attributes/common-attributes.adoc[]
5+
:context: cert-manager-operator-install
6+
7+
toc::[]
8+
9+
The {cert-manager-operator} is not installed in {product-title} by default. You can install the {cert-manager-operator} by using the web console.
10+
11+
:FeatureName: The {cert-manager-operator}
12+
include::snippets/technology-preview.adoc[leveloffset=+1]
13+
14+
// Installing the {cert-manager-operator} using the web console
15+
include::modules/cert-manager-install-console.adoc[leveloffset=+1]
16+
17+
[role="_additional-resources"]
18+
[id="cert-manager-operator-install_additional-resources"]
19+
== Additional resources
20+
21+
* xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[Adding Operators to a cluster]

‎security/cert_manager_operator/cert-manager-operator-release-notes.adoc

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
:_content-type: ASSEMBLY
2+
[id="cert-manager-operator-release-notes"]
3+
= {cert-manager-operator} release notes
4+
include::_attributes/common-attributes.adoc[]
5+
:context: cert-manager-operator-release-notes
6+
7+
toc::[]
8+
9+
The {cert-manager-operator} is a cluster-wide service that provides application certificate lifecycle management.
10+
11+
These release notes track the development of {cert-manager-operator}.
12+
13+
:FeatureName: The {cert-manager-operator}
14+
include::snippets/technology-preview.adoc[leveloffset=+1]
15+
16+
For more information, see xref:../../security/cert_manager_operator/index.adoc#cert-manager-operator-about[About the {cert-manager-operator}].
17+
18+
[id="cert-manager-operator-release-notes-1.7.1-1"]
19+
== Release notes for {cert-manager-operator} 1.7.1-1 (Technology Preview)
20+
21+
Issued: 2022-04-11
22+
23+
The following advisory is available for the {cert-manager-operator} 1.7.1-1:
24+
25+
* link:https://access.redhat.com/errata/RHEA-2022:1273[RHEA-2022:1273]
26+
27+
For more information, see the link:https://cert-manager.io/docs/release-notes/release-notes-1.7/#v1-7-1[cert-manager project release notes for v1.7.1].
28+
29+
[id="cert-manager-operator-1.7.1-1-new-features-and-enhancements"]
30+
=== New features and enhancements
31+
32+
* This is the initial, Technology Preview release of the {cert-manager-operator}.
33+
34+
////
35+
// No bug fixes in the initial release
36+
[id="cert-manager-operator-1.7.1-1-bug-fixes"]
37+
=== Bug fixes
38+
39+
* TODO
40+
////
41+
42+
[id="cert-manager-operator-1.7.1-1-known-issues"]
43+
=== Known issues
44+
45+
* Using `Route` objects is not fully supported. Currently, {cert-manager-operator} integrates with `Route` objects by creating `Ingress` objects through the Ingress Controller. (link:https://issues.redhat.com/projects/CM/issues/CM-16[*CM-16*])

‎security/cert_manager_operator/cert-manager-operator-uninstall.adoc

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:_content-type: ASSEMBLY
2+
[id="cert-manager-operator-uninstall"]
3+
= Uninstalling the {cert-manager-operator}
4+
include::_attributes/common-attributes.adoc[]
5+
:context: cert-manager-operator-uninstall
6+
7+
toc::[]
8+
9+
You can remove the {cert-manager-operator} from {product-title} by uninstalling the Operator and removing its related resources.
10+
11+
:FeatureName: The {cert-manager-operator}
12+
include::snippets/technology-preview.adoc[leveloffset=+1]
13+
14+
// Uninstalling the {cert-manager-operator}
15+
include::modules/cert-manager-uninstall-console.adoc[leveloffset=+1]
16+
17+
// Removing {cert-manager-operator} resources
18+
include::modules/cert-manager-remove-resources-console.adoc[leveloffset=+1]

‎security/cert_manager_operator/images

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../images/

‎security/cert_manager_operator/index.adoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
:_content-type: ASSEMBLY
2+
[id="cert-manager-operator-about"]
3+
= {cert-manager-operator} overview
4+
include::_attributes/common-attributes.adoc[]
5+
:context: cert-manager-operator-about
6+
7+
toc::[]
8+
9+
The {cert-manager-operator} is a cluster-wide service that provides application certificate lifecycle management. The {cert-manager-operator} allows you to integrate with external certificate authorities and provides certificate provisioning, renewal, and retirement.
10+
11+
:FeatureName: The {cert-manager-operator}
12+
include::snippets/technology-preview.adoc[leveloffset=+1]
13+
14+
// About the {cert-manager-operator}
15+
include::modules/cert-manager-about.adoc[leveloffset=+1]
16+
17+
// Certificate request methods
18+
include::modules/cert-manager-request-methods.adoc[leveloffset=+1]
19+
20+
[role="_additional-resources"]
21+
[id="cert-manager-operator-about_additional-resources"]
22+
== Additional resources
23+
24+
* link:https://cert-manager.io/docs/[cert-manager project documentation]

‎security/cert_manager_operator/modules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../modules/

‎security/cert_manager_operator/snippets

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../snippets/

0 commit comments

Comments
 (0)