Dockerfiles API

极狐GitLab 为实例级 Dockerfile 模板提供了一个 API 端点。默认模板定义在 vendor/Dockerfile。

具有访客角色的用户无法访问 Dockerfile 模板。更多信息，可查看项目和群组可见性。

覆盖 Dockerfile API 模板

在极狐GitLab 专业版及旗舰版中，实例的管理员可以在管理页面覆盖模版。

Dockerfile 模版列表

获取所有 Dockerfile 模板。

GET /templates/dockerfiles

curl "https://gitlab.example.com/api/v4/templates/dockerfiles"

响应示例：

[
  {
    "key": "Binary",
    "name": "Binary"
  },
  {
    "key": "Binary-alpine",
    "name": "Binary-alpine"
  },
  {
    "key": "Binary-scratch",
    "name": "Binary-scratch"
  },
  {
    "key": "Golang",
    "name": "Golang"
  },
  {
    "key": "Golang-alpine",
    "name": "Golang-alpine"
  },
  {
    "key": "Golang-scratch",
    "name": "Golang-scratch"
  },
  {
    "key": "HTTPd",
    "name": "HTTPd"
  },
  {
    "key": "Node",
    "name": "Node"
  },
  {
    "key": "Node-alpine",
    "name": "Node-alpine"
  },
  {
    "key": "OpenJDK",
    "name": "OpenJDK"
  },
  {
    "key": "PHP",
    "name": "PHP"
  },
  {
    "key": "Python",
    "name": "Python"
  },
  {
    "key": "Python-alpine",
    "name": "Python-alpine"
  },
  {
    "key": "Python2",
    "name": "Python2"
  },
  {
    "key": "Ruby",
    "name": "Ruby"
  },
  {
    "key": "Ruby-alpine",
    "name": "Ruby-alpine"
  },
  {
    "key": "Rust",
    "name": "Rust"
  },
  {
    "key": "Swift",
    "name": "Swift"
  }
]

单一 Dockerfile 模板

获取一个 Dockerfile 模板。

GET /templates/dockerfiles/:key
参数 类型 是否必需 描述
key string yes Dockerfile 模板的密钥 
curl "https://gitlab.example.com/api/v4/templates/dockerfiles/Binary"

响应示例：

{
  "name": "Binary",
  "content": "# This file is a template, and might need editing before it works on your project.\n# This Dockerfile installs a compiled binary into a bare system.\n# You must either commit your compiled binary into source control (not recommended)\n# or build the binary first as part of a CI/CD pipeline.\n\nFROM buildpack-deps:buster\n\nWORKDIR /usr/local/bin\n\n# Change `app` to whatever your binary is called\nAdd app .\nCMD [\"./app\"]\n"
}