Skip to content

Commit 37b9e84

Browse files
authored
Merge pull request #110365 from openshift/revert-105199-OSDOCS-16863-5-18
Revert "[enterprise-4.18] OSDOCS-16863-5: CQA for MetalLB Ingress and Route"
2 parents f80f0ea + 2f8a187 commit 37b9e84

10 files changed

Lines changed: 120 additions & 157 deletions

modules/challenges-of-managing-symmetric-routing-with-metallb.adoc

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

modules/nw-ingress-creating-a-passthrough-route.adoc

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@
66
[id="nw-ingress-creating-a-passthrough-route_{context}"]
77
= Creating a passthrough route
88

9-
[role="_abstract"]
10-
To send encrypted traffic directly to the destination without decryption at the router, configure a route with passthrough termination by running the `oc create route` command. This configuration requires no key or certificate on the route, as the destination pod handles TLS termination.
9+
You can configure a secure route using passthrough termination by using the `oc create route` command. With passthrough termination, encrypted traffic is sent straight to the destination without the router providing TLS termination. Therefore no key or certificate is required on the route.
1110

1211
.Prerequisites
1312

@@ -30,23 +29,21 @@ If you examine the resulting `Route` resource, it should look similar to the fol
3029
apiVersion: route.openshift.io/v1
3130
kind: Route
3231
metadata:
33-
name: route-passthrough-secured
32+
name: route-passthrough-secured <1>
3433
spec:
3534
host: www.example.com
3635
port:
3736
targetPort: 8080
3837
tls:
39-
termination: passthrough
40-
insecureEdgeTerminationPolicy: None
38+
termination: passthrough <2>
39+
insecureEdgeTerminationPolicy: None <3>
4140
to:
4241
kind: Service
4342
name: frontend
4443
----
44+
<1> The name of the object, which is limited to 63 characters.
45+
<2> The `*termination*` field is set to `passthrough`. This is the only required `tls` field.
46+
<3> Optional `insecureEdgeTerminationPolicy`. The only valid values are `None`, `Redirect`, or empty for disabled.
4547
+
46-
where:
47-
+
48-
`metadata.name`:: Specifies the name of the object, which is limited to 63 characters.
49-
`tls.termination`:: Specifies the `termination` field is set to `passthrough`. This is the only required `tls` field.
50-
`tls.insecureEdgeTerminationPolicy`:: Specifies the type of edge termination policy. Optional parameter. The only valid values are `None`, `Redirect`, or empty for disabled.
51-
+
52-
The destination pod is responsible for serving certificates for the traffic at the endpoint. This is currently the only method that can support requiring client certificates, also known as two-way authentication.
48+
The destination pod is responsible for serving certificates for the
49+
traffic at the endpoint. This is currently the only method that can support requiring client certificates, also known as two-way authentication.

modules/nw-ingress-creating-a-reencrypt-route-with-a-custom-certificate.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
[id="nw-ingress-creating-a-reencrypt-route-with-a-custom-certificate_{context}"]
77
= Creating a re-encrypt route with a custom certificate
88

9-
[role="_abstract"]
10-
To secure traffic by using a custom certificate, configure a route with re-encrypt TLS termination by running the `oc create route` command. This configuration enables the Ingress Controller to decrypt traffic, and then re-encrypt traffic before forwarding the traffic to the destination pod.
9+
You can configure a secure route using reencrypt TLS termination with a custom
10+
certificate by using the `oc create route` command.
1111

1212
.Prerequisites
1313

@@ -52,7 +52,8 @@ certificate:
5252
$ oc create route reencrypt --service=frontend --cert=tls.crt --key=tls.key --dest-ca-cert=destca.crt --ca-cert=ca.crt --hostname=www.example.com
5353
----
5454
+
55-
If you examine the resulting `Route` resource, the resource should have a configuration similar to the following example:
55+
If you examine the resulting `Route` resource, it should look similar to the
56+
following:
5657
+
5758
.YAML Definition of the Secure Route
5859
[source,yaml]
@@ -84,7 +85,6 @@ spec:
8485
-----BEGIN CERTIFICATE-----
8586
[...]
8687
-----END CERTIFICATE-----
87-
# ...
8888
----
8989
+
9090
See `oc create route reencrypt --help` for more options.

modules/nw-ingress-creating-an-edge-route-with-a-custom-certificate.adoc

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,11 @@
66
[id="nw-ingress-creating-an-edge-route-with-a-custom-certificate_{context}"]
77
= Creating an edge route with a custom certificate
88

9-
[role="_abstract"]
10-
To secure traffic by using a custom certificate, configure a route with edge TLS termination by running the `oc create route` command. This configuration terminates encryption at the Ingress Controller before forwarding traffic to the destination pod.
11-
12-
The route specifies the TLS certificate and key that the Ingress Controller uses for the route.
9+
You can configure a secure route using edge TLS termination with a custom
10+
certificate by using the `oc create route` command. With an edge route, the
11+
Ingress Controller terminates TLS encryption before forwarding traffic to the
12+
destination pod. The route specifies the TLS certificate and key that the
13+
Ingress Controller uses for the route.
1314

1415
.Prerequisites
1516

@@ -19,6 +20,8 @@ is valid for the route host.
1920
* You may have a separate CA certificate in a PEM-encoded file that completes
2021
the certificate chain.
2122
23+
* You must have a service that you want to expose.
24+
2225
[NOTE]
2326
====
2427
Password protected key files are not supported. To remove a passphrase from a
@@ -47,7 +50,8 @@ for `frontend`. Substitute the appropriate hostname for `www.example.com`.
4750
$ oc create route edge --service=frontend --cert=tls.crt --key=tls.key --ca-cert=ca.crt --hostname=www.example.com
4851
----
4952
+
50-
If you examine the resulting `Route` resource, the resource should have a configuration similar to the following example:
53+
If you examine the resulting `Route` resource, it should look similar to the
54+
following:
5155
+
5256
.YAML Definition of the Secure Route
5357
[source,yaml]
@@ -75,7 +79,6 @@ spec:
7579
-----BEGIN CERTIFICATE-----
7680
[...]
7781
-----END CERTIFICATE-----
78-
# ...
7982
----
8083
+
8184
See `oc create route edge --help` for more options.

modules/nw-metallb-community-cr.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,14 @@
66
[id="nw-metallb-community-cr_{context}"]
77
= About the community custom resource
88

9-
[role="_abstract"]
10-
To simplify BGP configuration, define named aliases for community values by using the community custom resource. You can reference these aliases when advertising `ipAddressPools` with the `BGPAdvertisement` resource.
11-
12-
The fields for the `community` custom resource are described in the following table.
9+
The `community` custom resource is a collection of aliases for communities. Users can define named aliases to be used when advertising `ipAddressPools` using the `BGPAdvertisement`. The fields for the `community` custom resource are described in the following table.
1310

1411
[NOTE]
1512
====
1613
The `community` CRD applies only to BGPAdvertisement.
1714
====
1815

16+
1917
.MetalLB community custom resource
2018
[cols="1,1,3a", options="header"]
2119
|===

modules/nw-metallb-configure-community-bgp-advertisement.adoc

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,21 @@
66
[id="nw-metallb-configure-BGP-advertisement-community-alias_{context}"]
77
= Configuring MetalLB with a BGP advertisement and community alias
88

9-
[role="_abstract"]
10-
To advertise an `IPAddressPool` by using the BGP protocol, configure MetalLB with a community alias. This configuration sets the alias to the numeric value of the `NO_ADVERTISE` community.
9+
Configure MetalLB as follows so that the `IPAddressPool` is advertised with the BGP protocol and the community alias set to the numeric value of the NO_ADVERTISE community.
1110

1211
In the following example, the peer BGP router `doc-example-peer-community` receives one `203.0.113.200/32` route and one `fc00:f853:ccd:e799::1/128` route for each load-balancer IP address that MetalLB assigns to a service. A community alias is configured with the `NO_ADVERTISE` community.
1312

1413
.Prerequisites
1514

16-
* Install the {oc-first}
15+
* Install the OpenShift CLI (`oc`).
16+
1717
* Log in as a user with `cluster-admin` privileges.
1818
19+
1920
.Procedure
2021

2122
. Create an IP address pool.
22-
+
23+
2324
.. Create a file, such as `ipaddresspool.yaml`, with content like the following example:
2425
+
2526
[source,yaml]
@@ -34,7 +35,7 @@ spec:
3435
- 203.0.113.200/30
3536
- fc00:f853:ccd:e799::/124
3637
----
37-
+
38+
3839
.. Apply the configuration for the IP address pool:
3940
+
4041
[source,terminal]
@@ -58,7 +59,7 @@ spec:
5859
----
5960

6061
. Create a BGP peer named `doc-example-bgp-peer`.
61-
+
62+
6263
.. Create a file, such as `bgppeer.yaml`, with content like the following example:
6364
+
6465
[source,yaml]
@@ -74,7 +75,7 @@ spec:
7475
myASN: 64500
7576
routerID: 10.10.10.10
7677
----
77-
+
78+
7879
.. Apply the configuration for the BGP peer:
7980
+
8081
[source,terminal]
@@ -83,7 +84,7 @@ $ oc apply -f bgppeer.yaml
8384
----
8485

8586
. Create a BGP advertisement with the community alias.
86-
+
87+
8788
.. Create a file, such as `bgpadvertisement.yaml`, with content like the following example:
8889
+
8990
[source,yaml]
@@ -104,10 +105,8 @@ spec:
104105
- doc-example-peer
105106
----
106107
+
107-
where:
108-
+
109-
`NO_ADVERTISE`: Specifies the `CommunityAlias.name` here and not the community custom resource (CR) name.
110-
+
108+
<1> Specify the `CommunityAlias.name` here and not the community custom resource (CR) name.
109+
111110
.. Apply the configuration:
112111
+
113112
[source,terminal]

0 commit comments

Comments
 (0)