Skip to content

Commit de08a4e

Browse files
authored
feat: add buckets section (#2)
* feat: add buckets section Signed-off-by: seven <zilisheng1996@gmail.com> * docs: bucket related docs Signed-off-by: seven <zilisheng1996@gmail.com> --------- Signed-off-by: seven <zilisheng1996@gmail.com>
1 parent 94749ef commit de08a4e

File tree

1 file changed

+135
-25
lines changed

1 file changed

+135
-25
lines changed

docs/reference.md

+135-25
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,110 @@ 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+
security:
311+
access: PRIVATE
312+
force_delete: false
313+
sse_algorithm: KMS
314+
sse_kms_master_key_id: 1234567890
315+
website:
316+
code: dist/
317+
domain: example.com
318+
index: index.html
319+
error_page: 404.html
320+
error_code: 404
321+
versioning: ENABLED
322+
lifecycle:
323+
rule:
324+
id: rule1
325+
expiration:
326+
days: 30
327+
```
328+
329+
bucket支持的字段有:
330+
331+
- **name**: 存储桶的名称
332+
333+
> 类型: `string`
334+
> required: true
335+
> 支持的字符集为`a-zA-Z0-9-_`,长度为1-64个字符
336+
>
337+
338+
- **storage**: 存储配置
339+
- **class**: 存储类型
340+
> 类型: `string`
341+
> required: true
342+
> 支持的存储类型: `STANDARD`, `IA`, `ARCHIVE`, `COLD`
343+
- **versioning**: 版本控制配置
344+
- **status**: 版本控制状态
345+
> 类型: `string`
346+
> required: true
347+
> 支持的状态: `ENABLED`, `DISABLED`
348+
349+
- **website**: 用于配置静态网站托,使得存储桶可以托管静态网站
350+
> 注意⚠️:
351+
> - 配置静态网站托管时,如果想要运行公网用户访问,需要将存储桶的访问权限设置为公共读
352+
> - website中的配置项出了`code`外,其他配置项都无法在存储桶创建后修改,如果需要修改,需要删除website配置项后重新配置
353+
354+
- **code**: 网站代码包相对项根目录的路径
355+
> 类型: `string`
356+
> required: true
357+
- **domain**: 静态网页自定义域名,只有配置域名才能正常显示静态网页,否则通过存储桶的默认域名访问会转为下载文件
358+
> 类型: `string`
359+
> required: false
360+
> 默认值: null
361+
- **index**: 默认首页
362+
> 类型: `string`
363+
> required: false
364+
> 默认值: `index.html`
365+
- **error_page**: 错误页
366+
> 类型: `string`
367+
> required: false
368+
> 默认值: `404.html`
369+
- **error_code**: 错误码
370+
> 类型: `integer`
371+
> required: false
372+
> 默认值: `404`
373+
374+
- **lifecycle**: 生命周期配置
375+
- **rule**: 生命周期规则
376+
377+
- security: bucket安全相关配置
378+
- **acl**: 访问控制,配置bucket的访问权限
379+
> 类型: `string`
380+
> required: false
381+
> 默认值: `PRIVATE`
382+
> 支持的访问控制: `PRIVATE`, `PUBLIC_READ`, `PUBLIC_READ_WRITE`
383+
- **force_delete**: 强制删除
384+
> 类型: `boolean`
385+
> required: false
386+
> 默认值: false
387+
> 注意: 强制删除后无法恢复
388+
- **sse_algorithm**: 加密算法
389+
- **sse_kms_master_key_id**: 加密密钥ID
390+
> 类型: `string`
391+
> required: false
392+
> 默认值: null
393+
> 注意: 如果未指定加密密钥ID,则使用默认密钥
394+

0 commit comments

Comments
 (0)