21 Star 59 Fork 58

openEuler/openeuler-docker-images

Create your Gitee Account
Explore and code with more than 13.5 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
MulanPSL-2.0

中文 | English

openEuler Official Container Images

Introduction

Dockerfiles for openEuler official container images, include openEuler basic image and application images.

Related Links

Base Images

The base images of openEuler are officially released by the community and are currently available at openEuler repo. The latest tag represents the latest available long-term stable image.

Once the official images are released, they will be synchronized and pushed to various remote container image repositories, as detailed below:

1. Repository and Image Name

The {repository/name} for the base image on third-party image hubs is openeuler/openeuler

2. Supported Tags

3. Contents

Base/openeuler/Dockerfile

Application Images

Images for various popular application implementations based on openEuler base images.

1. Repository and Image Name

The {repository/name} for the application images on third-party image hubs is openeuler/[application name]

2. Contents

Application images are categorized into seven types based on scenarios, and the image building files are stored in corresponding scenario directories:

  • Bigdata: Bigdata/
  • AI: AI/
  • Distributed Storage: Storage/
  • Database: Database/
  • Cloud Service: Cloud/
  • Distroless: Distroless/
  • High-Performance Computing: HPC/
  • Others: Others/

2.1 Overall Directory

Due to the complexity of application image functionalities, the depth of the directory is uncertain. The overall directory is as follows:

openeuler-docker-images/
└── AI/
    |── image-list.yml
	|── OPEA/
	|    |── AudioQnA/
	|	 |    └── Image_1/
	|	 |    └── Image_2/
	|	 └── DocSum/
	|	      └── Image_3/
	|	      └── Image_4/
	|		  └── Image_5/
	|───Image6/
	└───Image7/

Each scenario directory must contain an image-list.yml to describe the roots for each application image's minimum directory unit (MDU) (i.e., all Image_i/s in the example), image-list.yml is formatted as follows:

# AI/image-list.yml
images:
	Image_1: AI/OPEA/AudioQnA/Image_1/  # root path to Image_1
	Image_2: AI/OPEA/AudioQnA/Image_2/
	Image_3: AI/OPEA/DocSum/Image_3/
	Image_4: AI/OPEA/DocSum/Image_4/
	Image_5: AI/OPEA/DocSum/Image_5/
	Image_6: Image_6/
	Image_7: Image_7/

The existence of image-list.yml:

  • Helps check the integrity of the image directory.
  • Facilitates the listing of application images in openEuler Software Center.

2.2 Minimum Directory

This repository requires the minimum directory unit Image_i/ to strictly follow the structure below:

# here, Image_i == nginx
nginx/
	|── README.md
	|── meta.yml
	|── doc/ (optional)
	|    |── picture/
	|	 |    └── logo.png
	|	 └── image-info.yml
	└── 1.27.2/
	     |── 24.03-lts
		 |    └── Dockerfile
		 |── 22.03-lts-sp4
		 |    └── Dockerfile
	     |── 22.03-lts-sp3
		 |    └── Dockerfile
	     └── 22.03-lts-sp1
		      └── Dockerfile

In each MDU Image_i/, the following contents must be included:

  • Dockerfile

    The storage path is [application version]/[openEuler version]/Dockerfile. For example, the Dockerfile for the nginx application image version 1.27.1 based on openEuler 22.03-lts-sp1 is located at 1.27.1/22.03-lts-sp1/Dockerfile.

    Specifically, for complex software stack application container images, to accurately express their dependencies, the application version in the Dockerfile storage path can be described as the complete software stack version number. For example, in PyTorch root path: 2.1.0-cann7.0.RC1.alpha002/22.03-lts-sp2/Dockerfile stores the Dockerfile for the pytorch 2.1.0 version application image based on cann7.0.RC1.alpha002 and openEuler 22.03-lts-sp2 (AI container image tags can refer to oEEP-0014).

  • README.md

    The README should cover the following information in order:

    • Quick reference: Relevant link information
    • [Application Name] | openEuler: Description of the application's functionality
    • Supported tags and respective Dockerfile links: Description of the current application container image tags and Dockerfile links; must be updated when new images are added
    • Usage: Description of how to use the application container image, ideally including a simple runnable test case
    • Question and answering: Provide Issue links

    The README will be published to the Overview or Description section of the third-party Hub image detail page; contributions via PR should be taken seriously.

  • meta.yml

    This file describes the tag information and Dockerfile storage paths for each image, located at: [application name]/meta.yml. The file format is as follows:

    # spark/meta.yml
    3.3.1-oe2203lts: 
    	path: spark/3.3.1/22.03-lts/Dockerfile
    3.3.2-oe2203lts:
    	path: spark/3.3.2/22.03-lts/Dockerfile
    	arch: aarch64
    

    In the above example, each pair of <key, value> contains image's publishing configuration, it's as follows:

    • key: Represents the image tag, with a recommended naming format of: [application version]-[openeuler version], such as 3.3.1-oe2203lts and 3.3.2-oe2203lts, indicating different tags of the openeuler/spark.

    • value: Describes how to build the image, explained as follows:

      Configuration description:

      Configuration Item Required Description Example
      path yes Relative path of the image dockerfile spark/3.3.1/22.03-lts/Dockerfile
      arch optional Specifies the architecture when releasing a single-architecture image, optional x86_64 or aarch64
      if not filled, a dual-architecture image for both x86_64 and aarch64 will be released by default
      x86_64

    *Note: When updating the image tag, the above configuration must also be updated.

  • (Optional) doc/

    This directory stores graphic and textual information about the image for display in openEuler Software Center's application image section. If it is not to be displayed in openEuler Software Center, this section can be omitted.

    • doc/image-info.yml

      The content is as follows:

        name
        category (options: bigdata, ai, storage, database, cloud, hpc, others)
        description
        environment
        tags
        download
        usage
        license
        similar_packages
        dependency
      
    • doc/picture/

      Store application-related images, such as application logos or runtime screenshots of typical scenes.

    *Note: The files and contents in the above doc/ directory must exist simultaneously for the image to be displayed correctly in openEuler Software Center.

Available Container Registries

Available container registries included:

  1. hub.oepkgs.net
  2. hub.docker.com
  3. quay.io

For example, users can obtain the base image openeuler/openeuler:latest by the following commands

# pull image from hub.oepkgs.net
docker pull hub.oepkgs.net/openeuler/openeuler:latest

# pull image from hub.docker.com
docker pull docker.io/openeuler/openeuler:latest

# pull from quay.io
docker pull quay.io/openeuler/openeuler:latest

Contributions

Welcome to contribute openEuler application container images, please submit PR according to the above rules. Once the PR is passed and merged, the automatically publishing process will be triggered, and these images will be published to available container registries mentioned above!

Code check instruction:

  1. EulerPublisher is used to build, check and publish container images.
  2. All test cases of application container images are stored in /tests/container/app. Developers who want to publish container images can also submit test cases to EulerPublisher.
  3. When the PR in which you add or modify a Dockerfile is merged, a new image will be automatically published or the existing image will be updated.
  4. When the PR in which you add or modify a README.md is merged, the README.md will be synchronously published to the third-party Hubs.
  5. Published images generally cannot be removed, even if they are no longer updated or maintained, as users may still be using them. Therefore, in special cases where an image needs to be removed, please create an issue providing the tag of the image to be removed and the reason for removal, and contact the maintainer.
木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

About

Dockerfiles for openEuler official basic and application images. expand collapse
Cancel

Releases

No release

Contributors

All

Activities

can not load any more
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openeuler/openeuler-docker-images.git
git@gitee.com:openeuler/openeuler-docker-images.git
openeuler
openeuler-docker-images
openeuler-docker-images
master

Search