Huawei LiteOS（以下简称LiteOS）欢迎开发者参与到开源社区的贡献中来，本文主要介绍参与LiteOS文档贡献的写作规范，如果贡献者提交文档的修改或提交新的文档，请参照此规范。如需提交新的文档，在LiteOS代码仓doc目录下创建新的.md文件，命名需遵循xxx_xxx.md格式，根据文档的内容来声明。比如介绍写作规范的文档，

查看更多 →

构造规范请求 使用AK/SK方式进行签名与认证，首先需要规范请求内容，然后再进行签名。客户端与云服务API网关使用相同的请求规范，可以确保同一个HTTP请求的前后端得到相同的签名结果，从而完成身份校验。 HTTP请求规范伪代码如下： CanonicalRequest =

查看更多 →

排版规范 建议 建议1：全部使用大写来编写SQL语句和代码。 所有数据库代码统一使用大写字母，ORACLE和DB2存储过程不区分大小写，但某些数据库如SQL SEVER，变量名是大小写敏感的，为了保证移植性，有必要统一大小写风格。 建议2：SQL语句中关键字左对齐。 不符合规范示例：

查看更多 →

设计规范 命名规范 数据库对象（库名、表名、字段名、索引名）命名建议全部使用小写字母开头，后面跟字母或者数字，数据库对象（库名、表名、字段名、索引名）名字长度建议都不要大于32字节。 数据库名称不能使用特殊字符("",.,$,\,/,*,?,~,#,:,|")和空字符\0，数据库

查看更多 →

模型包规范 模型包规范介绍 模型配置文件编写说明 模型推理代码编写说明 父主题： 推理规范说明

查看更多 →

实例使用规范 数据库实例 主备 一主一备的经典高可用架构。 备机提高了实例的可靠性，创建主机的过程中，同步创建备机，备机创建成功后，用户不可见。 当主节点故障后，会发生主备切换，数据库客户端会发生短暂中断，数据库客户端需要支持重新连接。 单机 采用单个数据库节点部署架构。 单机版出现故障后，无法保障及时恢复。

查看更多 →

使用规范建议 概述 数据库设计规范 数据库编程规范 客户端编程规范 参数配置规范

查看更多 →

SQL使用规范 数据库SQL查询规范 当使用ORDER BY .. LIMIT查询时，优先考虑通过索引优化查询语句，提高执行效率。 使用ORDER BY、GROUP BY、DISTINCT执行查询时，where条件过滤出来的结果集请保持在1000行以内，否则会降低查询效率。 使用ORDER

查看更多 →

实例使用规范 数据库连接 RDS for PostgreSQL是进程架构，每个客户端连接都对应一个后端服务进程。 根据业务的复杂度，合理配置“max_connections”，例如，参考pgtune： WEB应用：“max_connections ”配置为 200 OLTP应用：

查看更多 →

实例使用规范 数据库实例 数据库实例类型选择 主备 一主一备的经典高可用架构。适用于大中型企业的生产数据库，覆盖互联网、物联网、零售电商、物流、游戏等行业应用。 备机提高了实例的可靠性，创建主机的过程中，同步创建备机，备机创建成功后，用户不可见。 当主节点故障后，会发生主备切换，

查看更多 →

数据仓库 服务 DWS DWS集群启用KMS加密 DWS集群启用日志转储 DWS集群启用自动快照 DWS集群启用SSL加密连接 DWS集群未绑定公网IP 父主题： 系统内置预设策略

查看更多 →

创建数据仓库 GaussDB (DWS) 参见“创建集群”章节创建GaussDB(DWS)数据仓库。创建成功后，记录集群的内网IP。 为确保E CS 与GaussDB(DWS)网络互通，GaussDB(DWS)数据仓库需要与ECS在同一个区域，同一个虚拟私有云和子网下。 表1 DWS规格

查看更多 →

数据仓库错误码 SQL标准错误码说明 第三方库错误码说明 GAUSS-00001 -- GAUSS-00100 GAUSS-00101 -- GAUSS-00200 GAUSS-00201 -- GAUSS-00300 GAUSS-00301 -- GAUSS-00400 GAUSS-00401

查看更多 →

模板规范和变量规范包含哪些内容？ 模板规范 模板规范分为模板格式规范和模板内容规范。 模板格式规范 文本短信模板限500字符。 不支持【】，可能会与签名混淆，导致发送失败。 不支持如￥、★、^_^、&、√、※等特殊符号，可能会导致短信出现乱码。 内容规范 模板必须体现实际公司业务

查看更多 →

脚本开发规范 命名 注释 引用 定义 调试 语法 SQL 代码风格 安全编码 调用约束 代码规范案例汇总 父主题： 开发规范

查看更多 →

目前，社区有多种 Commit message 的写法规范。LiteOS采用的是Angular规范，这是目前使用最广的写法，比较合理和系统化，并且有配套的工具。格式化的Commit message有几个好处：提供更多的历史信息，方便快速浏览。可以过滤某些commit（比如文档改动），便于快速查找信息。可以直接从commit生成Change

查看更多 →

服务包规范 本规范主要面向对象为初次开发的服务以及想要使用OSC平台提供的附加能力进行规范转换的服务。 如果开发者已有或仅想使用Helm/Operator-Framework规范的服务，可以直接参考章节开源服务包规范。 OSC服务包介绍 元数据Metadata 资源集合Manifests

查看更多 →

接入规范说明 开源OLM服务（operator-framework）服务支持自定义配置服务场景、支持架构等配置，其描述说明定义在clusterserviceversion.yaml中，具体样例如下： apiVersion: operators.coreos.com/v1alpha1

查看更多 →

接入规范说明 开源helm服务支持自定义配置服务场景、支持架构等配置，其描述说明定义在Chart.yaml中，具体样例如下： apiVersion: v1 description: "nginx \n" maintainers: - email: support@rancher.com

查看更多 →

#【必选】CustomResourceDefinition自定义资源定义文件，可多个。 更多介绍参见官网Operator Framework。 接入规范说明 父主题： 开源服务包规范

查看更多 →

推理规范说明 模型包规范 模型模板 自定义脚本代码示例

查看更多 →