From dfb4684fcc744ce11b96e6b3b66a12bc0a8cb977 Mon Sep 17 00:00:00 2001 From: wjunLu Date: Thu, 22 Feb 2024 16:39:45 +0800 Subject: [PATCH 1/2] Add `category` for redis --- redis/doc/image-info.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/redis/doc/image-info.yml b/redis/doc/image-info.yml index e92c2bca..a296b27b 100644 --- a/redis/doc/image-info.yml +++ b/redis/doc/image-info.yml @@ -1,4 +1,5 @@ name: redis +category: database description: Redis（Remote Dictionary Server）是一个使用 ANSI C 编写的开源、支持网络、基于内存、分布式、可选持久性的键值对存储数据库。 environment: " 本应用以容器镜像的方式供用户使用，运行于预置docker的Linux环境。Docker的推荐安装方式如下： -- Gitee From e99ded951ff038ce3bdd52ad9a460ce43f938d9b Mon Sep 17 00:00:00 2001 From: wjunLu Date: Thu, 22 Feb 2024 19:45:12 +0800 Subject: [PATCH 2/2] Add `doc` description --- README.en.md | 46 +++++++++++++++++++++++++++++++++++++--------- README.md | 18 ++++++++++++++++++ 2 files changed, 55 insertions(+), 9 deletions(-) diff --git a/README.en.md b/README.en.md index dd8d8c52..75db853c 100644 --- a/README.en.md +++ b/README.en.md @@ -18,14 +18,21 @@ After the official images are published, we will push to every remote container - Download: `docker pull [Remote repo URL]openeuler/openeuler[:tags]` - Support arch: amd64, arm64 - Tags: - - [21.09](https://repo.openeuler.org/openEuler-21.09/docker_img/) - - [20.09](https://repo.openeuler.org/openEuler-20.09/docker_img/) - - [20.03-lts](https://repo.openeuler.org/openEuler-20.03-LTS/) - - [20.03-lts-sp1, 20.03](https://repo.openeuler.org/openEuler-20.03-LTS-SP1/docker_img/) - - [20.03-lts-sp2](https://repo.openeuler.org/openEuler-20.03-LTS-SP2/docker_img/) - - [20.03-lts-sp3](https://repo.openeuler.org/openEuler-20.03-LTS-SP3/docker_img/) - - [21.03](https://repo.openeuler.org/openEuler-21.03/docker_img/) - - [22.03-lts, 22.03, latest](https://repo.openeuler.org/openEuler-22.03-LTS/docker_img/) + - [20.03-lts](https://repo.openeuler.org/openEuler-20.03-LTS/docker_img/) + - [20.03-lts-sp1](https://repo.openeuler.org/openEuler-20.03-LTS-SP1/docker_img/) + - [20.03-lts-sp2](https://repo.openeuler.org/openEuler-20.03-LTS-SP2/docker_img/) + - [20.03-lts-sp3](https://repo.openeuler.org/openEuler-20.03-LTS-SP3/docker_img/) + - [20.03-lts-sp4, 20.03](https://repo.openeuler.org/openEuler-20.03-LTS-SP4/docker_img/) + - [20.09](https://archives.openeuler.openatom.cn/openEuler-20.09/docker_img/) + - [21.03](https://archives.openeuler.openatom.cn/openEuler-21.03/docker_img/) + - [21.09](https://archives.openeuler.openatom.cn/openEuler-21.09/docker_img/) + - [22.03-lts](https://repo.openeuler.org/openEuler-22.03-LTS/docker_img/) + - [22.09](https://archives.openeuler.openatom.cn/openEuler-22.09/docker_img/) + - [22.03-lts-sp1](https://repo.openeuler.org/openEuler-22.03-LTS-SP1/docker_img/) + - [22.03-lts-sp2](https://repo.openeuler.org/openEuler-22.03-LTS-SP2/docker_img/) + - [22.03-lts-sp3, 22.03, latest](https://repo.openeuler.org/openEuler-22.03-LTS-SP3/docker_img/) + - [23.03](https://repo.openeuler.org/openEuler-23.03/docker_img/) + - [23.09](https://repo.openeuler.org/openEuler-23.09/docker_img/) - Path rule：`openeuler/[openEuler version]/Dockerfile`, such as: openEuler 21.09 Dockerfile is under `openeuler/21.09/Dockerfile` path. @@ -35,8 +42,9 @@ Dockerfiles for various popular application implementations based on openEuler b - Path rule：`[Application name]/[Application version]/[openEuler version]/Dockerfile`, such as, the nginx 1.20.1 based on openEuler 20.03 LTS SP1 is under `nginx/1.20.1/20.03-lts-sp1/Dockerfile`. +In particular, for application container images of complex software stacks, in order to accurately express their dependencies, the `[application version number]` in the Dockerfile storage path can be described as the complete software stack version, for example: `pytorch/2.1.0-cann7 .0.RC1.alpha002/22.03-lts-sp2/Dockerfile` stores the pytorch 2.1.0 application image Dockerfile based on cann7.0.RC1.alpha002 and openEuler 22.03-lts-sp2. - The container images would be published after Dockerfile merged under `openeuler`, -such as: `openeuler/nginx:1.20.1-20.03-lts-sp1`. +such as: `openeuler/nginx:1.20.1-oe2003sp1`. All openEuler application images contain a README (such as nginx/README.md), included: @@ -48,6 +56,26 @@ The build steps are as follows: - go into directory of `[Application name]/[Application version]/[openEuler version]` - execute the command `docker buildx build -t tag_name --platform linux/amd64,linux/arm64 .` +All openEuler application images contain a `doc/` directory, which stores the graphic and text information of the image: + +- `doc/image-info.yml` + +The content is as follows: + + name + category (such as: bigdata, ai, storage, database, cloud, hpc) + description + environment + download + install + license + similar_packages + Dependency + +- `doc/picture/` + +Store application-related images + #### Available Container Repo - Hub oepkgs: https://hub.oepkgs.net/ diff --git a/README.md b/README.md index c8a462a7..b388156a 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,24 @@ openEuler的基础镜像由社区官方发布，目前发布在[openEuler镜像 - 切换到`[应用名]/[应用版本号]/[openEuler版本号]`目录 - 执行`docker buildx build -t tag_name --platform linux/amd64,linux/arm64 .` +每个应用镜像，包含一个`doc/`目录，存放该镜像的图文信息： +- `doc/image-info.yml` + + 内容如下： + + 名称（name） + 分类（category），共6大类：大数据（bigdata）、AI（ai）、分布式存储（storage）、数据库（database）、云服务（cloud）、HPC（hpc） + 功能简介（description） + 运行环境（environment） + 获取方式（download） + 使用方式（install） + LICENSE（license） + 近似软件（similar_packages） + 依赖软件（dependency） + +- `doc/picture/` + + 存放应用相关的图片 #### 国内镜像仓 -- Gitee