diff --git a/README.md b/README.md index a7f3c30..fdae64f 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ ``` image/ 自建镜像:每个目录 = Dockerfile + build.sh,目录名即镜像 tag app/ 部署编排:每个目录 = docker-compose.yml + install.sh / shutdown.sh + run.md(+demo.png) +demo/ 使用示例:如何用 image/ 的镜像构建、部署应用,见 demo/README.md ``` ### 使用约定 @@ -29,7 +30,7 @@ app/ 部署编排:每个目录 = docker-compose.yml + install.sh / shutdown | `image/runtime-dotnet6` | `kenaito:runtime-dotnet6` | 上者 / ASP.NET Core 运行时 6.0.35 | 运行环境,仅运行时 | | `image/runtime-dotnet8` | `kenaito:runtime-dotnet8` | 上者 / ASP.NET Core 运行时 8.0.x | 运行环境,仅运行时 | | `image/runtime-dotnet9` | `kenaito:runtime-dotnet9` | 上者 / ASP.NET Core 运行时 9.0.x | 运行环境,仅运行时 | -| `image/compile-dotnet6` | `kenaito:compile-dotnet6` | 上者 / .NET SDK 6.0.427 | 编译环境(SDK + 编译工具链),两阶段构建示例见 `demo/run.md` | +| `image/compile-dotnet6` | `kenaito:compile-dotnet6` | 上者 / .NET SDK 6.0.427 | 编译环境(SDK + 编译工具链),示例见 [demo/dotnet6](demo/dotnet6/run.md) | | `image/compile-dotnet8` | `kenaito:compile-dotnet8` | 上者 / .NET SDK 8.0.403 | 编译环境(SDK + 编译工具链) | | `image/compile-dotnet9` | `kenaito:compile-dotnet9` | 上者 / .NET SDK 9.0.100-rc.2 | 编译环境(SDK + 编译工具链) | | `image/proxy-tengine3` | `kenaito:proxy-tengine3` | 上者 / Tengine 3.1.0 源码编译 | 反向代理 / Web 服务器,自定义 `nginx.conf` | @@ -66,6 +67,9 @@ app/ 部署编排:每个目录 = docker-compose.yml + install.sh / shutdown 同版本的 ES / MySQL / Agent 三种形态目录并列,按需选择其一部署;ES 形态与 MySQL 形态端口相同,不要同时启动。 +# 使用示例 +- [demo/dotnet6](demo/dotnet6/run.md):`compile-dotnet6` + `runtime-dotnet6` 两阶段构建 .NET 6 Web API 并部署,更多示例见 [demo/README.md](demo/README.md) + # 支持的语言 - dotnet 适用于 dotnet 应用 - 编译:`runtime-dotnet*` 之上的 `compile-dotnet*` diff --git a/demo/README.md b/demo/README.md new file mode 100644 index 0000000..cad8157 --- /dev/null +++ b/demo/README.md @@ -0,0 +1,25 @@ +# 使用示例 + +用 `image/` 下的自建镜像构建、部署应用的完整示例。每个示例目录都是独立可运行的项目(含 Dockerfile、构建与部署脚本、说明文档), +不参与 `image/` 镜像本身的构建,可以直接拷贝出去改造。 + +| 示例 | 使用的镜像 | 说明 | +|----------------------------------------|----------------------------------------------|---------------------------------------------------------| +| [dotnet6](dotnet6/run.md) | `compile-dotnet6` → `runtime-dotnet6` | .NET 6 Web API,两阶段构建:编译镜像出产物、运行镜像只带运行时;含 compose 部署与健康检查 | + +## 运行方式 + +以 dotnet6 为例(每个示例的 `run.md` 有完整说明): + +```shell +cd demo/dotnet6 +sh build.sh # 构建示例镜像 +sh install.sh # 启动 +sh shutdown.sh # 停止 +``` + +## 约定 + +- 示例镜像统一推送到 `registry.cn-shanghai.aliyuncs.com/odboy/kenaito:demo-<名称>`,与 `image/` 的自建镜像区分开 +- 示例所用基础镜像需先按 `image/<目录>/build.sh` 构建并推送 +- 部署示例默认使用 compose,端口与 `app/` 中的部署编排错开(如 dotnet6 用 8080) diff --git a/image/compile-dotnet6/demo/.dockerignore b/demo/dotnet6/.dockerignore similarity index 100% rename from image/compile-dotnet6/demo/.dockerignore rename to demo/dotnet6/.dockerignore diff --git a/image/compile-dotnet6/demo/.gitignore b/demo/dotnet6/.gitignore similarity index 100% rename from image/compile-dotnet6/demo/.gitignore rename to demo/dotnet6/.gitignore diff --git a/image/compile-dotnet6/demo/Demo.csproj b/demo/dotnet6/Demo.csproj similarity index 100% rename from image/compile-dotnet6/demo/Demo.csproj rename to demo/dotnet6/Demo.csproj diff --git a/image/compile-dotnet6/demo/Dockerfile b/demo/dotnet6/Dockerfile similarity index 100% rename from image/compile-dotnet6/demo/Dockerfile rename to demo/dotnet6/Dockerfile diff --git a/image/compile-dotnet6/demo/Program.cs b/demo/dotnet6/Program.cs similarity index 100% rename from image/compile-dotnet6/demo/Program.cs rename to demo/dotnet6/Program.cs diff --git a/image/compile-dotnet6/demo/build.sh b/demo/dotnet6/build.sh similarity index 100% rename from image/compile-dotnet6/demo/build.sh rename to demo/dotnet6/build.sh diff --git a/image/compile-dotnet6/demo/docker-compose.yml b/demo/dotnet6/docker-compose.yml similarity index 100% rename from image/compile-dotnet6/demo/docker-compose.yml rename to demo/dotnet6/docker-compose.yml diff --git a/image/compile-dotnet6/demo/install.sh b/demo/dotnet6/install.sh similarity index 100% rename from image/compile-dotnet6/demo/install.sh rename to demo/dotnet6/install.sh diff --git a/image/compile-dotnet6/demo/run.md b/demo/dotnet6/run.md similarity index 89% rename from image/compile-dotnet6/demo/run.md rename to demo/dotnet6/run.md index 49b4cbb..a7f7803 100644 --- a/image/compile-dotnet6/demo/run.md +++ b/demo/dotnet6/run.md @@ -1,10 +1,10 @@ -# dotnet6 编译 + 运行示例 +# 示例:.NET 6 编译 + 运行 -演示如何用本目录的两个镜像构建一个 .NET 6 Web 应用: +演示如何组合 `image/` 下的两个自建镜像构建一个 .NET 6 Web 应用(本目录是独立示例,不参与镜像构建): | 阶段 | 镜像 | 说明 | |----|-------------------------------------------------------------|-----------------------------| -| 编译 | `registry.cn-shanghai.aliyuncs.com/odboy/kenaito:compile-dotnet6` | 含 SDK 6.0.427(见上级 `Dockerfile`) | +| 编译 | `registry.cn-shanghai.aliyuncs.com/odboy/kenaito:compile-dotnet6` | 含 SDK 6.0.427(见 `image/compile-dotnet6`) | | 运行 | `registry.cn-shanghai.aliyuncs.com/odboy/kenaito:runtime-dotnet6` | 仅含 ASP.NET Core 运行时 6.0.35(见 `image/runtime-dotnet6`) | 编译环境镜像带 SDK 和整套编译工具链(体积大),只在构建阶段使用;运行阶段只拷贝 `dotnet publish` 的产物, @@ -13,14 +13,15 @@ ### 示例内容 ``` -demo/ +demo/dotnet6/ ├── Demo.csproj # net6.0 Web 项目 ├── Program.cs # 最小 Web API:GET / 返回运行时信息,GET /health 健康检查 ├── Dockerfile # 两阶段构建:compile-dotnet6 -> runtime-dotnet6 ├── build.sh # 构建镜像(PUSH=1 时同时推送) ├── docker-compose.yml # 部署编排(端口 8080,固定 IP 172.26.0.20) ├── install.sh # docker-compose up -d -└── shutdown.sh # docker-compose down +├── shutdown.sh # docker-compose down +└── run.md # 本文 ``` ### 构建与部署 diff --git a/image/compile-dotnet6/demo/shutdown.sh b/demo/dotnet6/shutdown.sh similarity index 100% rename from image/compile-dotnet6/demo/shutdown.sh rename to demo/dotnet6/shutdown.sh