Skip to content

Commit 90a8b04

Browse files
committed
OSDOCS-13742: Double quoted <mode> in nw-ovn-ipsec-enable.adoc
1 parent 3f9f811 commit 90a8b04

File tree

1 file changed

+13
-18
lines changed

1 file changed

+13
-18
lines changed

modules/nw-ovn-ipsec-enable.adoc

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,17 @@
66
[id="nw-ovn-ipsec-enable_{context}"]
77
= Enabling IPsec encryption
88

9-
As a cluster administrator, you can enable pod-to-pod IPsec encryption and IPsec encryption between the cluster and external IPsec endpoints.
9+
As a cluster administrator, you can enable pod-to-pod IPsec encryption, IPsec encryption between the cluster, and external IPsec endpoints.
1010

1111
You can configure IPsec in either of the following modes:
1212

1313
- `Full`: Encryption for pod-to-pod and external traffic
1414
- `External`: Encryption for external traffic
1515
16-
If you need to configure encryption for external traffic in addition to pod-to-pod traffic, you must also complete the "Configuring IPsec encryption for external traffic" procedure.
16+
[NOTE]
17+
====
18+
If you configure IPsec in `Full` mode, you must also complete the "Configuring IPsec encryption for external traffic" procedure.
19+
====
1720

1821
.Prerequisites
1922

@@ -27,23 +30,19 @@ If you need to configure encryption for external traffic in addition to pod-to-p
2730
+
2831
[source,terminal]
2932
----
30-
$ oc patch networks.operator.openshift.io cluster --type=merge \
31-
-p '{
33+
$ oc patch networks.operator.openshift.io cluster --type=merge -p \
34+
'{
3235
"spec":{
3336
"defaultNetwork":{
3437
"ovnKubernetesConfig":{
3538
"ipsecConfig":{
36-
"mode":<mode>
39+
"mode":"<mode"> <1>
3740
}}}}}'
3841
----
3942
+
40-
where:
41-
+
42-
--
43-
`mode`:: Specify `External` to encrypt only traffic to external hosts or specify `Full` to encrypt pod to pod traffic and optionally traffic to external hosts. By default, IPsec is disabled.
44-
--
43+
<1> Specify `External` to encrypt traffic to external hosts or specify `Full` to encrypt pod-to-pod traffic and, optionally, traffic to external hosts. By default, IPsec is disabled.
4544

46-
. Optional: If you need to encrypt traffic to external hosts, complete the "Configuring IPsec encryption for external traffic" procedure.
45+
. Encrypt external traffic with IPsec by completing the "Configuring IPsec encryption for external traffic" procedure.
4746

4847
.Verification
4948

@@ -63,6 +62,7 @@ ovnkube-node-ck5fr 8/8 Running 0 31m
6362
ovnkube-node-fr4ld 8/8 Running 0 26m
6463
ovnkube-node-wgs4l 8/8 Running 0 33m
6564
ovnkube-node-zfvcl 8/8 Running 0 34m
65+
...
6666
----
6767

6868
. Verify that IPsec is enabled on your cluster by running the following command:
@@ -74,14 +74,9 @@ As a cluster administrator, you can verify that IPsec is enabled between pods on
7474
+
7575
[source,terminal]
7676
----
77-
$ oc -n openshift-ovn-kubernetes rsh ovnkube-node-<XXXXX> ovn-nbctl --no-leader-only get nb_global . ipsec
77+
$ oc -n openshift-ovn-kubernetes rsh ovnkube-node-<XXXXX> ovn-nbctl --no-leader-only get nb_global . ipsec <1>
7878
----
79-
+
80-
--
81-
where:
82-
83-
`<XXXXX>`:: Specifies the random sequence of letters for a pod from the previous step.
84-
--
79+
<1> Where `<XXXXX>` specifies the random sequence of letters for a pod from the previous step.
8580
+
8681
.Example output
8782
[source,text]

0 commit comments

Comments
 (0)