Skip to content

Commit 67114ea

Browse files
laubaibmcelvee
authored andcommitted
OSDOCS-9085: Adding attributes and IDs to custom domain tutorial
1 parent ec952d1 commit 67114ea

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

cloud_experts_tutorials/cloud-experts-rosa-osd-change-default-domain.adoc

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="cloud-experts-changing-domains-and-certificates-on-rosa-and-osd"]
2+
[id="cloud-experts-rosa-osd-change-default-domain"]
33
= Tutorial: Changing the Console, OAuth, and Downloads domains and TLS certificate on ROSA and OSD
44
include::_attributes/attributes-openshift-dedicated.adoc[]
5-
:context: cloud-experts-domains-and-certs
5+
:context: cloud-experts-rosa-osd-change-default-domain
66

77
toc::[]
88

@@ -25,12 +25,15 @@ toc::[]
2525
//Article text
2626
This guide demonstrates how to modify the Console, Downloads, OAuth domain, and TLS certificate keypair on Red Hat Openshift on AWS (ROSA) and Red Hat Openshift Dedicated (OSD) versions 4.14 and above. {fn-supported-versions}
2727

28+
////
2829
The changes that we make to the component routes {fn-term-component-routes} in this guide are described in greater detail in the following documentation:
2930

3031
* link:https://docs.openshift.com/container-platform/latest/authentication/configuring-internal-oauth.html#customizing-the-oauth-server-url_configuring-internal-oauth[Customizing the internal OAuth server URL]
3132
* link:https://docs.openshift.com/container-platform/latest/web_console/customizing-the-web-console.html#customizing-the-console-route_customizing-web-console[Customizing the console route]
3233
* link:https://docs.openshift.com/container-platform/latest/web_console/customizing-the-web-console.html#customizing-the-download-route_customizing-web-console[Customizing the download route]
34+
////
3335
36+
[id="prerequisites_{context}"]
3437
== Prerequisites
3538

3639
* ROSA CLI (`rosa`) version 1.2.27 or higher {fn-supported-cli}
@@ -40,6 +43,7 @@ The changes that we make to the component routes {fn-term-component-routes} in t
4043
* OpenSSL (for generating the demonstration SSL certificate), which can be downloaded and installed from link:https://www.openssl.org/source/[OpenSSL.org]
4144
* Access to the cluster as a user with the `cluster-admin` role.
4245

46+
[id="find-current-routes_{context}"]
4347
== Find the current routes
4448

4549
Before we make any configuration changes, we need to know the current routes in the cluster.
@@ -104,7 +108,8 @@ If we choose a new base domain of `my-new-domain.dev`, our new component routes
104108
* `downloads-openshift-console.my-new-domain.dev` for Downloads
105109
* `oauth-openshift.my-new-domain.dev` for OAuth
106110

107-
== Creating a valid TLS certificate for each component route
111+
[id="create-tls-certificate-for-routes_{context}"]
112+
== Create a valid TLS certificate for each component route
108113

109114
In this section, we create a self-signed certificate key pair and then trust it to verify that we can access our new component routes using a real web browser. This is for demonstration purposes only, and is not recommended as a solution for production workloads. Consult your certificate authority to understand how to create a certificate with similar attributes for your production workloads.
110115

@@ -136,7 +141,8 @@ $ openssl req -newkey rsa:2048 -new -nodes -x509 -days 365 -keyout key-my-new-do
136141

137142
This generates two `.pem` files, `key-my-new-domain.pem` and `cert-my-new-domain.pem`.
138143

139-
== Adding the certificate to the cluster as a secret
144+
[id="add-certificate-as-cluster-secret_{context}"]
145+
== Add the certificate to the cluster as a secret
140146

141147
. Log in to the cluster as a user with the `cluster-admin` role.
142148

@@ -149,6 +155,7 @@ This becomes your secret reference when you update the component routes later in
149155
$ oc create secret tls component-tls --cert=cert-my-new-domain.pem --key=key-my-new-domain.pem -n openshift-config
150156
----
151157

158+
[id="find-lb-hostname_{context}"]
152159
== Find the hostname of the load balancer in your cluster
153160

154161
When you create a cluster, ROSA and OSD create a load balancer and generate a hostname for that load balancer. We need to know the load balancer hostname in order to create DNS records for our cluster.
@@ -166,13 +173,15 @@ In our case, the hostname is `a234gsr3242rsfsfs-1342r624.us-east-1.elb.amazonaws
166173

167174
Save this value for later, as we will need it to configure DNS records for our new component route hostnames.
168175

176+
[id="add-routes-to-dns_{context}"]
169177
== Add component route DNS records to your hosting provider
170178

171179
In your hosting provider, add DNS records that map the `CNAME` of your new component route hostnames to the load balancer hostname we found in the previous step.
172180

173181
//.Need an image for this
174182
//image::[Picture goes here]
175183

184+
[id="update-routes-tls-using-rosa-cli_{context}"]
176185
== Update the component routes and TLS secret using the ROSA CLI
177186

178187
When your DNS records have been updated, you can use the ROSA CLI to change the component routes.

0 commit comments

Comments
 (0)