Skip to content

Commit ee5f48d

Browse files
authored
Merge pull request #111698 from tmalove/OSDOCS-19442
OSDOCS#19442: Correct TLS configuration content - MicroShift
2 parents e8b8113 + f315ce8 commit ee5f48d

3 files changed

Lines changed: 30 additions & 7 deletions

File tree

microshift_configuring/microshift-ingress-controller.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ include::_attributes/attributes-microshift.adoc[]
77
toc::[]
88

99
[role="_abstract"]
10-
Use the ingress controller options in the {microshift-short} configuration file to make pods and services accessible outside the node.
10+
To make pods and services accessible outside the node, you must configure the ingress controller options in the {microshift-short} configuration file.
1111

1212
include::modules/microshift-ingress-controller-conc.adoc[leveloffset=+1]
1313

@@ -17,6 +17,11 @@ include::modules/microshift-ingress-control-config-fields.adoc[leveloffset=+2]
1717

1818
include::modules/microshift-ingress-controller-create-cert-secret.adoc[leveloffset=+2]
1919

20+
[role="_additional-resources"]
21+
.Additional resources
22+
23+
* xref:../microshift_networking/microshift-configuring-routes.adoc#nw-ingress-creating-a-route-via-an-ingress_microshift-configuring-routes[Creating a route through an Ingress object]
24+
2025
include::modules/microshift-ingress-controller-tls-config.adoc[leveloffset=+2]
2126

2227
[id="additional-resources_microshift-ingress-controller_{context}"]

modules/microshift-ingress-controller-create-cert-secret.adoc

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,27 @@
88
= Creating a secret for the ingress controller certificateSecret
99

1010
[role="_abstract"]
11-
To serve a custom default certificate through the ingress controller in {microshift-short}, you can create a TLS secret containing your certificate chain and private key, then set the `certificateSecret` value in the configuration file to that secret name.
11+
To secure network traffic with your own certificate, you must create a TLS secret and update the configuration file. This process configures a custom default certificate for the {microshift-short} ingress router.
1212

1313
[NOTE]
1414
====
15-
Any in-use certificates is automatically integrated with the {microshift-short} built-in OAuth server.
15+
Any in-use certificates automatically integrate with the {microshift-short} built-in OAuth server.
1616
====
1717

18+
To configure application-level certificates for a Kubernetes Ingress object by using the `spec.tls` field, follow the procedure in "Creating a route through an Ingress object".
19+
1820
.Prerequisites
1921

20-
* You have root access to {microshift-short}.
21-
* You installed the {oc-first}.
22-
* Your private key is not encrypted or you have decrypted it for importing into {microshift-short}.
22+
* Root access to the {microshift-short} host.
23+
* Installation of the {oc-first}.
24+
* A decrypted, non-password-protected TLS private key in Privacy-Enhanced Mail (PEM) format.
25+
* A PEM-encoded TLS certificate.
26+
* A valid certificate for the {microshift-short} apps wildcard where the `subjectAltName` extension includes DNS names covering `*.apps.<nodename>.<domain>`.
27+
28+
[NOTE]
29+
====
30+
This procedure only applies to the default ingress router certificate, `ingress.certificateSecret`.
31+
====
2332

2433
.Procedure
2534

@@ -44,7 +53,7 @@ The certificate must include the `subjectAltName` extension showing `*.apps.<nod
4453

4554
. Update the `certificateSecret` parameter value in the {microshift-short} configuration YAML with the newly created secret.
4655

47-
. Complete any other configurations you require, then start or restart {microshift-short} by running one the following commands:
56+
. Complete any other configurations you require, then start or restart {microshift-short} by running one of the following commands:
4857
+
4958
[source,terminal]
5059
----

modules/nw-ingress-creating-a-route-via-an-ingress.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,15 @@
1010
[role="_abstract"]
1111
To integrate ecosystem components that require Ingress resources, configure an Ingress object. {product-title} automatically manages the lifecycle of the corresponding route objects, creating and deleting them to ensure seamless connectivity.
1212

13+
.Prerequisites
14+
15+
* If clients must receive a full certificate chain, you must combine the PEM-encoded leaf certificate and intermediates into a single file. Place the leaf certificate first, followed by each issuer in chain order.
16+
* You confirmed the private key matches the leaf certificate in the `tls.crt` key.
17+
* You confirmed the `tls.key` key has only the private key for the leaf certificate.
18+
* The certificate Subject Alternative Name (SAN), or the subject CN if no SAN is present, covers every hostname set in `spec.rules[].host` and `spec.tls[].hosts`. These values must match for the same host.
19+
* The private key is not password-encrypted. You must decrypt the key before you create the TLS secret so that {product-title} can read the key material.
20+
* You created a `Secret` of type `kubernetes.io/tls` in the same namespace as the `Ingress`. The `secretName` must match the `spec.tls[].secretName` field. If you have not created the secret, you must do so before you apply the `Ingress` object.
21+
1322
.Procedure
1423

1524
. Define an Ingress object in the {product-title} console or by entering the `oc create` command:

0 commit comments

Comments
 (0)