Skip to content

Commit f06c1c5

Browse files
committed
fix markdownlint err
Signed-off-by: aicee <hhbin2000@foxmail.com>
1 parent 0188b2b commit f06c1c5

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

content/en/docs/userguide/use_IPsec_in_Kmesh_cluster.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ IPsec is a mature and widely used encryption method for inter-node communication
1717

1818
### How to enable IPsec in Kmesh
1919

20-
**Step 1: Generate an IPsec pre-shared key for Kmesh before starting Kmesh. Currently, only the rfc4106 (gcm(AES)) algorithm is supported. The key must be 36 bytes (32 bytes for the algorithm key and 4 bytes for the salt), provided as a 72-character hexadecimal string.**
20+
#### Step 1: Generate an IPsec pre-shared key for Kmesh before starting Kmesh. Currently, only the rfc4106 (gcm(AES)) algorithm is supported. The key must be 36 bytes (32 bytes for the algorithm key and 4 bytes for the salt), provided as a 72-character hexadecimal string
2121

2222
``` bash
2323
kmeshctl secret --key=<aead key>
@@ -35,27 +35,27 @@ If you want to use a custom key, you can use the following command
3535
kmeshctl secret --key=$(echo -n "{36-bytes user-defined key here}" | xxd -p -c 64)
3636
```
3737

38-
**Step 2: Add the parameter --enable-ipsec=true to the Kmesh yaml**
38+
#### Step 2: Add the parameter --enable-ipsec=true to the Kmesh yaml
3939

4040
```plaintext
4141
kmesh.yaml
4242
...
4343
args:
4444
[
45-
"./start_kmesh.sh --mode=dual-engine --enable-bypass=false --enable-ipsec=true",
45+
"./start_kmesh.sh --mode=dual-engine --enable-bypass=false --enable-ipsec=true",
4646
]
4747
...
4848
```
4949

50-
**Step 3: Place pods or namespace under the management of Kmesh.**
50+
#### Step 3: Place pods or namespace under the management of Kmesh
5151

5252
Only when both communicating pods are managed by Kmesh, will they enter the encryption process.
5353

5454
``` bash
5555
kubectl label namespace default istio.io/dataplane-mode=Kmesh
5656
```
5757

58-
**Step 4: Test whether the data packet has been encrypted**
58+
#### Step 4: Test whether the data packet has been encrypted
5959

6060
Use tcpdump on nodes to capture packets and check if IPsec has been used during data communication between nodes (determined by ESP packets)
6161

@@ -69,7 +69,7 @@ tcpdump -i any |grep ESP
6969
...
7070
```
7171

72-
**Step 5: Replace pre shared key**
72+
#### Step 5: Replace pre shared key
7373

7474
After a period of time, the pre-shared key of the cluster can be changed. After changing the pre-shared key, the ESP SPI number of the IPsec used for communication between nodes will be increased by 1 compared to the previous version. This can be observed again through using tcpdump. The initial IPSec SPI version number is 1
7575

@@ -85,6 +85,6 @@ root@master:~/kmesh# tcpdump -i any |grep ESP
8585

8686
### Note
8787

88-
1. IPsec encryption uses mark `0xe0` and `0xd0` as markers for IPsec encryption and decryption. Please ensure that no conflicting Makr is used on the host network, otherwise unknown behavior may occur
88+
1. IPsec encryption uses mark `0xe0` and `0xd0` as markers for IPsec encryption and decryption. Please ensure that no conflicting Mark is used on the host network, otherwise unknown behavior may occur
8989

9090
2. Please ensure that `address MASQ` is not used on packets encrypted with IPsec. After address MASQ, IPsec cannot accurately match encryption and decryption rules, which can result in packet loss

0 commit comments

Comments
 (0)