diff --git a/translation-projects/README-optimization/optimized-README/cloudnative.README.en.md b/translation-projects/README-optimization/optimized-README/cloudnative.README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..2decc51fc4b924acdc7d3677eb58dfada2148429 --- /dev/null +++ b/translation-projects/README-optimization/optimized-README/cloudnative.README.en.md @@ -0,0 +1,147 @@ +# CloudNative SIG + +## Mission and Vision +CloudNative SIG is committed to providing a convenient and easy-to-use cloud native infrastructure for users, developers, and enthusiasts, providing a simple and efficient cloud native application development hosting environment to build cloud native ecosystem. + +## Objectives and Scope + +- Responsible for the technology decisions of cloud native in community +- Responsible for the planning, maintenance and upgrade of cloud native related packages +- Respond to user feedback from software within the SIG in time to solve related issues + +## SIG Documents +- [Documents](docs/README.md) + +## SIG Meetings +- Every biweekly Tuesday from 4:00-5:30 p.m +- Declare the issue by email + + +## Members + +### Maintainers + +| [@caihaomin](https://gitee.com/caihaomin) | [@yangzhao_kl](https://gitee.com/yangzhao_kl) | [@jianminw](https://gitee.com/jianminw) | [@weibaohui](https://gitee.com/weibaohui) | [@biannm](https://gitee.com/biannm) | [@pixiake](https://gitee.com/pixiake) | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| 图片名称 | @yangzhao_kl | @jianminw | @weibaohui | @biannm | @pixiake | + +### Committers + +| **[@jingxiaolu](https://gitee.com/jingxiaolu)** | [@leizhongkai](https://gitee.com/leizhongkai) | [@jing-rui](https://gitee.com/jing-rui) | [@flyflyflypeng](https://gitee.com/flyflyflypeng) | [@lifeng2221dd1](https://gitee.com/lifeng2221dd1) | [@duguhaotian](https://gitee.com/duguhaotian) | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| @jingxiaolu | @leizhongkai | @jing-rui | @flyflyflypeng | @lifeng2221dd1 | @duguhaotian | + + +### Contact Us + +- Mailing list: cloudnative@openeuler.org + + +## Project list + +### Orchestration & Management + +| Project | Version | State | Category | +| -------------------------------------------------------- | ------- | ---------- | -------------------------------- | +| [kubernetes](https://gitee.com/src-openeuler/kubernetes) | 1.20.2 | Introduced | Scheduling & Orchestration | +| [etcd](https://gitee.com/src-openeuler/etcd) | 3.4.14 | Introduced | Coordination & Service Discovery | +| [coredns](https://gitee.com/src-openeuler/coredns) | 1.7.0 | Introduced | Coordination & Service Discovery | + + +### Runtime + +| Project | Version | State | Category | +| ------------------------------------------------------------ | ------------ | ----------- | ------------------------- | +| [iSulad](https://gitee.com/src-openeuler/iSulad) | 2.0.9 | Introduced | Container Engine | +| [lxc](https://gitee.com/src-openeuler/lxc) | 4.0.3 | Introduced | Container Runtime | +| [lcr](https://gitee.com/src-openeuler/lcr) | 2.0.5 | Introduced | Container Runtime | +| [clibcni](https://gitee.com/src-openeuler/clibcni) | 2.0.4 | Introduced | iSulad Network Components | +| [docker](https://gitee.com/src-openeuler/docker) | 18.09.0 | Introduced | Container Engine | +| [containerd](https://gitee.com/src-openeuler/containerd) | 1.2.0 | Introduced | Container Runtime | +| [runc](https://gitee.com/src-openeuler/runc) | 1.0.0-rc3 | Introduced | Container Runtime | +| [kata-containers](https://gitee.com/src-openeuler/kata-containers) | 2.1.1/1.11.1 | Introduced | Container Runtime | +| [libnetwork](https://gitee.com/src-openeuler/libnetwork) | 0.8.0-dev | Introduced | Docker Network Components | +| [containernetworking-plugins](https://gitee.com/src-openeuler/containernetworking-plugins) | 0.8.6 | Introduced | CNI Container Network | +| [cri-o](https://gitee.com/src-openeuler/cri-o) | | Coming soon | Container Runtime | +| [cri-tools](https://gitee.com/src-openeuler/cri-tools) | | Coming soon | Engine CRI Tools | +| [gvisor](https://gitee.com/src-openeuler/gvisor) | | Coming soon | Container Runtime | +| [crun](https://gitee.com/src-openeuler/crun) | | Coming soon | Container Runtime | +| [catatonit](https://gitee.com/src-openeuler/catatonit) | | Coming soon | Container Runtime | + + +### Application Definition & Development + +| Project | Version | State | Category | +| ------------------------------------------------------------ | ------- | ----------- | ------------------------------------ | +| [isula-build](https://gitee.com/src-openeuler/isula-build) | 0.9.5 | Introduced | Application Definition & Image Build | +| [operator-manager](https://gitee.com/openeuler/operator-manager) | 2 | Prepared | Application Definition & Image Build | +| [docker-compose](https://gitee.com/src-openeuler/docker-compose) | 1.22.0 | Introduced | Application Definition & Image Build | +| [podman](https://gitee.com/src-openeuler/podman) | 1.0.10 | Introduced | Application Definition & Image Build | +| [skopeo](https://gitee.com/src-openeuler/skopeo) | 1.1.0 | Introduced | Application Definition & Image Build | +| [kubevirt](https://gitee.com/src-openeuler/kubevirt) | | Coming soon | Application Definition & Image Build | + + +### Monitoring, Analysis & Tracking + +| Project | Version | State | Category | +| ------------------------------------------------------------ | ------- | ----------- | ------------------------------ | +| [prometheus](https://gitee.com/src-openeuler/prometheus) | 2.20.0 | Introduced | Monitoring, Analysis &Tracking | +| [promu](https://gitee.com/src-openeuler/promu) | 0.7.0 | Prepared | Monitoring, Analysis &Tracking | +| [cadvisor](https://gitee.com/src-openeuler/cadvisor) | 0.37.0 | Prepared | Monitoring, Analysis &Tracking | +| [alertmanager](https://gitee.com/src-openeuler/alertmanager) | 0.21.0 | Prepared | Monitoring, Analysis &Tracking | +| [node_exporter](https://gitee.com/src-openeuler/node_exporter) | 1.0.1 | Introduced | Monitoring, Analysis &Tracking | +| [virt-what](https://gitee.com/src-openeuler/virt-what) | 1.2 | Introduced | Monitoring, Analysis &Tracking | +| [gluster_exporter](https://gitee.com/src-openeuler/gluster_exporter) | 0.2.7 | Prepared | Monitoring, Analysis &Tracking | +| [haproxy_exporter](https://gitee.com/src-openeuler/haproxy_exporter) | | Coming soon | Monitoring, Analysis &Tracking | +| [influxdb_exporter](https://gitee.com/src-openeuler/influxdb_exporter) | | Coming soon | Monitoring, Analysis &Tracking | +| [memcached_exporter](https://gitee.com/src-openeuler/memcached_exporter) | | Coming soon | Monitoring, Analysis &Tracking | +| [pushgateway](https://gitee.com/src-openeuler/pushgateway) | 1.4.1 | Prepared | Monitoring, Analysis &Tracking | + + +### Installation & Deployment + +| Project | Version | State | Category | +| ---------------------------------------- | ------- | -------- | ------------------------- | +| [eggo](https://gitee.com/openeuler/eggo) | 0.9.1 | Prepared | Installation & Deployment | + + +### Services + +| Project | Version | State | Category | +| ------------------------------------------------------------ | ------- | ----------- | ----------------------------- | +| [harbor](https://gitee.com/src-openeuler/harbor) | | Coming soon | Container, Image & Repository | +| [containers-common](https://gitee.com/src-openeuler/containers-common) | | Coming soon | Automation & Configuration | + + +### Dependent Component + +| Project | Version | State | Remarks | +| ------------------------------------------------------------ | ------- | ---------- | -------------------------------- | +| [protobuf](https://gitee.com/src-openeuler/protobuf) | 3.14.0 | Introduced | Dependent Component | +| [iSulad-img](https://gitee.com/openeuler/iSulad-img) | 2.0.1 | Introduced | iSulad 1.x Image Management Tool | +| [busybox](https://gitee.com/src-openeuler/busybox) | 1.31.1 | Introduced | Dependent Component | +| [kata_integration](https://gitee.com/src-openeuler/kata_integration) | 1.0.0 | Introduced | Kata Build Project | +| [docker-client-java](https://gitee.com/src-openeuler/docker-client-java) | 8.11.7 | Introduced | Dependent Component | +| [container-selinux](https://gitee.com/src-openeuler/container-selinux) | 2.138 | Introduced | Docker SELinux Policy | +| [jboss-parent](https://gitee.com/src-openeuler/jboss-parent) | 20-1 | Introduced | Dependent Component | +| [libevhtp](https://gitee.com/src-openeuler/libevhtp) | 1.2.18 | Introduced | Dependent Component | +| [libcgroup](https://gitee.com/src-openeuler/libcgroup) | 0.42.2 | Introduced | Dependent Component | + + +## Note + +| State | Remarks | +| ----------- | ------------------------------------------------------------ | +| Introduced | The component has been introduced into the openEuler release. | +| Prepared | The project has been created in the Gitee and the code has been prepared. The component is to be introduced to the openEuler release. | +| Coming soon | The repository is not created in the Gitee. | + + +## Rodemap + +- 01/2021: The SIG is established +- 30/06/2021(20.03 SP2): Automatic Installation Set; Container Image Repository; Lightweight Virtualization Stratovirt; iSulad shimV2 +- 30/09/2021 (21.09 Innovation): OLM/Operator/helm Hub; Container OS; Confidential Container; Application Sandbox WASM; High-performance Container Storage +- 30/12/2021 (20.03 SP2): Isula-build supports the Operator Framework/SDK; Volcano scheduling enhancement algorithm; Stratovirt Standard VM +- 30/03/2022 (22.03 LTS): Cloudnative Application Market; Cloudnative Application Development Suite; A-OPS servitization; openDonau ; High-performance Data Plane Framework; Ebpf Network Acceleration +- ... \ No newline at end of file diff --git a/translation-projects/README-optimization/optimized-README/ha-api.README.en.md b/translation-projects/README-optimization/optimized-README/ha-api.README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..bae1fe448135b75f64f3d989a6bdbc273b975ff4 --- /dev/null +++ b/translation-projects/README-optimization/optimized-README/ha-api.README.en.md @@ -0,0 +1,49 @@ +# ha-api + +## Introduction +REST API backend for HA manage platform. + +Another project is [HA-web](https://gitee.com/openeuler/ha-web), providing frontend UI for HA manage platform. + +## Screenshots + +TODO: add some screenshots here + +## Features + +Easy to use. + +## Documents + +The following documents are provided to help you understand the project: + - [Build Document](./docs/build_en.md) + - [Architecture Document](./docs/architecture_en.md) + - [API Document](./docs/api_en.md) + +## Installation + +HA software is needed to run backend of ha-api manage platform . + +In openEuler 20.03 LTS SP1, you can install HA software by yum: + +``` +[root@ha1~]# yum install corosync pacemaker pcs fence-agents fence-virt corosync-qdevice sbd drbd drbd-utils +``` + +For another OS, you may need to compile it and then install. +You can get more details in [install documents](./docs/install_en.md) and [build documents](./docs/build_en.md) + +## Contribution + +HA-api is developed with golang. We use [Beego framework](https://beego.me/) to help us to develop high performance and reliable manage platform. All contributions are welcomed. If you have any problems in using or developing, please contact us by submitting a issue. + + +## Gitee Feature + +1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md +2. Gitee blog: [blog.gitee.com](https://blog.gitee.com) +3. You can explore open source project: [https://gitee.com/explore](https://gitee.com/explore) +4. The Gitee Most Valuable Project ([GVP](https://gitee.com/gvp)), the excellent open source project comprehensively evaluated by Gitee +5. The manual of Gitee: [https://gitee.com/help](https://gitee.com/help) +6. The most popular Gitee members: [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) + diff --git a/translation-projects/README-optimization/translated-README/embedded.README.en.md b/translation-projects/README-optimization/translated-README/embedded.README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..0e766fd8af14f1c3bf0ca37e3ae5e1d0fc8576bd --- /dev/null +++ b/translation-projects/README-optimization/translated-README/embedded.README.en.md @@ -0,0 +1,116 @@ +# embedded + +#### 1 Introduction + +This openEuler version supports embedded devices and currently supports [aarch64|x86_64] CPU architectures + +#### 2 Compilation Instructions + +The compilation entry: build.sh + +```Usage: +Usage: + +./build.sh -a [aarch64|x86_64] -r [repo] -d [work dir] -p [live|virtual|disk|docker] -t [rpm|image|all] +``` + +The role of each parameter is described as follows. + +1）-r，specifies the repo file, in the format of the dnf/yum, see [Document 1](https://docs.openeuler.org/zh/docs/20.03_LTS/docs/Administration/%E4%BD%BF%E7%94%A8DNF%E7%AE%A1%E7%90%86%E8%BD%AF%E4%BB%B6%E5%8C%85.html "使用DNF管理软件包"). + +2）-d，specifies the working directory used in the compilation process, where all intermediate files and the results are stored. As the compilation process requires a large amount of disk space, this directory should be located on a disk with **more than 20G** remaining space. + +3）-p，specifies the type of image to be compiled, currently docker image is stably supported. + +4）-t，specifies the compilation type, "rpm" means compile the rpm repository according to the source code and patch; "image" means compile the specified image according to the given repo; "all" will execute the compilation process specified by rpm and image in order. + +5）-a，no need to specify, set aside parameters to support cross-compilation. + +The structure of the working directory (-d specified parameter) during normal compilation is as follows. + +``` +allsrcpath.list // list of packages to be compiled according to package_conf.xml +image/ // the location of image and its description file +kiwiconfig/ +logs_1.tar.gz // package compilation logs for rounds 1/2 +logs_2.tar.gz // package compilation logs for rounds 2/2 +openeuler.repo +rpms/ // the directory where the rpm package is compiled, which can be referenced as a repo source +src/ // download and patch the package source files according to the configuration file +``` + +**Note: if the compiled session (login terminal) is prone to disconnections, perform compilation in a manner similar to ```nohup sh build.sh -r ... > log.txt 2>&1 &```** to avoid compilation interruption caused by disconnection. + +#### 3 Configuration File Description + +The configuration files are located in the config directory： + +``` +kiwiconf/ +openeuler.repo +package_conf.xml +``` + +1） ```kiwiconf/```，stores the configuration file required for the kiwicompat command. No changes are normally required. + +For the format of the config. XML file, see [Document 2](https://documentation.suse.com/kiwi/9/single-html/kiwi/index.html#image-description-elements "image-description-elements"), [Document 3](https://documentation.suse.com/kiwi/9/html/kiwi/image-description.html "image-description"). + +After creating the system directory kiwi, calls images.sh. This script can be used to trim unnecessary files from the root directory or to make some system settings. Some of the predefined functions and variables to the script are described in [Document 4](https://documentation.suse.com/kiwi/9/single-html/kiwi/index.html#script-template-for-config-sh-images-sh "script-template-for-config-sh-images-sh"). + +2）```openeuler.repo```，the reserved repo file, generally used in the `-r` parameter of build.sh. + +3）```package_conf.xml```，the package configuration that needs to be patched with git format-patch and to be compiled for source code, with an example to illustrate the role of each tag. + +``` + + + argon2 + https://gitee.com/openeuler-embedded/argon2 + openEuler-20.03-LTS + ../src/patch/argon2.patch + 1 + + + attr + https://gitee.com/openeuler-embedded/attr + openEuler-20.03-LTS + ../src/patch/attr.patch + 1 + + ...... +``` + +#### 4 Example of Image Usage + +Take the docker image as an example, the image is located in the image path of the working directory named openEuler-embedded.xxx-xxx.docker.tar.xz. + +```shell +docker load -i openEuler-embedded.xxx-xxx.docker.tar.xz +docker run --rm --privileged --name embedded-test -v `pwd`:/data -itd openeuler-embedded init +docker exec -it embedded-test bash +``` + +#### 5 Dependencies + +1）kiwi >= 9.21 + +2）docker/chroot/createrepo/xmllint/openssl + +#### 6 TODO + +As of now, rpm package compilation and docker image creation is working stably. + +Further improve: + +1）diversification support, such as virtual machine images and embedded device images, etc. + +2）rpm build scheduling module to build all packages correctly based on automatically identified dependencies. + +3）cross-compilation support + +#### 7 Contributions + +1. Fork this repository +2. Create a new Feat_xxx branch +3. Commit code +4. Create a new Pull Request \ No newline at end of file