Skip to content

Commit c67c534

Browse files
zhuxt2015corgy-w
andauthored
[Improve][Docs][seatunnel-engine]add namespace to plugin-config (#10271)
Co-authored-by: corgy-w <73771213+corgy-w@users.noreply.github.com>
1 parent a0e12c4 commit c67c534

File tree

2 files changed

+34
-15
lines changed

2 files changed

+34
-15
lines changed

docs/en/seatunnel-engine/checkpoint-storage.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ seatunnel:
3333
engine:
3434
checkpoint:
3535
storage:
36-
type: hdfs #plugin name of checkpoint storage, we support hdfs(S3, local, hdfs), localfile (native local file) is the default, but this plugin is de
37-
# plugin configuration
36+
type: hdfs # plugin name of checkpoint storage, we support hdfs(S3, local, hdfs), localfile (native local file) is the default, but this plugin is deprecated
37+
# plugin configuration
3838
plugin-config:
39-
namespace: #checkpoint storage parent path, the default value is /seatunnel/checkpoint/
39+
namespace: # checkpoint storage parent path, the default value is /seatunnel/checkpoint/
4040
K1: V1 # plugin other configuration
4141
K2: V2 # plugin other configuration
4242
```
@@ -62,6 +62,7 @@ seatunnel:
6262
type: hdfs
6363
max-retained: 3
6464
plugin-config:
65+
namespace: # checkpoint storage parent path, the default value is /seatunnel/checkpoint/
6566
storage.type: oss
6667
oss.bucket: your-bucket
6768
fs.oss.accessKeyId: your-access-key
@@ -92,6 +93,7 @@ seatunnel:
9293
type: hdfs
9394
max-retained: 3
9495
plugin-config:
96+
namespace: # checkpoint storage parent path, the default value is /seatunnel/checkpoint/
9597
storage.type: cos
9698
cos.bucket: cosn://your-bucket
9799
fs.cosn.credentials.provider: org.apache.hadoop.fs.cosn.auth.SimpleCredentialsProvider
@@ -129,11 +131,12 @@ seatunnel:
129131
type: hdfs
130132
max-retained: 3
131133
plugin-config:
132-
storage.type: s3
133-
s3.bucket: your-bucket
134-
fs.s3a.access.key: your-access-key
135-
fs.s3a.secret.key: your-secret-key
136-
fs.s3a.aws.credentials.provider: org.apache.hadoop.fs.s3a.SimpleAWSCredentialsProvider
134+
namespace: # checkpoint storage parent path, the default value is /seatunnel/checkpoint/
135+
storage.type: s3
136+
s3.bucket: your-bucket
137+
fs.s3a.access.key: your-access-key
138+
fs.s3a.secret.key: your-secret-key
139+
fs.s3a.aws.credentials.provider: org.apache.hadoop.fs.s3a.SimpleAWSCredentialsProvider
137140

138141

139142
```
@@ -152,6 +155,7 @@ seatunnel:
152155
type: hdfs
153156
max-retained: 3
154157
plugin-config:
158+
namespace: # checkpoint storage parent path, the default value is /seatunnel/checkpoint/
155159
storage.type: s3
156160
s3.bucket: your-bucket
157161
fs.s3a.endpoint: your-endpoint
@@ -171,6 +175,7 @@ seatunnel:
171175
type: hdfs
172176
max-retained: 3
173177
plugin-config:
178+
namespace: # checkpoint storage parent path, the default value is /seatunnel/checkpoint/
174179
storage.type: s3
175180
fs.s3a.access.key: xxxxxxxxx # Access Key of MinIO
176181
fs.s3a.secret.key: xxxxxxxxxxxxxxxxxxxxx # Secret Key of MinIO
@@ -194,6 +199,7 @@ seatunnel:
194199
type: hdfs
195200
max-retained: 3
196201
plugin-config:
202+
namespace: # checkpoint storage parent path, the default value is /seatunnel/checkpoint/
197203
storage.type: hdfs
198204
fs.defaultFS: hdfs://localhost:9000
199205
// if you used kerberos, you can config like this:
@@ -213,6 +219,7 @@ seatunnel:
213219
type: hdfs
214220
max-retained: 3
215221
plugin-config:
222+
namespace: # checkpoint storage parent path, the default value is /seatunnel/checkpoint/
216223
storage.type: hdfs
217224
fs.defaultFS: hdfs://usdp-bing
218225
seatunnel.hadoop.dfs.nameservices: usdp-bing
@@ -237,6 +244,7 @@ seatunnel:
237244
type: hdfs
238245
max-retained: 3
239246
plugin-config:
247+
namespace: # checkpoint storage parent path, the default value is /seatunnel/checkpoint/
240248
storage.type: hdfs
241249
fs.defaultFS: file:/// # Ensure that the directory has written permission
242250

@@ -256,6 +264,7 @@ seatunnel:
256264
type: hdfs
257265
max-retained: 3
258266
plugin-config:
267+
namespace: # checkpoint storage parent path, the default value is /seatunnel/checkpoint/
259268
storage.type: hdfs
260269
disable.cache: false
261270
fs.defaultFS: hdfs:///
@@ -274,6 +283,7 @@ seatunnel:
274283
type: hdfs
275284
max-retained: 3
276285
plugin-config:
286+
namespace: # checkpoint storage parent path, the default value is /seatunnel/checkpoint/
277287
storage.type: hdfs
278288
disable.cache: false
279289
fs.defaultFS: file:///

docs/zh/seatunnel-engine/checkpoint-storage.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ seatunnel:
3131
engine:
3232
checkpoint:
3333
storage:
34-
type: hdfs #检查点存储的插件名称,支持hdfs(S3, local, hdfs), 默认为localfile (本地文件), 但这种方式已弃用
35-
# 插件配置
34+
type: hdfs # 检查点存储的插件名称,支持hdfs(S3, local, hdfs), 默认为localfile (本地文件), 但这种方式已弃用
35+
# 插件配置
3636
plugin-config:
3737
namespace: #检查点存储父路径,默认值为/seatunnel/checkpoint/
3838
K1: V1 # 插件其它配置
@@ -60,6 +60,7 @@ seatunnel:
6060
type: hdfs
6161
max-retained: 3
6262
plugin-config:
63+
namespace: # 检查点存储父路径,默认值为/seatunnel/checkpoint/
6364
storage.type: oss
6465
oss.bucket: your-bucket
6566
fs.oss.accessKeyId: your-access-key
@@ -90,6 +91,7 @@ seatunnel:
9091
type: hdfs
9192
max-retained: 3
9293
plugin-config:
94+
namespace: # 检查点存储父路径,默认值为/seatunnel/checkpoint/
9395
storage.type: cos
9496
cos.bucket: cosn://your-bucket
9597
fs.cosn.credentials.provider: org.apache.hadoop.fs.cosn.auth.SimpleCredentialsProvider
@@ -127,11 +129,12 @@ seatunnel:
127129
type: hdfs
128130
max-retained: 3
129131
plugin-config:
130-
storage.type: s3
131-
s3.bucket: your-bucket
132-
fs.s3a.access.key: your-access-key
133-
fs.s3a.secret.key: your-secret-key
134-
fs.s3a.aws.credentials.provider: org.apache.hadoop.fs.s3a.SimpleAWSCredentialsProvider
132+
namespace: # 检查点存储父路径,默认值为/seatunnel/checkpoint/
133+
storage.type: s3
134+
s3.bucket: your-bucket
135+
fs.s3a.access.key: your-access-key
136+
fs.s3a.secret.key: your-secret-key
137+
fs.s3a.aws.credentials.provider: org.apache.hadoop.fs.s3a.SimpleAWSCredentialsProvider
135138

136139

137140
```
@@ -150,6 +153,7 @@ seatunnel:
150153
type: hdfs
151154
max-retained: 3
152155
plugin-config:
156+
namespace: # 检查点存储父路径,默认值为/seatunnel/checkpoint/
153157
storage.type: s3
154158
s3.bucket: your-bucket
155159
fs.s3a.endpoint: your-endpoint
@@ -170,6 +174,7 @@ seatunnel:
170174
type: hdfs
171175
max-retained: 3
172176
plugin-config:
177+
namespace: # 检查点存储父路径,默认值为/seatunnel/checkpoint/
173178
storage.type: hdfs
174179
fs.defaultFS: hdfs://localhost:9000
175180
// 如果您使用kerberos,您可以这样配置:
@@ -187,6 +192,7 @@ seatunnel:
187192
type: hdfs
188193
max-retained: 3
189194
plugin-config:
195+
namespace: # 检查点存储父路径,默认值为/seatunnel/checkpoint/
190196
storage.type: hdfs
191197
fs.defaultFS: hdfs://usdp-bing
192198
seatunnel.hadoop.dfs.nameservices: usdp-bing
@@ -211,6 +217,7 @@ seatunnel:
211217
type: hdfs
212218
max-retained: 3
213219
plugin-config:
220+
namespace: # 检查点存储父路径,默认值为/seatunnel/checkpoint/
214221
storage.type: hdfs
215222
fs.defaultFS: file:/// # 请确保该目录具有写权限
216223

@@ -230,6 +237,7 @@ seatunnel:
230237
type: hdfs
231238
max-retained: 3
232239
plugin-config:
240+
namespace: # 检查点存储父路径,默认值为/seatunnel/checkpoint/
233241
storage.type: hdfs
234242
disable.cache: false
235243
fs.defaultFS: hdfs:/// # Ensure that the directory has written permission
@@ -247,6 +255,7 @@ seatunnel:
247255
type: hdfs
248256
max-retained: 3
249257
plugin-config:
258+
namespace: # 检查点存储父路径,默认值为/seatunnel/checkpoint/
250259
storage.type: hdfs
251260
disable.cache: false
252261
fs.defaultFS: file:///

0 commit comments

Comments
 (0)