Skip to content

Commit f819842

Browse files
committed
feat: add buckets section
Signed-off-by: seven <zilisheng1996@gmail.com>
1 parent 94749ef commit f819842

File tree

1 file changed

+69
-25
lines changed

1 file changed

+69
-25
lines changed

docs/reference.md

Lines changed: 69 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -66,14 +66,16 @@ version: 0.1
6666
6767
## provider
6868
69-
7069
`provider`字段指定了ServerlessInsight的提供商信息。
70+
7171
```yaml
7272
provider:
7373
name: aliyun
7474
region: cn-chengdu
7575
```
76+
7677
`provider`支持的字段有:
78+
7779
- **name**: 云提供商的名称,包括`aliyun`、`huawei`、`tencent`等,目前只支持`aliyun`,其他提供商的支持正在开发中
7880
> 支持的云提供商的名称: aliyun, huawei, tencent
7981
> required: true
@@ -160,7 +162,6 @@ service: insight-poc-${stage}
160162
> required: false
161163
> default: false
162164
> 注意: 由于阿里sls创建延迟问题,无法在创建时开启日志,需要stack第一次创建时关闭,等待1~2分钟后开启日志并重新部署。
163-
164165

165166
## events
166167

@@ -191,9 +192,9 @@ service: insight-poc-${stage}
191192
> required: true
192193
- **certificate_body**: 证书内容
193194
> required: true
194-
195195

196196
## databases
197+
197198
`databases`字段是一个对象,用于定义数据库。`databases`下的每一个子项都是一个数据库资源的定义。
198199

199200
```yaml
@@ -234,41 +235,43 @@ database支持的字段有:
234235
- **type**: 数据库的类型
235236
> 类型: `string`
236237
> 支持的类型: `ELASTICSEARCH_SERVERLESS`, `RDS_MYSQL_SERVERLESS`, `RDS_PGSQL_SERVERLESS`, `RDS_MSSQL_SERVERLESS`
237-
> required: true
238+
> required: true
238239

239240
- **version**: 数据库的版本
240241
> 类型: `string`
241-
> 支持的版本: `MYSQL_5.7`, `MYSQL_8.0`, `MYSQL_HA_5.7`, `MYSQL_HA_8.0`, `PGSQL_14`, `PGSQL_15`, `PGSQL_16`, `PGSQL_HA_14`, `PGSQL_HA_15`, `PGSQL_HA_16`, `MSSQL_HA_2016`, `MSSQL_HA_2017`, `MSSQL_HA_2019`, `ES_SEARCH_7.10`, `ES_TIME_SERIES_7.10`
242+
> 支持的版本: `MYSQL_5.7`, `MYSQL_8.0`, `MYSQL_HA_5.7`, `MYSQL_HA_8.0`, `PGSQL_14`, `PGSQL_15`, `PGSQL_16`,
243+
`PGSQL_HA_14`, `PGSQL_HA_15`, `PGSQL_HA_16`, `MSSQL_HA_2016`, `MSSQL_HA_2017`, `MSSQL_HA_2019`, `ES_SEARCH_7.10`,
244+
`ES_TIME_SERIES_7.10`
242245
> required: true
243246

244247
- **cu**: 计算单元配置
245248
> 类型: `object`
246-
- **min**: 最小计算单元
247-
> 类型: `integer`
248-
> 最小值: 0
249-
> 最大值: 32
250-
- **max**: 最大计算单元
251-
> 类型: `integer`
252-
> 最小值: 1
253-
> 最大值: 32
249+
- **min**: 最小计算单元
250+
> 类型: `integer`
251+
> 最小值: 0
252+
> 最大值: 32
253+
- **max**: 最大计算单元
254+
> 类型: `integer`
255+
> 最小值: 1
256+
> 最大值: 32
254257

255258
- **storage**: 存储配置
256259
> 类型: `object`
257-
- **min**: 最小存储空间
258-
> 类型: `integer`
259-
> 最小值: 20
260-
> required: true
260+
- **min**: 最小存储空间
261+
> 类型: `integer`
262+
> 最小值: 20
263+
> required: true
261264

262265
- **security**: 安全配置
263266
> 类型: `object`
264-
> required: true
265-
- **basic_auth**: 基本认证
266-
- **master_user**: 主用户
267-
> 类型: `string`
268-
> required: true
269-
- **password**: 密码
270-
> 类型: `string`
271-
> required: true
267+
> required: true
268+
- **basic_auth**: 基本认证
269+
- **master_user**: 主用户
270+
> 类型: `string`
271+
> required: true
272+
- **password**: 密码
273+
> 类型: `string`
274+
> required: true
272275

273276
- **network**: 网络配置
274277
> 类型: `object`
@@ -282,3 +285,44 @@ database支持的字段有:
282285
> 类型: `boolean`
283286

284287
每个数据库定义必须包含`name`、`type`、`version`和`security`字段。
288+
289+
## buckets
290+
291+
`buckets`字段是一个对象,用于定义对象存储。`buckets`下的每一个子项都是一个对象存储桶(Bucket🪣)资源的定义。
292+
293+
```yaml
294+
version: 0.0.1
295+
296+
provider:
297+
name: aliyun
298+
region: cn-chengdu
299+
300+
service: insight-bucket-poc
301+
302+
tags:
303+
owner: geek-fun
304+
305+
buckets:
306+
insight_bucket:
307+
name: insight-poc-bucket
308+
storage:
309+
class: STANDARD
310+
versioning:
311+
status: ENABLED
312+
lifecycle:
313+
rule:
314+
id: rule1
315+
status: ENABLED
316+
expiration:
317+
days: 30
318+
security:
319+
force_delete: false
320+
sse_algorithm: KMS
321+
sse_kms_master_key_id: 1234567890
322+
website:
323+
code: artifacts/frontend.zip
324+
index: index.html
325+
error_page: 404.html
326+
error_code: 404
327+
328+
```

0 commit comments

Comments
 (0)