labchy 发布的文章

软件外包思考 二 验收

交付物

  • 软件

100%实现需求明细列表所有功能,即100%满足业务需求的软件。

  • 文档

5k0RououxvvEVPjH7fWp.png
2HTGkDE3AI1YFw0JSqDm.png

项目验收

  • 验收方式

1、将要交付的软件安装于指定服务器,并完成调试和上线;
2、完成培训后,业务验收人员根据需求明细列表实现情况进行验收评价,研发验收人员根据以下内容进行验收评价。

  • 文档验收

1、文档齐全(参考如上文档清单);
2、文档内容描述准确, 没有歧义和错误的表达;
3、文档内容容易理解, 通过使用适当的术语、图形表示、详细的解释来表达;
4、文档对主要功能和关键操作尽量提供应用实例。

  • 界面验收

1、界面设计符合自己公司的设计规范;
2、外包团队需提供与软件适配的浏览器、手机、PAD等品牌与版本号清单;
3、各界面需要做好PC、手机、PAD等UI兼容与机器适配;
4、原则上,浏览器至少需适配Chrome、Safari、火狐、IE8以上;
5、原则上,手机至少需适配苹果、小米、华为、vivo、OPPO、三星、魅族。

  • 功能验收

1、功能验收范围覆盖(接口、数据库存取、页面功能);
2、提供单元测试用例、集成测试用例和系统测试用例;
3、提供BUG管理跟踪记录表;
4、提供质量分析报告。

  • 性能验收

1、提供性能测试报告;
2、相关重要指标达到以下要求:
LflV5vh3vvXE5jRYzegE.png

  • 安全验收

1、软件中的敏感数据需以密文方式存储;
2、软件需有留痕功能,即保存用户的操作日志、系统异常日志、接口调用数据日志等;
3、软件中各种用户的权限分配合理;
4、扫描出的安全漏洞(包含但不限于:越权访问、XSS跨站攻击、SQL注入、文件上传漏洞、跨站请求伪造等)外包团队需修复完毕。

  • 用户验收

1、外包团队需提供稳定的用户验收环境和联调环境;
2、业务场景功能测试不通过数的比例<1.5%;
3、不存在严重等级为1的错误;
4、不存在严重等级为2的错误;
5、严重等级为3的错误数量≤5;
6、所有提交的问题都已得到修复;
7、以上功能,用户验收测试通过后,由用户负责人签署验收通过确认书。
sOILv5Xlr5n2OevyiEnl.png

源码交接

如涉及到源码交接,按下列规范进行验收和交接。

  • 交接前提条件

1、需提供用户验收通过确认书;
2、涉及交接的软件,原则上建议接受交接软件所有功能,不建议交接软件部分功能模块;
3、跟薪资类无关的软件或功能,所有功能需在线上稳定运行不少于3个月;跟薪资类相关的软件或功能,所有功能需在线上稳定运行不少于6个月;
4、线上稳定运行既线上可用率,需满足:最近3至6个月内,线上没有出现影响20人以上或数据错误的严重bug,且每月线上bug数不超过3个。

  • 源码验收

1、代码应只保留跟本项目相关的代码,无效代码应一律去除;
2、数据库应只保留跟本项目相关的表、视图、存储过程、函数、触发器、定时job等,无效内容应一律去除;
3、特别注意合理做好数据表结构设计,适当冗余提升性能;
4、代码结构清晰无冗余,注释完整有效,避免硬编码;
5、但凡不符合源码验收规范的,外包团队需修复完毕。

  • 其他注意点

1、对于外包团队的软硬件选型,建议业务部门邀请本公司IT团队一起参与决策;
2、与外包团队商签署的商务合同和补充协议等,建议业务部门邀请本公司IT团队一起参与制定;
3、外包团队使用的环境、数据库、网络、语言、框架、技术、组件等需事先获得本公司IT团队认可;
4、如外包项目不符合或无法满足上述验收规范的,建议商务层面延长付款周期、扣除相应款项或终止合同;
5、每一笔合同款在支付给外包团队之前,除了需获得用户验收通过确认书之外,还应通过IT团队验收;
6、以上内容建议附加进商务合同,成为其中一部分。

软件外包思考 一

软件外包存在风险,外包人员技术、态度、交付能力,如果想通过合同或者诉讼降低风险,由于太多的未知因素和太多的主观性,不现实。因此唯一的外包原则应该是:如果外包人员做得不好,有能力随时终止合作且可控费用损失和项目交付。

可以尝试渐进式方法,首先废除传统开发外包大瀑布方式(例如签订需求URS、项目总金额、进度款支付)(不过目前大部分外包会坚持使用瀑布法,并签订大额的预付合同),尝试新方案,项目按照功能或者阶段划分为多个子合同,做小项分包,或者改为签订人力外包合同。

  • 针对我们想要构建的功能,拟定一个顺序列表。
  • 找几名开发人员,最好是独立的自由职业者,但如果同意以下流程,开发工作室也没问题。
  • 对于每名开发人员,挑选列表中最重要的功能,与他们讨论功能需求、预算和成本。
  • 让他们实现那个特性并测试。
  • 让一名内部人员审核他们的 PR,测试升级后的 App,并标出有问题的地方。
  • 符合要求后,合并并部署该特性,这样,所有创始人/用户就可以继续审核该 App,并提供反馈或者根据需要调整。
  • 如果我们对他们所做的工作感到满意,就挑选下一个我们希望他们实现的功能,然后再次重复这个过程。
  • 如果我们对他们的工作不满意,就解雇他们,并寻找替代者。

当前需要做的工作,整理敏捷开发平台或者公共开发平台,并且参照以下原则:

  • 客户合作胜于合同谈判
  • 个体和互动胜于流程
  • 可运行的软件胜于详细的文档
  • 响应变化胜于遵循计划

参考文章:
Experiences working with an Outsourced Dev Shop

利用Git+ 宝塔WebHook 实现git更新远程同步到Linux服务器中的多个目录

希望本地项目push到Git平台(Coding、码云、GitHub)上后,自动pull到Linux服务器,实现本地与服务器上的多个目录的数据同步更新。

环境:(Coding 开放平台+Linux宝塔+Git,当然其他git平台同样适用,只要Git的平台支持WebHook 即可。
需求:本地项目同步到Git平台,服务器自动同步Git平台上的数据。
目的:希望本地项目push到Git平台(Coding、码云、GitHub)上后,自动pull到Linux服务器,实现本地与服务器的数据同步更新。

项目目录1: /www/wwwroot/mla.xin (mla.xin变量,自定义)
项目目录2: /www/wwwroot/mla.xin2 (mla.xin2变量,自定义) ...

可以有更多的目录

步骤一:

宝塔自带 git(没有的话可以自行安装),生成公钥后添加公钥到Coding (可以通过ssh 拉取coding上的代码)

ssh-keygen -t rsa

一路回车即可,公钥的位置/root/.ssh/id_rsa.pub,将里面的公钥复制粘贴到 Coding (个人设置-SSH公钥)

步骤二:

宝塔面板安装宝塔插件-宝塔WebHook,设置,添加钩子脚本

#!/bin/bash
echo ""
echo "Start..."
#gitPULL 函数
function gitdis()
{
    starttime=$(date +%Y-%m-%d\ %H:%M:%S)
    echo $starttime
    echo "########## Web站点路径:$1 开始复制"
    #判断项目路径是否存在
    if [ -d "$1" ]; then
            cd $1
            #判断是否存在git目录
            if [ ! -d ".git" ]; then
                    echo "在该目录下克隆 git"
                    git clone $gitHttp gittemp
                    mv gittemp/.git .
    rm -rf gittemp
            fi
            #拉取最新的项目文件
            git pull
            #设置目录权限
            echo "End"
    else
            echo "该项目路径不存在"
            echo "End"
    fi

    echo "Web站点路径:$1 拉取成功"
}
#判断宝塔WebHook参数是否存在
if [ ! -n "$1" ];
then
          echo "param参数错误"
          echo "End"
          exit
fi
#git 网址
gitHttp="https://git.dev.tencent.com/yundun/tmla.git"
#git项目路径
gitdis "/www/wwwroot/mla.xin"
gitdis "/www/wwwroot/mla.xin2"

exit

其中git网址在Git平台那可以查询到,之后生成webhook URL(http://面板/hook?access_key=秘钥¶m=mla.xin),将网址粘贴到Git平台上新建WebHook中的URL里。

备注:可同时推送多个服务器,已方便使用负载均衡。

利用Git+ 宝塔WebHook 实现git更新远程同步到Linux服务器

希望本地项目push到Git平台(Coding、码云、GitHub)上后,自动pull到Linux服务器,实现本地与服务器的数据同步更新。

环境:(Coding 开放平台+Linux宝塔+Git,当然其他git平台同样适用,只要Git的平台支持WebHook 即可。
需求:本地项目同步到Git平台,服务器自动同步Git平台上的数据。
目的:希望本地项目push到Git平台(Coding、码云、GitHub)上后,自动pull到Linux服务器,实现本地与服务器的数据同步更新。

项目目录: /www/wwwroot/mla.xin (mla.xin变量,自定义)
远程Git版本库: Coding 腾讯云开放平台

步骤一:

宝塔自带 git(没有的话可以自行安装),生成公钥后添加公钥到Coding

ssh-keygen -t rsa

一路回车即可,公钥的位置/root/.ssh/id_rsa.pub,将里面的公钥复制粘贴到 Coding (个人设置-SSH公钥)

1.png

步骤二:

宝塔面板安装宝塔插件-宝塔WebHook,设置,添加钩子脚本

2.png

#!/bin/bash
echo ""
#输出当前时间
date --date='0 days ago' " %Y-%m-%d %H:%M:%S"
echo "Start"
#判断宝塔WebHook参数是否存在
if [ ! -n "$1" ];
then
          echo "param参数错误"
          echo "End"
          exit
fi
#git项目路径
gitPath="/www/wwwroot/mla.xin"
#git 网址
gitHttp="https://git.dev.tencent.com/yundun/swt.git"

echo "Web站点路径:$gitPath"

#判断项目路径是否存在
if [ -d "$gitPath" ]; then
        cd $gitPath
        #判断是否存在git目录
        if [ ! -d ".git" ]; then
                echo "在该目录下克隆 git"
                git clone $gitHttp gittemp
                mv gittemp/.git .
rm -rf gittemp
        fi
        #拉取最新的项目文件
        git pull
        #设置目录权限
        echo "End"
        exit
else
        echo "该项目路径不存在"
        echo "End"
        exit
fi

其中git网址在Git平台那可以查询到,之后生成webhook URL(http://面板/hook?access_key=秘钥¶m=mla.xin),将网址粘贴到Git平台上新建WebHook中的URL里。

亲测推荐 2021 年 SaaS 技术栈:Docker、Django、Traefik 和 IntercoolerJS

我最近发布了个人对Django做为一款优秀应用框架的一些考虑。本文基于此从架构角度做进一步扩展,介绍从开发到生产环境的整体技术栈考虑。

2018 年至今,我一直使用该技术栈构建一些小型 SaaS 应用。

本文最初发布于 www.simplecto.com,经原作者授权,由 InfoQ 翻译并分享。

整体技术栈

随处部署的 Linux 服务器和虚拟机:我使用了 Azure、Digital Ocean 和 Scaleway,并计划在 2021 年将所有部署迁移到Hetzner提供的专用服务器上。

Docker:就是我们常用的 Docker.

Traefik:使用 LetsEncrypt 证书的反向代理和 TLS。

Postgresql:运行在 Docker 中的数据库。

Django:同样运行在容器中。

IntercoolerJS:提供平滑易用的类 Ajax 前端应用支持。Intercooler 的创作者在 2021 年发布了HTMX,是 IntercoolerJS 的更新换代。

Sentry:捕获生产环境中软件缺陷。只需在配置文件中添加几行配置。

Bitbucket Pipelines 替代 CI/CD:鉴于 CI/CD 引入了过多繁琐无用的工具,我在 2021 年不再对个人项目考虑 CI/CD。

ZeroTier:实现 VPN 和控制层。

我在开发小型项目时,采用本地 Docker 容器运行测试,进而直接推送到生产环境。我不考虑使用繁琐的 CI/CD,而是选择了 Bitbucket Pipelines。

7597a5b78ab8a92a0bfadb3fecdfc653.jpeg

上图给出了我所采用技术栈的概览,图中有很多需要详细展开阐述的部分。下面换成列表方式展示。

  • 虚拟机
  • Docker
  • Django
  • 挂载数据磁盘卷
  • 使用长时间运行 Django 命令做为 Workers
  • 挂载数据磁盘卷
  • Postgres
  • 挂载数据磁盘卷
  • Traefik
  • Zero-Tier
  • SSH

托管环境

即便是无服务器架构,也需要一个云服务托管环境。我个人推荐Azure、Digital Ocean和Scaleway。每家都为计算、联网、存储和基本服务提供了充分的选项,支持用户任何构建需求。

同样推荐Hetzner,它提供了各服务层级的硬件、服务和价格。

虚拟机

一些企业应用和个人副业(side projects),并不需要同时为成千上万的用户提供 TB 级数据服务,因此可扩展性并非主要关注问题。对于此,我们可选用最小托管服务选项,通常不高于每月 20 美元。即便是服务价格相对最贵的 Azure,也可选用 Burstable 服务质量的虚拟机。个人推荐Scaleway的开发层级服务器。

注意:在我的技术栈中并没有 Kubernetes,因为我并未考虑可扩展性。

Docker

为确保新的虚拟机运行在最新版 Docker 上,我并没有依赖操作系统本身,而是使用了 curl|bash 方式,即:

curl -s https://get.docker.com | sudo bash


运行上面一行命令,就能获取最适用于当前运行环境的最新版本。

Traefik 实现反向代理

Traefik 对我简直是天赐之选。尽管 Nginx 也很强大,但其并非针对 Docker 环境构建。Traefik 的两个杀手级特性,为我节省了大量时间:

使用 LetsEncrypt 实现自动 TLS。简而言之,一旦设置,无需操心。结合适用的 API 和 DNS 服务提供商,还可以使用 DNS 验证。

使用 Docker label 实现无需重新加载的自动配置。一旦新服务发布,Traefik 通过监听所有 Docker 相关服务而自动发现更改。这使得服务的添加、移除和合并非常方便,不存在任何麻烦。

我对 Traefik 唯一意见是学习曲线略为陡峭。用户必须自行确定如何进行配置,包括配置文件、命令行选项、YAML、Docker label,乃至组合使用。

提示:我发布了自己使用的Traefik生产环境配置文件,供参考。

Postgres 数据库

亲测推荐,PostgreSQL 从不会令我失望。PostgreSQL 容器可毫无问题地添加到任何项目中。我只需简单地启动容器,绑定端口,挂接数据卷到主机磁盘,仅此足矣。

docker-compose.yml
version: '3.1'


services:


  db:
    container_name: postgres
    hostname: postgres
    image: postgres:11
    restart: always
    environment:
      POSTGRES_PASSWORD: secretsonly
    volumes:
      - ./data:/var/lib/postgresql/data
    ports:
      - 5432:5432
    networks:
      - web


networks:
    web:
        external: tr


用于 Web 的容器化 Django

Django 很好地支持发布到容器中,我多年以来一直这么用。我反复强调开发环境和生产环境匹配的重要性,Docker 为我实现了一切。

我在 2021 年新推出了一个 Django 项目,用做新项目的模板,参见https://github.com/simplecto/django-reference-implementation

实现异步任务的 Django 命令

我使用做为标准框架组成的自定义Django命令实现异步任务。该模式采用具有 sleep()的 while 循环,轮询数据库相关操作,并采取相应的动作。

截止 2021 年,我已使用这一模式运行一个网站截屏项目一年多,回报丰厚。该项目每日对 1500 个网站做截屏,所有操作由 Django 命令计划和管理。项目地址:https://github.com/simplecto/screenshots

IntercoolerJS 降低了复杂性

这里如果展开说,需推出多个帖子,恐怕内容太长,以至于不会有人愿意读。我结合 JQuery 和这个小型 JavaScript 库,实现部分类似单页应用的效果,尽管事实上并非单页应用。

IntercoolerJS 保留了 Ajax 的传统优点,从后端 HTML 更新 DOM,无缝且平滑,非常便于实现用户登录和更新小型表单等元素。

强力推荐访问IntercoolerJS官网。

其创立者在 2021 年继承发展了 IntercoolerJS,推出了HTMX。

Sentry 捕获生产中错误

任何应用都会出错,但不应向用户展示。Sentry 提供了一种捕获生产中软件缺陷的易用便捷方式,其特性包括:

开源许可,可在生产中任意部署。

只需在 Django 项目的 settings.py 中添加几行配置,即可生效。

与 Git 代码库和问题追踪系统紧密集成,提供全生产环境的缺陷可追踪能力。

另一个优点是,随时能在生产环境中禁用。

更多信息,可访问Sentry官网。

Bitbucket Pipelines 替代 CI/CD

2021 年,我不在个人项目的部署中使用 CI/CD。其中存在太多工具,复杂性高。我只是使用 PyCharm 运行测试,然后从开发设备直接交付生产环境。

当前存在多种 CI/CD 解决方案,但是我推荐 Bitbucket 提供的 Pipelines 的服务。该服务每月提供数百分钟的免费使用,只需很少费用就能提供自上而下的功能。我自己在使用中很少碰到问题,很喜欢它们的 YAML 配置文件。

我使用 bitbucket-pipelines.yml 文件,实现跨多个 Docker 容器的完全端到端测试,加载数据库,并在几分钟内执行数以百计的测试。该服务是我们团队高效的关键,支持生产环境中每日五次以上 Push。

更多信息,访问Bitbucket官网。

ZeroTier 实现 VPN

最后,推荐一种在很大程度上是可选的、但是最好应具备的技术。Zerotier 是一种独树一帜的网络/VPN 服务,我用其连接所有的个人计算机。它可穿透防火墙联通家庭和办公场所,一分钟即可配置好。

如果所有设备使用 ZeroTier,就可以避免 SSH 中令人头疼的密钥管理,单机上共享带宽。

Zerotier 可运行在 Linux、Mac、Windows、Android 和 iPhone 上,覆盖大部分设备。

ZeroTier 的一个问题在于,我并不完全了解它的工作机制。和 MacOS 和 iPhone 类似,它们会按用户期望工作,并不出问题,只是从用户体验角度看有些不爽。但对于一名 CTO,谁又会去关心具体的细节呢?

总结

希望上面的深入介绍能激发读者对 Docker、Django、Traefik,尤其是 IntercoolerJS 的兴趣。它们简单、易于使用,能在适当时大展身手。

原文链接: Docker, Django, Traefik, and IntercoolerJS is My Go-To Stack for Building a SaaS in 2021
https://www.infoq.cn/article/W4leI4XZ32eSTqFJ8qPl

/* * @Author: your name * @Date: 2016-09-06 00:00:00 * @LastEditTime: 2020-03-17 18:29:35 * @LastEditors: Please set LastEditors * @Description: In User Settings Edit * @FilePath: \htdocs\usr\themes\default\footer.php */