Skip to content

Commit b4bde06

Browse files
snarayan-redhatsnarayan-redhat
authored
Merge pull request #68035 from snarayan-redhat/OSDOCS-8310_contentimprovement
OSDOCS#8310: cert-manager content improvement - Part 1
2 parents 331b9ae + b7f4672 commit b4bde06

19 files changed

+214
-93
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1114,22 +1114,16 @@ Topics:
11141114
File: cert-manager-operator-issuer-acme
11151115
- Name: Configuring certificates with an issuer
11161116
File: cert-manager-creating-certificate
1117-
- Name: Enabling monitoring for the cert-manager Operator for Red Hat OpenShift
1117+
- Name: Monitoring the cert-manager Operator for Red Hat OpenShift
11181118
File: cert-manager-monitoring
1119-
- Name: Configuring the egress proxy for the cert-manager Operator for Red Hat OpenShift
1119+
- Name: Configuring the egress proxy
11201120
File: cert-manager-operator-proxy
11211121
- Name: Customizing cert-manager by using the cert-manager Operator API fields
11221122
File: cert-manager-customizing-api-fields
1123-
- Name: Authenticating the cert-manager Operator with AWS Security Token Service
1124-
File: cert-manager-authenticate-aws
1123+
- Name: Authenticating the cert-manager Operator for Red Hat OpenShift
1124+
File: cert-manager-authenticate
11251125
- Name: Configuring log levels for cert-manager and the cert-manager Operator for Red Hat OpenShift
11261126
File: cert-manager-log-levels
1127-
- Name: Authenticating the cert-manager Operator for Red Hat OpenShift with GCP Workload Identity
1128-
File: cert-manager-authenticate-gcp
1129-
- Name: Authenticating the cert-manager Operator for Red Hat OpenShift on AWS
1130-
File: cert-manager-authentication-non-sts
1131-
- Name: Authenticating the cert-manager Operator for Red Hat OpenShift on GCP
1132-
File: cert-manager-authenticate-non-sts-gcp
11331127
- Name: Uninstalling the cert-manager Operator for Red Hat OpenShift
11341128
File: cert-manager-operator-uninstall
11351129
- Name: Viewing audit logs

‎modules/cert-manager-configure-cloud-credentials-aws-non-sts.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
// Module included in the following assemblies:
22
//
3-
// * security/cert_manager_operator/cert-manager-authenticate-aws.adoc
3+
// * security/cert_manager_operator/cert-manager-authenticate.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="cert-manager-configure-cloud-credentials-aws-non-sts_{context}"]
7-
= Configuring cloud credentials for the {cert-manager-operator} on AWS
8-
9-
To configure the cloud credentials for the {cert-manager-operator} on the AWS cluster you must generate the cloud credentials secret by creating a `CredentialsRequest` object, and allowing the Cloud Credential Operator.
7+
= Authenticating on AWS
108

119
.Prerequisites
1210

‎modules/cert-manager-configure-cloud-credentials-aws-sts.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
// Module included in the following assemblies:
22
//
3-
// * security/cert_manager_operator/cert-manager-authenticate-aws.adoc
3+
// * security/cert_manager_operator/cert-manager-authenticate.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="cert-manager-configure-cloud-credentials-aws-sts_{context}"]
7-
= Configuring cloud credentials for the {cert-manager-operator} for the AWS Security Token Service cluster
8-
9-
To configure the cloud credentials for the {cert-manager-operator} on the AWS Security Token Service (STS) cluster with the cloud credentials. You must generate the cloud credentials manually, and apply it on the cluster by using the `ccoctl` binary.
7+
= Authenticating with AWS Security Token Service
108

119
.Prerequisites
1210

‎modules/cert-manager-configure-cloud-credentials-gcp-non-sts.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
// Module included in the following assemblies:
22
//
3-
// * security/cert_manager_operator/cert-manager-authenticate-non-sts-gcp.adoc
3+
// * security/cert_manager_operator/cert-manager-authenticate.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="cert-manager-configure-cloud-credentials-gcp-non-sts_{context}"]
7-
= Configuring cloud credentials for the {cert-manager-operator} on GCP
8-
9-
To configure the cloud credentials for the {cert-manager-operator} on a GCP cluster you must create a `CredentialsRequest` object, and allow the Cloud Credential Operator to generate the cloud credentials secret.
7+
= Authenticating on GCP
108

119
.Prerequisites
1210

‎modules/cert-manager-configure-cloud-credentials-gcp-sts.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
// Module included in the following assemblies:
22
//
3-
// * security/cert_manager_operator/cert-manager-authenticate-gcp.adoc
3+
// * security/cert_manager_operator/cert-manager-authenticate.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="cert-manager-configure-cloud-credentials-gcp-sts_{context}"]
7-
= Configuring cloud credentials for the {cert-manager-operator} with GCP Workload Identity
8-
9-
Generate the cloud credentials for the {cert-manager-operator} by using the `ccoctl` binary. Then, apply them to the GCP Workload Identity cluster.
7+
= Authenticating with GCP Workload Identity
108

119
.Prerequisites
1210

‎modules/cert-manager-enable-operand-log-level.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ apiVersion: operator.openshift.io/v1alpha1
3030
kind: CertManager
3131
...
3232
spec:
33-
logLevel: Normal <1>
33+
logLevel: <log_level> <1>
3434
----
35-
<1> The default `logLevel` is `Normal`. Replace `Normal` with the desired log level value. The valid log level values for the `CertManager` resource are `Normal`, `Debug`, `Trace`, and `TraceAll`. To audit logs and perform common operations when everything is fine, set `logLevel` to `Normal` . To troubleshoot a minor issue by viewing verbose logs, set `logLevel` to `Debug` . To troubleshoot a major issue by viewing more verbose logs, you can set `logLevel` to `Trace`. To troubleshoot serious issues, set `logLevel` to `TraceAll`.
35+
<1> The valid log level values for the `CertManager` resource are `Normal`, `Debug`, `Trace`, and `TraceAll`. To audit logs and perform common operations when there are no issues, set `logLevel` to `Normal` . To troubleshoot a minor issue by viewing verbose logs, set `logLevel` to `Debug` . To troubleshoot a major issue by viewing more verbose logs, you can set `logLevel` to `Trace`. To troubleshoot serious issues, set `logLevel` to `TraceAll`. The default `logLevel` is `Normal`.
3636
+
3737
[NOTE]
3838
====

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

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/cert_manager_operator/cert-manager-operator-install.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="cert-manager-install-cli_{context}"]
7+
= Installing the {cert-manager-operator} by using the CLI
8+
9+
.Prerequisites
10+
11+
* You have access to the cluster with `cluster-admin` privileges.
12+
13+
.Procedure
14+
15+
. Create a new project named `cert-manager-operator` by running the following command:
16+
+
17+
[source, terminal]
18+
----
19+
$ oc new-project cert-manager-operator
20+
----
21+
22+
. Create an `OperatorGroup` object:
23+
24+
.. Create a YAML file, for example, `operatorGroup.yaml`, with the following content:
25+
+
26+
[source, yaml]
27+
----
28+
apiVersion: operators.coreos.com/v1
29+
kind: OperatorGroup
30+
metadata:
31+
name: openshift-cert-manager-operator
32+
namespace: cert-manager-operator
33+
spec:
34+
targetNamespaces:
35+
- "cert-manager-operator"
36+
----
37+
38+
.. Create the `OperatorGroup` object by running the following command:
39+
+
40+
[source, terminal]
41+
----
42+
$ oc create -f operatorGroup.yaml
43+
----
44+
45+
. Create a `Subscription` object:
46+
47+
.. Create a YAML file, for example, `subscription.yaml`, that defines the `Subscription` object:
48+
+
49+
[source, yaml]
50+
----
51+
apiVersion: operators.coreos.com/v1alpha1
52+
kind: Subscription
53+
metadata:
54+
name: openshift-cert-manager-operator
55+
namespace: cert-manager-operator
56+
spec:
57+
channel: stable-v1
58+
name: openshift-cert-manager-operator
59+
source: redhat-operators
60+
sourceNamespace: openshift-marketplace
61+
installPlanApproval: Automatic
62+
startingCSV: cert-manager-operator.v1.13.0
63+
----
64+
65+
.. Create the `Subscription` object by running the following command:
66+
+
67+
[source, terminal]
68+
----
69+
$ oc create -f subscription.yaml
70+
----
71+
72+
.Verification
73+
74+
. Verify that the OLM subscription is created by running the following command:
75+
+
76+
[source, terminal]
77+
----
78+
$ oc get subscription -n cert-manager-operator
79+
----
80+
+
81+
.Example output
82+
[source, terminal]
83+
----
84+
NAME PACKAGE SOURCE CHANNEL
85+
openshift-cert-manager-operator openshift-cert-manager-operator redhat-operators stable-v1
86+
----
87+
88+
. Verify whether the Operator is successfully installed by running the following command:
89+
+
90+
[source, terminal]
91+
----
92+
$ oc get csv -n cert-manager-operator
93+
----
94+
+
95+
.Example output
96+
[source, terminal]
97+
----
98+
NAME DISPLAY VERSION REPLACES PHASE
99+
cert-manager-operator.v1.13.0 cert-manager Operator for Red Hat OpenShift 1.13.0 cert-manager-operator.v1.12.1 Succeeded
100+
----
101+
102+
. Verify that the status {cert-manager-operator} is `Running` by running the following command:
103+
+
104+
[source, terminal]
105+
----
106+
$ oc get pods -n cert-manager-operator
107+
----
108+
+
109+
.Example output
110+
[source, terminal]
111+
----
112+
NAME READY STATUS RESTARTS AGE
113+
cert-manager-operator-controller-manager-695b4d46cb-r4hld 2/2 Running 0 7m4s
114+
----
115+
116+
. Verify that the status of cert-manager pods is `Running` by running the following command:
117+
+
118+
[source, terminal]
119+
----
120+
$ oc get pods -n cert-manager
121+
----
122+
+
123+
.Example output
124+
[source, terminal]
125+
----
126+
NAME READY STATUS RESTARTS AGE
127+
cert-manager-58b7f649c4-dp6l4 1/1 Running 0 7m1s
128+
cert-manager-cainjector-5565b8f897-gx25h 1/1 Running 0 7m37s
129+
cert-manager-webhook-9bc98cbdd-f972x 1/1 Running 0 7m40s
130+
----

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="cert-manager-install-console_{context}"]
7-
= Installing the {cert-manager-operator} using the web console
7+
= Installing the {cert-manager-operator} by using the web console
88

99
You can use the web console to install the {cert-manager-operator}.
1010

@@ -21,11 +21,13 @@ You can use the web console to install the {cert-manager-operator}.
2121

2222
. Enter *{cert-manager-operator}* into the filter box.
2323

24-
. Select the *{cert-manager-operator}* and click *Install*.
24+
. Select the *{cert-manager-operator}*
25+
26+
. Select the {cert-manager-operator} version from *Version* drop-down list, and click *Install*.
2527
+
2628
[NOTE]
2729
====
28-
From the {cert-manager-operator} `1.12.0` and later, the z-stream versions of the upstream cert-manager operands such as cert-manager controller, CA injector, Webhook, and {cert-manager-operator} are decoupled. For example, for the {cert-manager-operator} `1.12.0`, the cert-manager operand version is `v1.12.4`.
30+
See supported {cert-manager-operator} versions in the following "Additional resources" section.
2931
====
3032

3133
. On the *Install Operator* page:

‎modules/cert-manager-supported-versions.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+
// * security/cert_manager_operator/index.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="cert-manager-operator-supported-versions_{context}"]
7+
== Supported {cert-manager-operator} versions
8+
{product-title} {product-version} supports the following versions of {cert-manager-operator}:
9+
10+
* {cert-manager-operator} 1.13

‎security/cert_manager_operator/cert-manager-authenticate-aws.adoc

Lines changed: 0 additions & 16 deletions
This file was deleted.

0 commit comments

Comments
 (0)