Skip to content

Commit

Permalink
doc: update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
WGrape committed Mar 13, 2024
1 parent 42363e8 commit 83478c8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .work/extra/doc/1.WHY_SPARROW_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,12 @@ In the end, the `docker-compose.yml` file becomes messy, long, and difficult to
Sparrow is a containerized orchestration tool based on Docker for one-click starting of multiple service environments. It has many powerful features, including but not limited to:

- Images Remote Hosting: Service images are uploaded to the repository with one click, for unified remote hosting.
- Configurable management: All configurations such as image versions, service ports, extension plugins are configurable.
- Multi-service support: Supports the simultaneous access of dozens or even more services.
- One-click service management: One command can quickly start, stop, and manage all services.
- Namespace mechanism: Supports the startup of multiple containers with different identities through the namespace mechanism, achieving service multi-version and environment isolation.
- Ready-to-use Services: MySQL, Prometheus, Kafka, Elasticsearch, and dozens of other services are ready to use out of the box, and can quickly integrate new services.
- Comprehensive toolchain: Provides new service creation, service (image) updates, service (container and image) cleanup, image uploading, uniform allocation of port numbers, quick entry into containers, and command prompts.
- Container hook callbacks: Each container provides hook callbacks such as `before_start/after_start/before_stop/after_stop`, common scenarios include automatically creating some databases after Mysql starts.

Expand Down
6 changes: 4 additions & 2 deletions .work/extra/doc/1.WHY_SPARROW_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,18 @@
sparrow是基于Docker一键启动多个服务环境的容器化编排工具,它具有如下等众多强大的功能 :

- 镜像远程托管 :服务镜像一键上传到仓库,统一远程托管
- 配置化的管理 :镜像版本、服务端口、扩展插件等全部配置化
- 多服务的支持 :可以同时支持十几个、几十个、甚至更多服务的接入
- 服务一键管理 :一条命令即可对所有服务进行一键式快速启动、停止等管理
- 命名空间机制 :通过命名空间机制,支持启动多个分身的容器,实现服务的多版本和环境隔离
- 服务开箱即用 :mysql、prometheus、kafka、ES等几十个服务开箱即用,而且可以快速接入新的服务
- 完善的工具链 :提供了新服务创建、服务(镜像)更新、服务(容器和镜像)的清除、镜像的上传、端口号统一分配、容器的快速进入和命令提示等
- 容器钩子回调 :每一个容器都提供了```before_start/after_start/before_stop/after_stop```等钩子回调,常用场景比如在Mysql启动后自动创建一些数据库等需求。

## 3、sparrow 应用场景 / 解决了什么问题

- 规范化的环境管理 :无论有多少个不同类型的服务环境,都使用了一种规范的方式管理,井井有条
- 高效化的服务管理 :无论是从使用上来说,还是从开发新功能上来说,强大和完善的工具链都可以帮助你高效完成服务的管理
- 同一服务的多版本 :支持一个服务多个版本,比如在一台机器上同时启动Redis的4.0版本、5.0版本、6.0版本等
- 服务的环境隔离 :支持在一台服务器上启动多个不同的隔离环境,比如在一台机器上同时构建出dev、test、beta不同环境
- 多版本的服务管理 :支持一个服务多个版本,比如在一台机器上同时启动Redis的4.0版本、5.0版本、6.0版本等
- 多环境的服务隔离 :支持在一台服务器上启动多个不同的隔离环境,比如在一台机器上同时构建出dev、test、beta不同环境

0 comments on commit 83478c8

Please sign in to comment.