Skip to content

Commit 4b41348

Browse files
committed
docs: fix markdown linting issues
- Capitalize 'Mount Pod' and 'Mount Pods' consistently per enhanced-proper-names rule - Fix all occurrences in daemonset-mount.md and mount-pod-configuration.md - Comply with .markdownlint-cli2.jsonc configuration
1 parent ac344f4 commit 4b41348

File tree

2 files changed

+27
-27
lines changed

2 files changed

+27
-27
lines changed

docs/en/guide/daemonset-mount.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# DaemonSet Mount for StorageClass
22

3-
This feature allows JuiceFS CSI Driver to deploy mount pods as DaemonSets instead of individual pods when using StorageClass with mount sharing enabled. This provides better resource management and control over which nodes run mount pods.
3+
This feature allows JuiceFS CSI Driver to deploy Mount Pods as DaemonSets instead of individual pods when using StorageClass with mount sharing enabled. This provides better resource management and control over which nodes run Mount Pods.
44

55
## Overview
66

7-
When `STORAGE_CLASS_SHARE_MOUNT` is enabled, JuiceFS CSI Driver shares mount pods across multiple PVCs that use the same StorageClass. By default, these are created as individual pods. With the DaemonSet option, mount pods are deployed as DaemonSets, providing:
7+
When `STORAGE_CLASS_SHARE_MOUNT` is enabled, JuiceFS CSI Driver shares Mount Pods across multiple PVCs that use the same StorageClass. By default, these are created as individual pods. With the DaemonSet option, Mount Pods are deployed as DaemonSets, providing:
88

9-
- **Better resource control**: DaemonSets ensure one mount pod per selected node
9+
- **Better resource control**: DaemonSets ensure one Mount Pod per selected node
1010
- **Node affinity support**: Control which nodes run mount pods using nodeAffinity
1111
- **Automatic lifecycle management**: DaemonSets handle pod creation/deletion automatically
12-
- **Simplified operations**: Easier to manage and monitor mount pods
12+
- **Simplified operations**: Easier to manage and monitor Mount Pods
1313
- **Works with existing StorageClasses**: No need to modify or recreate StorageClasses
1414

1515
## Configuration
@@ -28,7 +28,7 @@ env:
2828
2929
### Configure Node Affinity
3030
31-
There are two ways to configure node affinity for DaemonSet mount pods:
31+
There are two ways to configure node affinity for DaemonSet Mount Pods:
3232
3333
#### Method 1: ConfigMap (Recommended for existing StorageClasses)
3434
@@ -77,7 +77,7 @@ provisioner: csi.juicefs.com
7777
parameters:
7878
# ... other parameters ...
7979
80-
# Node affinity configuration for DaemonSet mount pods
80+
# Node affinity configuration for DaemonSet Mount Pods
8181
nodeAffinity: |
8282
requiredDuringSchedulingIgnoredDuringExecution:
8383
nodeSelectorTerms:
@@ -98,7 +98,7 @@ parameters:
9898
- Creates a new DaemonSet with the configured node affinity
9999
- If DaemonSet exists, it adds a reference to the existing DaemonSet
100100

101-
2. The DaemonSet ensures mount pods are running on selected nodes:
101+
2. The DaemonSet ensures Mount Pods are running on selected nodes:
102102
- Pods are automatically created on nodes matching the affinity rules
103103
- Mount paths are shared across PVCs using the same StorageClass
104104

@@ -118,7 +118,7 @@ The system checks for node affinity configuration in this order:
118118

119119
### Dedicated Mount Nodes
120120

121-
Label specific nodes for running mount pods:
121+
Label specific nodes for running Mount Pods:
122122

123123
```bash
124124
kubectl label nodes node1 node2 node3 juicefs/mount-node=true
@@ -128,7 +128,7 @@ Then use nodeAffinity in StorageClass to target these nodes.
128128

129129
### High-Performance Nodes
130130

131-
Prefer nodes with better resources for mount pods:
131+
Prefer nodes with better resources for Mount Pods:
132132

133133
```yaml
134134
nodeAffinity: |
@@ -145,7 +145,7 @@ nodeAffinity: |
145145

146146
### Exclude Control Plane
147147

148-
Prevent mount pods from running on control plane nodes:
148+
Prevent Mount Pods from running on control plane nodes:
149149

150150
```yaml
151151
nodeAffinity: |
@@ -158,7 +158,7 @@ nodeAffinity: |
158158

159159
## Monitoring
160160

161-
You can monitor DaemonSet mount pods using standard Kubernetes commands:
161+
You can monitor DaemonSet Mount Pods using standard Kubernetes commands:
162162

163163
```bash
164164
# List all mount DaemonSets
@@ -184,7 +184,7 @@ To migrate from pod-based mounts to DaemonSet mounts:
184184
1. Enable the feature flags in CSI driver
185185
2. Create a new StorageClass with desired node affinity
186186
3. Migrate PVCs to the new StorageClass
187-
4. Old mount pods will be replaced by DaemonSet pods
187+
4. Old Mount Pods will be replaced by DaemonSet pods
188188

189189
## Troubleshooting
190190

@@ -196,7 +196,7 @@ Check if nodes match the affinity rules:
196196
kubectl get nodes --show-labels | grep <your-label>
197197
```
198198

199-
### Mount pods on unexpected nodes
199+
### Mount Pods on unexpected nodes
200200

201201
Verify the nodeAffinity configuration:
202202

docs/en/guide/mount-pod-configuration.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Mount Pod Configuration Guide
22

3-
JuiceFS CSI Driver provides flexible mount pod deployment options that can be configured per StorageClass. This allows you to optimize resource usage and performance based on your specific needs.
3+
JuiceFS CSI Driver provides flexible Mount Pod deployment options that can be configured per StorageClass. This allows you to optimize resource usage and performance based on your specific needs.
44

55
## Overview
66

7-
JuiceFS CSI Driver supports three mount pod deployment modes:
7+
JuiceFS CSI Driver supports three Mount Pod deployment modes:
88

9-
1. **Per-PVC Mode** (`per-pvc`): Creates a separate mount pod for each PVC
10-
2. **Shared Pod Mode** (`shared-pod`): Shares mount pods across PVCs using the same StorageClass
11-
3. **DaemonSet Mode** (`daemonset`): Deploys mount pods as DaemonSets with node affinity support
9+
1. **Per-PVC Mode** (`per-pvc`): Creates a separate Mount Pod for each PVC
10+
2. **Shared Pod Mode** (`shared-pod`): Shares Mount Pods across PVCs using the same StorageClass
11+
3. **DaemonSet Mode** (`daemonset`): Deploys Mount Pods as DaemonSets with node affinity support
1212

1313
## Configuration Methods
1414

@@ -61,7 +61,7 @@ data:
6161
6262
### Per-PVC Mode
6363
64-
Each PVC gets its own dedicated mount pod.
64+
Each PVC gets its own dedicated Mount Pod.
6565
6666
**Advantages:**
6767
- Complete isolation between PVCs
@@ -80,7 +80,7 @@ mode: per-pvc
8080
8181
### Shared Pod Mode
8282
83-
Multiple PVCs using the same StorageClass share mount pods.
83+
Multiple PVCs using the same StorageClass share Mount Pods.
8484
8585
**Advantages:**
8686
- Reduced resource consumption
@@ -99,7 +99,7 @@ mode: shared-pod
9999
100100
### DaemonSet Mode
101101
102-
Mount pods are deployed as DaemonSets across selected nodes.
102+
Mount Pods are deployed as DaemonSets across selected nodes.
103103
104104
**Advantages:**
105105
- Predictable pod placement
@@ -109,7 +109,7 @@ Mount pods are deployed as DaemonSets across selected nodes.
109109
110110
**Use Cases:**
111111
- High-performance computing
112-
- Dedicated mount nodes
112+
- Dedicated Mount nodes
113113
- GPU workloads
114114
- Large-scale deployments
115115
@@ -140,7 +140,7 @@ The ConfigMap approach allows you to change mount behavior **without modifying e
140140
141141
1. Create the ConfigMap with desired configuration
142142
2. New PVCs will use the new mount mode
143-
3. Existing PVCs continue using their current mount pods
143+
3. Existing PVCs continue using their current Mount Pods
144144
145145
## Examples
146146
@@ -202,7 +202,7 @@ data:
202202
203203
### Example 3: Node-Specific DaemonSets
204204
205-
Deploy mount pods on specific node types:
205+
Deploy Mount Pods on specific node types:
206206
207207
```yaml
208208
apiVersion: v1
@@ -279,7 +279,7 @@ kubectl get configmap juicefs-mount-config -n kube-system -o jsonpath='{.data.my
279279

280280
## Troubleshooting
281281

282-
### Mount pods not created as expected
282+
### Mount Pods not created as expected
283283

284284
1. Check ConfigMap exists and is valid:
285285
```bash
@@ -311,7 +311,7 @@ kubectl describe daemonset -n kube-system juicefs-<uniqueid>-mount-ds
311311

312312
### Switching modes for existing PVCs
313313

314-
Existing PVCs continue using their current mount pods. To switch modes:
314+
Existing PVCs continue using their current Mount Pods. To switch modes:
315315

316316
1. Update ConfigMap with new configuration
317317
2. Delete existing PVCs (ensure data is backed up)
@@ -349,7 +349,7 @@ kubectl apply -f juicefs-mount-config.yaml
349349

350350
## Summary
351351

352-
The mount pod configuration system provides:
352+
The Mount Pod configuration system provides:
353353

354354
- **Flexibility**: Different modes for different workloads
355355
- **Compatibility**: Works with existing StorageClasses

0 commit comments

Comments
 (0)