Skip to content

Commit 8adcd26

Browse files
committed
Replace callouts in LB guide with alternative wording (#4278)
(cherry picked from commit 3dee2a2)
1 parent cdc11ce commit 8adcd26

File tree

2 files changed

+59
-28
lines changed

2 files changed

+59
-28
lines changed

guides/common/modules/proc_creating-a-custom-ssl-certificate.adoc

Lines changed: 38 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -71,22 +71,29 @@ x509_extensions = usr_cert
7171
prompt = no
7272
7373
[ req_distinguished_name ]
74-
commonName = _{ssl-common-name}_ <1>
74+
commonName = _{ssl-common-name}_
7575
7676
[ v3_req ]
7777
basicConstraints = CA:FALSE
7878
keyUsage = digitalSignature, keyEncipherment
7979
extendedKeyUsage = serverAuth, clientAuth
8080
subjectAltName = @alt_names
8181
82-
[alt_names] <2>
82+
[alt_names]
8383
DNS.1 = _{loadbalancer-example-com}_
8484
DNS.2 = _{smartproxy-example-com}_
8585
----
86-
<1> The certificate's common name must match the FQDN of {SmartProxyServer}.
86+
+
87+
The options used in the configuration file include the following:
88+
+
89+
`commonName`::
90+
The certificate common name.
91+
It must match the FQDN of {SmartProxyServer}.
8792
Ensure to change this when running the command on each {SmartProxyServer} that you configure for load balancing.
8893
You can also set a wildcard value `*`.
89-
<2> Under `[alt_names]`, include the FQDN of the load balancer as `DNS.1` and the FQDN of {SmartProxyServer} as `DNS.2`.
94+
`[alt_names]`::
95+
The alternative names for the load balancer and {SmartProxyServer}.
96+
Include the FQDN of the load balancer as `DNS.1` and the FQDN of {SmartProxyServer} as `DNS.2`.
9097
endif::[]
9198
+
9299
For more information about the `[ v3_req ]` parameters and their purpose, see link:https://www.rfc-editor.org/rfc/rfc5280[RFC 5280: Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile].
@@ -96,28 +103,41 @@ For more information about the `[ v3_req ]` parameters and their purpose, see li
96103
----
97104
[req_distinguished_name]
98105
CN = _{ssl-common-name}_
99-
countryName = _My_Country_Name_ <1>
100-
stateOrProvinceName = _My_State_Or_Province_Name_ <2>
101-
localityName = _My_Locality_Name_ <3>
106+
countryName = _My_Country_Name_
107+
stateOrProvinceName = _My_State_Or_Province_Name_
108+
localityName = _My_Locality_Name_
102109
organizationName = _My_Organization_Or_Company_Name_
103-
organizationalUnitName = _My_Organizational_Unit_Name_ <4>
110+
organizationalUnitName = _My_Organizational_Unit_Name_
104111
----
105-
<1> Two letter code
106-
<2> Full name
107-
<3> Full name (example: New York)
108-
<4> Division responsible for the certificate (example: IT department)
112+
+
113+
The options used in the configuration file include the following:
114+
+
115+
`countryName`::
116+
The country represented by a two-letter code
117+
`stateOrProvinceName`::
118+
Full name of the state or province
119+
`localityName`::
120+
Full name of the locality (example: New York)
121+
`organizationalUnitName`::
122+
Division responsible for the certificate (example: IT department)
109123
. Generate CSR:
110124
+
111125
[options="nowrap", subs="+quotes,attributes"]
112126
----
113127
# openssl req -new \
114-
-key _/root/{cert-name}_cert/{cert-name}_cert_key.pem_ \ <1>
115-
-config _/root/{cert-name}_cert/openssl.cnf_ \ <2>
116-
-out _/root/{cert-name}_cert/{cert-name}_cert_csr.pem_ <3>
128+
-key _/root/{cert-name}_cert/{cert-name}_cert_key.pem_ \
129+
-config _/root/{cert-name}_cert/openssl.cnf_ \
130+
-out _/root/{cert-name}_cert/{cert-name}_cert_csr.pem_
117131
----
118-
<1> Path to the private key
119-
<2> Path to the configuration file
120-
<3> Path to the CSR to generate
132+
+
133+
The options used in the configuration file include the following:
134+
+
135+
`-key`::
136+
Path to the private key
137+
`-config`::
138+
Path to the configuration file
139+
`-out`::
140+
Path to the CSR to generate
121141
. Send the certificate signing request to the certificate authority (CA).
122142
The same CA must sign certificates for {ProjectServer} and {SmartProxyServer}.
123143
+

guides/common/modules/proc_registering-clients-using-the-bootstrap-script.adoc

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,24 @@ For more information, see {ManagingHostsDocURL}Registering_Hosts_by_Using_the_Bo
1818
----
1919
# /usr/libexec/platform-python bootstrap.py \
2020
--activationkey="_My_Activation_Key_" \
21-
--enablerepos={project-client-RHEL8-url} \ <1>
22-
--force \ <2>
21+
--enablerepos={project-client-RHEL8-url} \
22+
--force \
2323
--hostgroup="_My_Host_Group_" \
2424
--location="_My_Location_" \
2525
--login=_admin_ \
2626
--organization="_My_Organization_" \
27-
--puppet-ca-port 8141 \ <3>
27+
--puppet-ca-port 8141 \
2828
--server _{loadbalancer-example-com}_
2929
----
30-
<1> Replace `<arch>` with the client architecture, for example `x86`.
31-
<2> Include the `--force` option to register the client that has been previously registered to a standalone {SmartProxy}.
32-
<3> Include the `--puppet-ca-port 8141` option if you use Puppet.
30+
+
31+
The options used in the command include the following:
32+
+
33+
`enablerepos`::
34+
Replace `<arch>` with the client architecture, for example `x86`.
35+
`--force`::
36+
Include the `--force` option to register the client that has been previously registered to a standalone {SmartProxy}.
37+
`--puppet-ca-port`::
38+
Include the `--puppet-ca-port 8141` option if you use Puppet.
3339

3440
* On {EL} 7, enter the following command:
3541
+
@@ -38,14 +44,19 @@ For more information, see {ManagingHostsDocURL}Registering_Hosts_by_Using_the_Bo
3844
# python bootstrap.py --login=_admin_ \
3945
--activationkey="_My_Activation_Key_" \
4046
--enablerepos={project-client-RHEL7-url} \
41-
--force \ <1>
47+
--force \
4248
--hostgroup="_My_Host_Group_" \
4349
--location="_My_Location_" \
4450
--organization="_My_Organization_" \
45-
--puppet-ca-port 8141 \ <2>
51+
--puppet-ca-port 8141 \
4652
--server _{loadbalancer-example-com}_
4753
----
48-
<1> Include the `--force` option to register the client that has been previously registered to a standalone {SmartProxy}.
49-
<2> Include the `--puppet-ca-port 8141` option if you use Puppet.
54+
+
55+
The options used in the command include the following:
56+
+
57+
`--force`::
58+
Include the `--force` option to register the client that has been previously registered to a standalone {SmartProxy}.
59+
`--puppet-ca-port`::
60+
Include the `--puppet-ca-port 8141` option if you use Puppet.
5061
+
5162
The script prompts for the password corresponding to the {Project} user name you entered with the `--login` option.

0 commit comments

Comments
 (0)