freeCodeCamp.org

How to Automate Docker Image Creation for Postgres Using Shell Commands

8.5内容质量
How to Automate Docker Image Creation for Postgres Using Shell Commands

TL;DR · AI 摘要

本文详解通过bash脚本自动化创建PostgreSQL Docker镜像的方法,提供可复用的工程实践方案。

核心要点

  • 使用#!/bin/bash shebang定义脚本执行环境
  • 通过$1 $2参数传递数据库凭证实现动态配置
  • chmod +x赋予脚本执行权限后可全局调用

结构提纲

按章节快速跳转。

  1. 介绍bash脚本在自动化流程中的核心作用

  2. 明确需要安装Git-bash、Docker及基础编程知识

  3. 基于重复创建Postgres镜像需求提出自动化方案

  4. 详解.sh文件创建及shebang语法作用

  5. 演示通过命令行参数动态配置数据库信息

  6. 说明chmod命令赋予脚本可执行权限的原理

思维导图

用一张图看清主题之间的关系。

查看大纲文本(无障碍 / 无 JS 友好)
  • Docker镜像自动化
    • 实现方式
      • bash脚本
      • 参数传递
    • 关键步骤
      • shebang定义
      • 权限设置

金句 / Highlights

值得收藏与分享的关键句。

#Docker#bash#PostgreSQL#自动化
打开原文

如何使用Shell命令自动化创建Postgres的Docker镜像

2026年11月3日

/

#shell

Jabo Landry

如果你的项目中存在重复出现的代码行,有一个标准的解决方案:使用函数。

那如果遇到相同项目文件结构反复重复的情况呢?又该如何解决?

这就需要Bash脚本。Bash脚本的作用是自动在你的机器上执行特定的命令序列,而无需你进行任何操作。这种技术被称为工作流程自动化,本文将教你如何实现这种自动化。

目录

  • 先决条件
  • 是什么促使了这个项目的诞生?
  • 介绍
  • Bash中的条件判断
  • 交互式Shell
  • 如何创建和写入文件
  • Bash参数和标志
  • 如何使脚本可执行并在PC路径中可用
  • 结论

先决条件

要跟随本文内容,你需要具备以下条件:

  • 电脑上安装了Git-bash
  • 有一定使用终端或命令提示符运行和执行命令的经验(有帮助但非必需)
  • 理解基本编程概念(如条件语句和循环)
  • 电脑上安装了Docker
  • 对Docker基础概念(如镜像和容器)有基本理解
  • 有使用Postgres的经验(非必需但推荐)

是什么促使了这个项目的诞生?

最近我在几个项目上设置Postgres的Docker镜像时,注意到自己在创建镜像时总是在重复相同的流程。唯一的区别只是数据库凭证和数据库名称不同。

我还发现,当今许多快速开发的应用程序倾向于使用Supabase作为后端,这可能会带来资源限制问题,如数据库存储空间、带宽、并发连接数和API请求配额(具体取决于服务层级和项目规模)。而这些问题都可以通过正确设置数据库来解决。

因此我思考:为什么不创建一个CLI工具来自动化生成Postgres的Docker镜像呢?正是这个想法让我学习到了如何使用Bash编写可执行的shell命令来实现工作流程自动化。

你可以在本指南使用的完整工作示例中找到这个git-repo。

介绍

Bash是一种用于编写和执行命令或脚本的shell和脚本语言,这些命令或脚本可以在计算机上执行操作,如创建目录和文件、操作文件、自动化任务以及管理系统进程。

在本指南中,你将学习如何自动化创建Postgres数据库的Docker镜像过程,这样就不需要为每个新项目从头开始创建镜像。

Bash脚本文件设置

首先,打开你首选的文本编辑器并创建一个目录或文件夹。然后在该目录中创建一个扩展名为.sh的文件。

在文件开头输入:

code
#!/bin/bash

#!/bin/bash(称为“shebang”)告诉操作系统使用Bash shell运行脚本,这样文件中的命令将作为Bash/终端命令执行。

Bash中的条件判断

在完成脚本文件的创建并添加shebang后,让我们开始探讨Bash中if语句的使用方式。

if语句的语法如下:

code
if [[ condition ]]; 
    then
        要执行的命令
fi

Bash中的if语句与其他编程语言中的用法没有区别:

  • 使用双方括号([])添加要检查的条件,并在条件后添加分号(;)。
  • 在 if 声明后使用 then 来指定条件为真时应执行的操作。
  • 使用 fi 来关闭条件语句。

在方括号内编写条件时,请确保在条件前后都留出空格(如上面的代码所示)。如果省略这些空格,会导致错误。

可工作示例:

由于我们正在自动化创建 Postgres 数据库的 Docker 镜像,首先检查文件是否存在且包含内容。如果文件确实存在内容,则终止脚本。如果不存在内容,我们将继续执行下一个脚本。

code
#!/bin/bash

if [[ -s docker-compose.yml ]];
    then
        echo "The file already exists"
        exit 0
fi

echo "Next command"

在 if 条件中,我们使用 -s 标志来检查文件是否存在且包含内容。文件标志用于检查文件的可用性和权限,包括但不限于:

  • -f:用于检查文件是否存在
  • -s:用于检查文件是否存在且包含内容
  • -d:用于检查目录是否存在
  • -r:用于检查文件是否可读
  • -w:用于检查文件是否可写
  • -x:用于检查文件是否可执行

在脚本中,我们使用 -s 来检查当前执行命令的目录中是否存在名为 docker-compose.yml 的文件。如果结果为假,我们使用 echo 关键字打印文本 "Next command"。如果结果为真,我们打印文本 "The file already exists"。

exit 在 bash 脚本中充当返回关键字,0 表示成功,1 表示失败。

让我们通过创建一个 Docker Compose 文件并在编写 bash 脚本的同一目录中添加一些内容来测试所有这些功能。在终端中输入 bash name-of-file.sh,你应该会看到 "The file already exists":

但如果删除文件中的内容并再次运行命令,你应该会看到输出 "Next command":

交互式 Shell

为了使自动化脚本动态且灵活,你需要接收输入。以数据库名称为例,你不会始终使用相同的数据库名称,名称会根据项目而变化。

为此,你需要设置一种方法,当创建新的 Docker 镜像时使用给定的数据库名称,为此你可以使用 read 关键字读取输入。

根据操作类型,输入有不同的类型。还有一些标志用于指定预期的输入类型,例如:

  • -p:用于提示用户输入文本
  • -s:在需要用户输入密码时使用,可使输入内容在终端中隐藏
  • -a:在需要用户输入多个输入或预期用户输入数组时使用

读取用户输入的语法如下:

code
read -p 'input_label: ' variable_name

现在让我们创建脚本以接收关于你要创建的 Postgres 数据库镜像的用户输入。

code
#!/bin/bash

# 数据库凭据
read -p 'DataBase-name(*): ' db
read -p 'DataBase-user(*): ' user
read -sp 'DataBase-password(*): ' pwd
echo
echo "your database is -> $db with a username of $user and a password of $pwd"

该脚本在 read 关键字上使用了 -p 来提示用户输入字符串,使用了 -sp 来提示用户输入需要隐藏的字符串(因为 -s 会隐藏输入内容)。

如果不将 -p 选项与 -s 一起使用,将无法显示提示用户输入密码的提示信息。单独使用 -s 时,输入内容会被隐藏,除非使用 echo 或 printf 显式打印提示信息,否则不会显示任何提示。

要打印或使用用户输入的内容,请使用美元符号 ($) 后跟变量名来引用预期的输入。在上面的示例中,我们为获取数据库名称的变量命名为 db,因此在需要访问用户输入的数据库名称时,将使用 $db。

现在如果在终端中运行脚本,应该会看到一系列等待输入的终端提示。输入完成后,你将在终端中看到所有输入值:

如何验证和清理输入

在执行任何操作之前,还需要验证输入。这是非常重要的,因为有时关键字段可能缺失或拼写错误。例如,你可能忘记为正在创建的镜像输入数据库名称。

验证输入时,可以使用以下标志(还有其他标志):

  • -z:检查变量值是否为空
  • -n:检查变量值是否非空
  • -lt:检查数字是否小于给定数字
  • -gt:检查数字是否大于给定数字
  • -eq:检查两个值是否相等

你可以对所有需要确保非空的输入使用 -z 标志:

code
#!/bin/bash

# 数据库凭证
read -p 'DataBase-name(*): ' db
if [[ -z $db ]]
    then
        echo "数据库字段不能为空!"
        exit 1
fi

read -p 'DataBase-user(*): ' user
if [[ -z $user ]]
    then
        echo "用户字段不能为空!"
        exit 1
fi

read -sp 'DataBase-password(*): ' pwd
if [[ -z $pwd ]]
    then
        echo "密码字段不能为空!"
        exit 1
fi

此脚本可帮助确保在继续下一步输入之前,所有关于数据库的关键信息都已提供。

默认值

你可能希望某些字段使用默认值(例如容器名称、端口或容器卷)。对于这种情况,可以使用 := 为变量分配默认值:

code
#!/bin/bash

# 容器信息
read -p 'Container-name: ' container_name
read -p 'Container-port(if omitted, the container will use default postgresql default port of 5432): ' port
read -p 'Volume-name: ' vol_name

echo "container-name-> ${container_name:=cont_one}, port->${port:=5432}, volume_name->${vol_name:=backend_data}"

当你运行脚本并跳过这三个输入时,bash 会使用你设置的默认值作为回退。

但如果你为这些输入提供值,bash 会使用提供的值。例如,提供所有三个输入并查看输出结果:

如何创建和写入文件

现在你已经知道如何为 Postgres 数据库创建 Docker 镜像,接下来需要创建一个 docker-compose.yml 文件,该文件在启动和停止容器时会被执行。

在 Bash 中,有多种创建文件的方法:

  • 首先,可以使用 > filename。如果文件不存在,将创建文件;如果存在,其内容将被覆盖(替换)。
  • 还有 >> filename:这会将内容追加到文件中,如果文件不存在,将创建文件。
  • 最后是 touch filename:如果文件不存在,将创建文件;如果文件已存在,将保留其内容,仅更新文件的时间戳。

如何使用 > 创建并写入文件

当你想要同时创建文件并写入内容时,需要在 > 前面使用 echo,然后添加文件名,如下所示:

code
#!/bin/bash

echo Hello> test.txt

这将创建一个名为 test.txt 的文件,内容为 "hello"。

如何使用 >> 向现有文件追加内容

要向现有文件追加内容时,需要在 >> 前面添加内容,然后指定要追加内容的文件名。让我们在之前脚本创建的 test.txt 文件中 "Hello" 后面添加 "Africa"。

code
#!/bin/bash

echo Africa!>> test.txt

现在 test.txt 将包含 "Hello" 和 "Africa!",分别位于新行上。

使用这些符号,让我们创建一个 docker-compose.yml 文件,用于保存我们 Postgres 数据库设置的相关信息。

code
#!/bin/bash

> docker-compose.yml

就这样,你的 docker-compose 文件已经在目录中创建完成。

如何将多个不同内容写入文件

你也可以使用 cat 关键字来写入文件。通常,cat 用于读取文件内容。但当你将其与 <<EOF(我们刚刚讨论的追加内容到文件的符号 >>)结合使用时,你可以按照想要的格式将多个内容添加到文件中。语法如下:

code
# 写入 docker compose 内容

cat <<EOF>> docker-compose.yml

  # 文件内容
EOF

<<EOF 告诉 bash 将内容写入文件,直到找到 EOF 关键字(文件结尾)。然后使用 >> filename 将内容追加到文件中。使用 Docker compose 设置时,它看起来像这样:

code
#!/bin/bash

# 文件创建和写入
 >  docker-compose.yml

cat<<EOF>>docker-compose.yml
 services:
    postgres:
        image: postgres:18-alpine
        container_name: ${container_name:= $db}

        environment:
            POSTGRES_USER: $user
            POSTGRES_PASSWORD: $pwd
            POSTGRES_database: $db

        ports:
            - ${port:=5432}:5432
        volumes:
            - ${vol_name:=database-data}:/var/postgresql

 volumes:
    ${vol_name:=database-data}:

EOF

Bash 参数和标志

使用 Bash 参数时,可以在执行脚本时在同一行中传递值。要使用参数,请在执行脚本时在同一行中添加值,如下所示:

code
bash script val1 val2

要读取参数值,请使用美元符号 ($) 后跟输入值的位置(位置从 1 开始,而不是 0)。

在示例中,如果你想输出第二个参数值的内容,可以使用 echo $2。

为了更好地理解这一点,让我们通过使用参数传递数据库凭证来增强数据输入体验:

code
#!/bin/bash

# 数据库凭证

if [[ -z $1 ]]; then
    read -p 'DataBase-name(*): ' db
 else
    db="$1"
fi

# 数据库检查和验证

if [[ -z $2 ]]; then
    read -p 'DataBase-user(*): ' user
 else
    user="$2"
fi

# 用户检查和验证

if [[ -z $1 ]]; then
    read -sp 'DataBase-password(*): ' pwd
 else
    pwd=$3
fi

# 密码验证和检查

代码片段首先检查是否有参数。如果没有参数,你将使用提示输入值。如果有参数,你将把参数值分配给代表给定数据库凭证(数据库名称、密码等)的变量。现在你可以使用参数运行脚本:

code
bash image.sh customers ABC-Company secret123!

由上述脚本生成的镜像将包含客户数据库、用户 ABC-Company 以及密码 secret123!。

Bash 标志/选项

该脚本中有一个部分会询问有关正在创建的镜像的信息,但这些信息是可选的。通过使用 bash 选项/标志,可以使用 -D 选项跳过需要输入容器信息的步骤。这允许在脚本运行前显式保留默认的容器信息。

以下是一个示例:

code
#!/bin/bash

while getopts "ny" options; do
	case "$options" in
		n) echo "You choose no";;
		y) echo "You choose yes";;
		*) echo "No such option/flag"; exit 1;;
    esac
done

shift $((OPTIND - 1))

在上述脚本中:

  • while 循环会持续运行,直到 getopts 为空
  • getopts 获取脚本中传递的选项
  • "ny" 是运行脚本时用户可能提供的选项
  • options 是一个变量,用于跟踪用户输入的 "n" 或 "y" 选项
  • do 开始循环
  • case 使用 in 关键字检查所选选项是否在定义的选项中
  • 然后我们定义当使用 -n 或 -y 选项调用脚本时会发生什么,并使用双分号 (;;) 结束选项定义
  • * 用于处理未定义的输入选项
  • esac 结束 case
  • done 结束循环,防止循环无限运行
  • shift $((OPTIND - 1)) 通过将剩余参数左移以避开标志,有效从参数列表中丢弃标志,帮助避免脚本同时期望参数时可能发生的冲突

然后可以将脚本中的语法应用到执行过程中,当传递 -D 作为选项时,跳过询问容器信息的步骤。

code
#!/bin/bash

ask_container_info=true

while getopts "D" options; do
	case "$options" in
		D) ask_container_info=false;;
		*) echo "No such option/flag"; exit 1;;
    esac
done

shift $((OPTIND - 1))

if [[ $ask_container_info == true ]]; then
	# 提示用户输入自定义容器信息
    read -p 'Container-name: ' container_name
    read -p 'Container-port(if omitted, the container will use default postgresql default port of 5432): ' port
    read -p 'Volume-name: ' vol_name
fi

这里只有一个选项,因此选项部分只包含 D。ask_container_info 初始值为 true,这意味着除非传递了该选项,否则脚本会提示用户输入容器信息。当使用 -D 执行脚本时,我们将 ask_container_info 的值更改为 false。

如何使脚本可执行并在 PC 路径中可用

下一步是使脚本在您机器上使用的所有终端中都可用且可执行。目前,脚本仅在您创建和编写脚本的当前目录中有效。

我们将从使脚本文件可执行并删除文件扩展名开始,这样就不需要始终使用 .sh 扩展名来调用我们的脚本。

如何使文件可执行

要使文件可执行,请使用 Linux chmod 命令。它表示更改模式。模式包括文件权限,如写入、读取和执行。

code
chmod +x image

这里,x 使文件可执行,然后列出您要使其可执行的文件名(image)。

如何将目录添加到系统/机器路径

为了让所有打开的终端都能使用该功能,无论当前目录是什么,你需要将脚本注册到系统路径中,这些路径存储了所有全局脚本和命令。

要做到这一点,请复制你的目录的完整路径,然后在终端中输入以下内容:

code
export PATH="$PATH:<YOUR_DIRECTORY_LOCATION>"

将 <YOUR_DIRECTORY_LOCATION> 替换为你的目录路径。此命令会将脚本目录添加到当前终端的工作路径中。但如果你切换到另一个终端并运行脚本,它将无法执行。

现在让我们全局配置目录,使每个终端都能执行脚本:

code
nano ~/.bash_profile

执行此操作后,你应该会看到类似以下内容:

在上面的图像中,你可以看到我已经在文件中声明了路径(请参阅选中的文本)。

如果你的文件中没有该路径,可以将 export PATH="$PATH:<YOUR_DIRECTORY_LOCATION>" 复制粘贴到文件中。完成后,按 Ctrl+O 保存,然后按回车。接着按 Ctrl+X 退出 nano 编辑器。

然后重新加载系统路径以包含你的脚本:

code
source ~/.bash_profile

完成此操作后,你就可以在机器上的任何终端中仅使用脚本文件名来运行脚本(我将我的文件命名为 image):

结论

在本指南中,你学习了如何创建自己的脚本来自动化工作流程。希望它能帮助你减少在重复任务上浪费的时间和精力,这些任务可以通过脚本命令实现自动化。

你可以在本指南中作为示例使用的完整 CLI 工具,可以在 [这个 git-repo](git-repo) 中找到。在那里,你会发现安装指南和使用技巧。如果你觉得这个工具对你有帮助,请考虑给这个仓库加星标,并与可能从中受益的同事分享。

谢谢!

推荐课程(来自合作伙伴,侧边栏 1/3)

(在新标签页中打开)

ADVERTISEMENT

更多 Bash & Shell 脚本课程请查看 Class Central

→

推荐课程(来自合作伙伴,侧边栏 2/3)

推荐课程(来自合作伙伴,侧边栏 3/3)

  • 在 edX 上的恶意软件分析与汇编语言入门 Terri Puckett 7周 7周,每周2-6小时 初级 证书 查看课程(在新标签页中打开)
  • 在 DataCamp 上的中级 Docker Mike Metzger 5星中的4.8星(929)来自929个评分 4小时 中级 证书 查看课程(在新标签页中打开)

我是开发者 原型

如果你读到这里,请感谢作者以表达你的支持。说声谢谢

免费学习编程。freeCodeCamp 的开源课程已帮助超过40,000人成为开发者。立即开始

来自我们合作伙伴的推荐课程