Makefile-项目构建神器

1 背景

目前所在项目使用了docker-compose来构建,并且需要在同一个机器上部署两套环境(留下了没有CI的眼泪)
通过查阅资料,了解到可以使用-p命令来指定项目名称,并且通过环境变量的方式动态修改端口和网络
最终是顺利完成了任务,但是产生一个问题,就是启动应用命令特别的长。
比如:
要启动测试环境的服务和重启nginx容器

export TAG=v1.4.4; docker-compose -f docker-compose-base.yml -f docker-compose-test.yml --env-file $HOME/.env-memory-test --project-name memory-test-project up -d  --build --remove-orphans
docker-compose -f docker-compose-base.yml -f docker-compose-test.yml --env-file $HOME/.env-memory-test --project-name memory-test-project restart nginx

启动应用命令的意思是:

  • 设置一个环境变量,TAG=v1.4.4,这个docker-compose中会使用到
  • -f 指定docker-compose文件,可以使用多个,最终会合并
  • --env-file 指定启动的环境变量
  • --project-name 指定项目名称,但项目时可以省略,简短写法是-p
  • up启动docker-compose中所有的service
  • -ddaemon的方式运行
  • --build 启动之前先构建镜像
  • --remove-orphans 移除掉那些不在docker-compose中的service, 在docker-composeservice有变动时候会有用

要使用restart, ps, logs, down 等命令,都是避免不了一堆的前缀,
即使有命令补全,历史搜索辅助插件,但还是会让人不爽,并且也容易输错

2 目的

缩短命令,方便记忆,减少出错,提高工具的复用率

3 做法

针对命令太长,容易出错的
首先想到缩短命令可以使用alias, 这个可以轻松实现,但也会存在一些问题:

  • alias的命名不太容易
  • 适配多环境,多参数,实现起来有点麻烦
  • 在不同的shell环境或者不同用户都要配置
  • 其他项目不容易复用这个能力

参考很多开源项目,都是用到Makefile,不妨我也来试试

先看结果,背景中提到很长的命令,通过Makefile可以缩短成make up-tag tag=v1.4.4
这样就非常的简短,方便记忆
看看这个Makefile长成什么样

# Makefile

# 伪目标,避免文件和目标相同时,避免目标无法执行, 
.PHONY: up logs up-tag down build build-tag ps config exec restart

# 取变量
env := ${env}


ifeq ($(env), prod)
    # 只有明确指定了env=prod,才走这里
    project_name = memory-prod-project
    docker-compose-file = docker-compose-prod.yml
    env-file = ${HOME}/.env-memory-prod
else
    # 否则,env不传或者等于其他,全部走这里 
    project_name = memory-test-project
    docker-compose-file = docker-compose-test.yml
    env-file = ${HOME}/.env-memory-test
endif

cmd = docker-compose -f docker-compose-base.yml -f $(docker-compose-file) --env-file $(env-file) --project-name $(project_name)

tag := $(tag)

# 目标
up-tag:
    # export环境变量需要和docker-compose写在同一个行,否则两个进程执行,环境变量会无效
    export TAG=$(tag); $(cmd) up -d  --build --remove-orphans
    # 启动完应用容器后,需要重启nginx,否则upstream会失败
    $(cmd) restart nginx 

更多Makefile细节
参考这里

?著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,992评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,212评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事?!?“怎么了?”我有些...
    开封第一讲书人阅读 159,535评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,197评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,310评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,383评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,409评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,191评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,621评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,910评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,084评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,763评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,403评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,083评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,318评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,946评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,967评论 2 351

推荐阅读更多精彩内容