Skip to content

Latest commit

 

History

History
176 lines (120 loc) · 9.21 KB

README.md

File metadata and controls

176 lines (120 loc) · 9.21 KB

IDCF 社区共创文档库(boathouse)

IDCF 社区共创介绍

培训及操作手册

boathouse 一期共创

Contributing

IDCF boathouse应用环境及代码存储库介绍

boat-house: 主库(本库)

主要存放基于Boat-house代码库的种实践文档,整个boat-house的共创运作基于此库展开。

IDCF boat-house 主库目录结构

  • docs
    • quick-start,目前存放一期的团队上手文档和工具实践文档
    • lean
    • agile-team
    • agile-scaled
    • devops-e2e-5p,工具实践文档
    • workshops
      • devops-hackathon 黑客马拉松活动实践文档
      • azure-devops 基于微软Azure DevOps平台的BoatHouse流水线持续交付
    • devops-case-studies,案例研究文档
文档库部署

采用 Github Action, 使用 FTP的方式 将此库的MD文件部署至Azure China AppService,访问地址: http://idcf.org.cn/boat-house

部署脚本

基础设施库

IDCF Boat House 基础设施库

包括vm环境创建脚本,devops相关工具部署脚本

私有库,存放机密文件,仅限于维护团队,不对外开放

如ssh key、k8s kubeconfig 等文件存放此库。

boat-house 相关代码库

  • boat-house 应用结构及功能

船屋餐饮系统采用微服务架构设计,包含五条业务条线(统计服务、商品服务、账户服务、订单服务、支付服务),每一个业务条线可以独立的开发以及部署。

仓库 文件夹 服务说明 技术架构
boathouse-frontend: 前端代码库 src/client 客户端,船屋餐饮官方网站 Boatstrap 4 (模版:AppStrap 参考链接)
Vue + Nodejs
boathouse-frontend: 前端代码库 src/management 船屋餐饮后台管理系统 Boatstrap 4 (模版:ModernAdmin 参考链接)
Vue + NodeJs
boathouse-mobile-android: Android客户端代码库 src/boat-house-android-proj 安卓客户端 Android native APP+MVP
boathouse-backend:后台代码库 src/statistics-service 业务条线 - 统计服务 nodejs + dotnet + redis + postgres
boathouse-backend:后台代码库 src/product-service 业务条线 - 产品服务 spring boot + mysql
boathouse-backend:后台代码库 src/account-service 业务条线 - 账户服务 spring boot + mysql
boathouse-backend:后台代码库 src/order-service 业务条线 - 订单服务 spring boot + mysql
boathouse-backend:后台代码库 src/payment-service 业务条线 - 支付服务 spring boot + mysql

单体架构(主要是后端api)

在打包时打成一个包或是docker 容器运行在一个容器中时运行多个微服务 这两种方式来实现单体架构(TODO)。

注意: 为了boat-house维护简单,所以采用了一套代码库,在真实环境中不建议这样做。除非有特殊的运行场景需要。

微服务架构(主要是后端api)

目前 boathouse-backend后台代码库 是使用spring boot按照微服务架构方式组织,如下图

DevOps工具

地址 说明
http://tools-jenkins.boat-house.cn Jenkins管理端
http://tools-nexus.boat-house.cn Nexus
http://tools-sonar.boat-house.cn Sonarqube
http://tools-jira.boat-house.cn Jira

工具指导文档

Contribute Guide:

提交规范?
  • 格式:所有文档均需要使用Markdown的方式编写。

  • 存放:所有文档均需要在docs目录下创建一个文件夹用于存放图片以及文档,参考如下:

devops-e2e-5p
	- 技术主题 (文件夹)
		- images (文件夹)
		- Readme.md (技术主题文档)
文档原则:
  • 提交的每个文档需要能独立使用,不能与其他文档有依赖关系。
  • 文档需要包含详尽的内容以及截图,确保其他组成员按照文档完成DevOps相关的实践以及学习。
  • 如果文档中有脚本或代码,需要将脚本贴入Markdown,不要使用图片的方式。