Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
13420933354 committed Apr 14, 2024
2 parents c16db1f + 029691d commit 3cb3e51
Show file tree
Hide file tree
Showing 54 changed files with 46,325 additions and 33,426 deletions.
785 changes: 398 additions & 387 deletions docs/adaptation/adaptation_hw.md

Large diffs are not rendered by default.

68,012 changes: 34,978 additions & 33,034 deletions docs/adaptation/adaptation_oss.md

Large diffs are not rendered by default.

11 changes: 8 additions & 3 deletions docs/adaptation/adaptation_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,19 @@ OC 社区项目仓库链接如下:[https://gitee.com/organizations/OpenCloudOS
测试工具代码仓:[https://gitee.com/opencloudos-stream/oc-hct](https://gitee.com/opencloudos-stream/oc-hct)
### 4.1-可自主测试:

在微信群内,OC 社区组织官方成员会提供相应的测试要求文件,请申请者按照标准完成测试,并提供标准测试报告给沟通群内的社区工作人员进行审核。
在微信群内,OC 社区组织官方成员会提供相应的测试要求文件,请申请者按照标准完成测试,并提供标准测试报告给沟通群内的社区工作人员进行审核。

测试报告模板链接:[产品互认证测试模板.docx](https://gitee.com/OpenCloudOS/sig-ecological-adaptation/blob/master/doc/%E4%BA%A7%E5%93%81%E4%BA%92%E8%AE%A4%E8%AF%81_%E6%B5%8B%E8%AF%95%E6%8A%A5%E5%91%8A_%E6%A8%A1%E6%9D%BF.docx)
测试报告模板链接:[产品互认证测试模板.docx](https://gitee.com/OpenCloudOS/sig-ecological-adaptation/blob/master/doc/%E4%BA%A7%E5%93%81%E4%BA%92%E8%AE%A4%E8%AF%81_%E6%B5%8B%E8%AF%95%E6%8A%A5%E5%91%8A230526.docx)

整机厂商测试用例可参考:[整机认证测试项](testcase.md)
### 4.2-不可自主测试:

在微信群内提出申请,将特殊请求、设备发以及测试方法送至 OC 社区联合实验(E企研究院)处,进行相应测试。
在微信群内提出申请,将特殊请求、设备发以及测试方法送至 OC 社区联合实验(E企研究院)处,进行相应测试。

### 4.3-测试报告要求

1. 按照模板指引完成测试报告,填写报告关键信息。
2. 将测试关键log与测试报告一同打包,提交审核。
## 5-适配代码、软件包管理

请申请者决定若要加入 OC 社区的 YUM 源,则需完成 OC 社区 Realse SIG 的管理流程[Relase-SIG 快速导航](https://gitee.com/OpenCloudOS/SIG-release)
Expand Down
7 changes: 7 additions & 0 deletions docs/adaptation/adaptation_sw.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@ OpenCloudOS 商业软件兼容列表如下:

| 产品名 | 版本 | 软件类型 | 厂家名称 | 操作系统 |
| :-------------------------- | :----- | :------- | :--------------------------------- | :---------- |
| 开源 PolarDB 分布式版 | V2.2| 数据库管理系统| 阿里云计算有限公司 | OpenCloudOS |
| 开源 PolarDB PostgreSQL 版 | V11 | 数据库管理系统 | 阿里云计算有限公司 | OpenCloudOS |
| Coremail XT安全增强电子邮件系统 | V6.0 | 行业应用 | 广东盈世计算机科技有限公司 | OpenCloudOS |
| GoldenDB | V6 | 数据库管理系统 | 金篆信科有限责任公司 | OpenCloudOS |
| 新支点桌面 | - | 桌面 | 广东中兴新支点技术有限公司 | OpenCloudOS |
| 灵雀云企业级全栈云原生开放平台 | V3 | 虚拟化云平台 | 北京凌云雀科技有限公司 | OpenCloudOS |
| TDengine | V3.0.4.1 | 数据库管理系统 | 北京涛思数据科技有限公司 | OpenCloudOS |
| APISIX | V3.2.0 | 中间件 | Apache APISIX 开源社区 | OpenCloudOS |
| Apusic应用服务器软件 | V10 | 虚拟化云平台 | 深圳市金蝶天燕云计算股份有限公司 | OpenCloudOS |
| 云树集群管理平台软件(CTREE DMP) | V7 | 数据库管理系统 | 上海爱可生信急技术股份有限公司 | OpenCloudOS |
Expand Down
121 changes: 121 additions & 0 deletions docs/contribution/kernel-develop-guide.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# OpenCloudos Kernel Development Guide

> The purpose of this document is:
>
> - Ensure that kernel code development and rounds comply with community license requirements.
> - Ensure that the coding style and code quality meet the quality requirements of the kernel Upstream Linus library.
> - As the upstream kernel of the industry partner, OC KERNEL will provide the downstream partner with a forward-only kernel tree and provide the downstream partner feature selection flexibility.
## 1-Branching Strategy

Branch names and usage processes

- the code composition of master: LTS + upstream backport features + SIG opensource features + bugfix。
- Each feature is formed into independent branches based on the master, and merged into the merge master after meeting the feature integration requirements and testing.
- The master branch is merged into Tencent's internal code tree, where the features are merged into the LTS/XX stable branch and opened to downstream users.
- The stable branch of the OC kernel is in the lts/directory, and only accepts bugfix that does not affect Kabi stability.
- Master and stable branch forward-only, force push is not allowed.

## 2-Kernel Default Configuration

`make occonfig` Provide kernel default configuration.
`make noocconfig` The OC-specific configuration item is deleted in the current configuration as a build test case of the OC kernel.

## 3-Kernel Feature Development Requirements

In order to better track the whole process (self-developed) kernel feature development without increasing the burden on development students, the kernel features required to be added to the OC kernel must meet the following requirements :

- Clearly describe the problem that the feature is trying to solve ;

- The design solution used to solve this problem ;

- Usage and practical effects of features ;

- This feature must provide a CONFIG_ Compilation switch for mode ;

- Provide cmdline switch or sysctl runtime switch or provide code in a modular manner (optional) ;

- The impact of characteristics on KABI integrated into the kernel ;

- The features have passed those functional and performance tests. The specified testing requirements are listed below .

- The submission team must be responsible for the functionality, performance, and bugs of the submitted code. Code must be reviewed.

- The person in charge of feature submission needs to `signed-off`, and the reviewer needs to add `Reviewed-by:`or `Acked-by: `

- If there are tests, please sign the test results, such as :

```
Tested-by: Desheng <deshengwu@Tencent 腾讯>
```

## 4-Commit Specification Requirements

1. When submitting self-developed features(commit log),require to include `Reviewed-by` or `Acked-by`

2. When turning on the characteristics of other code trees, it is necessary to act as an independent branch and:

- Maintain the original upstream commit quantity and order

- Keep the original commit author

- Add `Signed-off-by` of the person who took the turn: (recommended to use `git cherry-pick -s`)

- The solution to the round conflict should be indicated in the commit log:`Conflicts:<refactored some_function_foo ... >`

- On the first line of the commit log, indicate the commit IDs of other code trees, such as

```text
commit 7548bf8c17d84607c106bd45d81834afd95a2edb upstream/openvz/openeuler
```
or

```text
Upstream commit 8ebcc62c738f68688ee7c6fec2efe5bc6d3d7e60
```

## 5-Tag/Version Specification

Currently in use TAG:

- 4.14.105-19-0015
- 5.4.119-19-0009.1

## 6-Characterization Testing Requirements

Each new kernel feature integration requires passing the following tests and providing a test report:

1. The checkpatch.pl and each config compilation for each commit:

- The newly added kernel config needs to be closed and compiled in the kernel/configs/nooc.config file ;

- As an upstream kernel code, downstream users may have different requirements for using OC Kernel. In ARM and X86, in addition to the default `default`, `noocconfig`, `occonfig` must be built and passed, they must also compile and pass the default `defconfig`, `allyesconfig`, `allmodconfig`in the code tree.

- **The minimum requirement is not to addbuild error/warning.** A self testing method is as follows:

```bash
make allmodconfig modules all -s ; make allyesconfig noocconfig all -s
```

2. The recommendations for kernel benchmark self-testing under each config are as follows:

```bash
make occonfig kvmconfig bzImage -s -j 32 && qemu -kernel arch/x86/boot/bzImage --nographic -m 4g -smp 4 --enable-kvm ...
```

3. Provide test cases for features, such as kunit/kselftest or other use cases

4. Pass basic kernel testing
a. LTP related testing does not increase failure.
b. Stress-ng testing - if it can be covered.

5. Gcov or kcov code coverage>90% when executing tests.
(gcov's data collection method [Using gcov with the Linux kernel](https://www.kernel.org/doc/html/latest/dev-tools/gcov.html) )
Written by:alexsshi 2023-02-17
reference:
1. [Kernel Documentation](https://www.kernel.org/doc/html/latest/index.html#id6)
2. [Submitting patches: the essential guide to getting your code into the kernel](https://www.kernel.org/doc/html/latest/process/submitting-patches.html)
Binary file added docs/download/image/mirrors/1685357908856.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/download/image/mirrors/1685357912756.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/download/image/mirrors/1685357917079.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions docs/download/iso.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
下载 OpenCloudOS 官方版本镜像

| Version | ARCHITECTURE | ISO |
| --------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 8.6 | x86_64 | [Minimal](https://mirrors.opencloudos.tech/opencloudos/8.6/isos/x86_64/opencloudos-8.6-x86_64-minimal.iso)[DVD](https://mirrors.opencloudos.tech/opencloudos/8.6/isos/x86_64/opencloudos-8.6-x86_64-dvd1.iso)[QCOW2](https://mirrors.opencloudos.tech/opencloudos/8.6/images/opencloudos-v8.6-minimal-x86_64-20230206.qcow2)[Containers](https://mirrors.opencloudos.tech/opencloudos/8.6/images/opencloudos-v8.6-minimal-x86_64.tar)[Checksum](https://mirrors.opencloudos.tech/opencloudos/8.6/isos/x86_64/CHECKSUM)[YumRepo](https://mirrors.opencloudos.tech/opencloudos/8.6/) |
| 8.6 | aarch64 | [Minimal](https://mirrors.opencloudos.tech/opencloudos/8.6/isos/aarch64/opencloudos-8.6-aarch64-minimal.iso)[DVD](https://mirrors.opencloudos.tech/opencloudos/8.6/isos/aarch64/opencloudos-8.6-aarch64-dvd1.iso)[QCOW2](https://mirrors.opencloudos.tech/opencloudos/8.6/images/opencloudos-v8.6-minimal-aarch64-20230206.qcow2)[Containers](https://mirrors.opencloudos.tech/opencloudos/8.6/images/opencloudos-v8.6-minimal-aarch64.tar)[Checksum](https://mirrors.opencloudos.tech/opencloudos/8.6/isos/aarch64/CHECKSUM)[YumRepo](https://mirrors.opencloudos.tech/opencloudos/8.6/) |
| 9.0 | x86_64 | [Everything](https://mirrors.opencloudos.tech/opencloudos/9.0/isos/x86_64/OpenCloudOS-9.0-x86_64-everything.iso)[Netinst](https://mirrors.opencloudos.tech/opencloudos/9.0/isos/x86_64/OpenCloudOS-9.0-x86_64-netinst.iso)[QCOW2](https://mirrors.opencloudos.tech/opencloudos/9.0/images/x86_64/opencloudos-v9.0-20230329-x86_64.qcow2)[Containers](https://mirrors.opencloudos.tech/opencloudos/9.0/images/x86_64/opencloudos-9.0-minimal-x86_64.tar)[Checksum](https://mirrors.opencloudos.tech/opencloudos/9.0/isos/x86_64/CHECKSUM)[YumRepo](https://mirrors.opencloudos.tech/opencloudos/9.0/) |
| 9.0 | aarch64 | [Everything](https://mirrors.opencloudos.tech/opencloudos/9.0/isos/aarch64/OpenCloudOS-9.0-aarch64-everything.iso)[Netinst](https://mirrors.opencloudos.tech/opencloudos/9.0/isos/aarch64/OpenCloudOS-9.0-aarch64-netinst.iso)[QCOW2](https://mirrors.opencloudos.tech/opencloudos/9.0/images/aarch64/opencloudos-v9.0-20230317-aarch64.qcow2)[Containers](https://mirrors.opencloudos.tech/opencloudos/9.0/images/aarch64/opencloudos-9.0-minimal-aarch64.tar)[Checksum](https://mirrors.opencloudos.tech/opencloudos/9.0/isos/aarch64/CHECKSUM)[YumRepo](https://mirrors.opencloudos.tech/opencloudos/9.0/) |
| Stream 23 | x86_64 | [Boot](https://mirrors.opencloudos.tech/opencloudos-stream/releases/23/images/x86_64/OpenCloudOS-Stream-23-20230301-x86_64-netinst.iso)[DVD](https://mirrors.opencloudos.tech/opencloudos-stream/releases/23/images/x86_64/OpenCloudOS-Stream-23-20230301-x86_64-everything.iso)[QCOW2](https://mirrors.opencloudos.tech/opencloudos-stream/releases/23/images/x86_64/OpenCloudOS-Stream-23-20230301-x86_64.qcow2)[Containers](https://mirrors.opencloudos.tech/opencloudos-stream/releases/23/images/x86_64/OpenCloudOS-Stream-23-20230301-x86_64-mini-docker.tar)[YumRepo|](https://mirrors.opencloudos.org/opencloudos-stream/releases/23/)[Checksum](https://mirrors.opencloudos.org/opencloudos-stream/releases/23/images/checksum.txt)[](https://mirrors.opencloudos.tech/opencloudos-stream/ "YumRepo") |
| Stream 23 | aarch64 | [Boot](https://mirrors.opencloudos.tech/opencloudos-stream/releases/23/images/aarch64/OpenCloudOS-Stream-23-20230301-aarch64-netinst.iso)[DVD](https://mirrors.opencloudos.tech/opencloudos-stream/releases/23/images/aarch64/OpenCloudOS-Stream-23-20230301-aarch64-everything.iso)[QCOW2](https://mirrors.opencloudos.tech/opencloudos-stream/releases/23/images/aarch64/OpenCloudOS-Stream-23-20230301-aarch64.qcow2)[Containers](https://mirrors.opencloudos.tech/opencloudos-stream/releases/23/images/aarch64/OpenCloudOS-Stream-23-20230301-aarch64-mini-docker.tar)[YumRepo|](https://mirrors.opencloudos.org/opencloudos-stream/releases/23/)[Checksum](https://mirrors.opencloudos.org/opencloudos-stream/releases/23/images/checksum.txt)[](https://mirrors.opencloudos.tech/opencloudos-stream/ "YumRepo") |

**当您下载和使用 OpenCloudOS 时,OpenCloudOS 项目邀请您[作为贡献者加入社区](https://lists.opencloudos.org/g/main "作为贡献者加入社区") 。可以通过多种方式为项目做出贡献,从文档、QA和测试到SIG 的代码更改、提供镜像以及帮助其他用户等。**

**欢迎扫描页面底部二维码添加社区助理(微信号:OpenCloudOS)加入技术交流群。**
7 changes: 7 additions & 0 deletions docs/download/mirrors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
OpenCloudOS 欢迎新的镜像站,如果您正在考虑为 OpenCloudOS 建立一个公共镜像站点,请遵循镜像指南以确保您的镜像与其他镜像站点保持一致。有任何问题,欢迎扫描页面底部二维码添加社区助理(微信号:OpenCloudOS)与我们联系。

| 镜像源名称 | 地点 | 赞助 | 同步 | FTP |
| -------------------------------------------------------------------------------------------------------------------------------------------------- | ---- | ----------------------------------------------- | ---- | --- |
| [OpenCloudOS](https://mirrors.opencloudos.tech/opencloudos/ "OpenCloudOS"){:target="_blank"} | 中国 | ![1685357908856](image/mirrors/1685357908856.png) |||
| [Peking University](http://mirrors.pku.edu.cn/opencloudos/ "北京大学"){:target="_blank"} | 中国 | ![1685357912756](image/mirrors/1685357912756.png) |||
| [Shanghai Jiao Tong University](https://s3.jcloud.sjtu.edu.cn/899a892efef34b1b944a19981040f55b-oss01/rsync/opencloudos/listing-1679018496/index.html){:target="_blank"} | 中国 | ![1685357917079](image/mirrors/1685357917079.png) |||
Loading

0 comments on commit 3cb3e51

Please sign in to comment.