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

查看更多 →

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

查看更多 →

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

查看更多 →

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

查看更多 →

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

查看更多 →

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

查看更多 →

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

查看更多 →

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

查看更多 →

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

查看更多 →

apig:apis:create apig:apis:debug " ] } ] } 示例2：拒绝用户创建API分组 拒绝策略需要同时

查看更多 →

APP认证工作原理 构造规范请求。 将待发送的请求内容按照与API网关（即API管理）后台约定的规则组装，确保客户端签名、API网关后台认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生成的签名信息作为请求消息头添加到H

查看更多 →

脚本开发规范 命名 注释 引用 定义 调试 语法 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。 接入规范说明 父主题： 开源服务包规范

查看更多 →

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

查看更多 →

基础命令规范 查询命令 写入/更新命令 删除命令 父主题： 数据库使用规范

查看更多 →

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

查看更多 →

AK/SK签名认证流程 客户端涉及的AK/SK签名以及请求发送的流程概述如下： 构造规范请求。 将待发送的请求内容按照与API网关后台约定的规则组装，确保客户端签名、API网关后台认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生

查看更多 →