giantswarm/inspect-docker-image

Dockerhub Image Inspector

镜像概述和主要用途

Dockerhub Image Inspector是一个用于从公共Docker仓库获取特定镜像信息的小工具/概念验证，支持CLI（命令行）和Web API两种运行模式。它能够获取镜像的元数据，包括架构、配置、历史记录、层信息及大小等详细内容。

核心功能和特性

• 双模式支持：同时提供CLI（命令行）和Web API两种运行方式
• 丰富的元数据获取：可获取镜像的架构、标签、配置信息（环境变量、暴露端口、命令等）、历史记录条目数、层数量及大小、总镜像大小等
• 灵活的镜像引用：支持多种镜像引用格式（如nginx、redis:3.2、library/redis、quay.io/giantswarm/helloworld等）

使用场景和适用范围

• 开发人员快速查询公共Docker镜像的详细信息
• 自动化脚本中集成镜像元数据获取功能
• 搭建简单的镜像信息查询API服务
• 学习和了解Docker镜像结构及元数据组成

使用方法和配置说明

CLI模式运行

1. 拉取镜像并创建别名

nohighlight
docker pull giantswarm/inspect-docker-image
alias idi="docker run --rm giantswarm/inspect-docker-image"

2. 执行查询

例如，获取redis:3.2镜像的信息：

nohighlight
idi redis:3.2

CLI输出示例

输出包含镜像的架构、标签、配置、历史记录、层信息及大小等：

nohighlight
Schema version: 1
Image name: library/redis
Tag: 3.2
Architecture: amd64
Number of history entries: 17
Configuration:
{
  "Tty": false, 
  "Cmd": [
    "/bin/sh", 
    "-c", 
    "#(nop) CMD [\"redis-server\"]"
  ], 
  "Volumes": {
    "/data": {}
  }, 
  "Domainname": "", 
  "WorkingDir": "/data", 
  "Image": "9b8288e1a4bf007bec3c9778b4833ca75a6c4c9a708a07c8e28f5cd7bb64704b", 
  "Hostname": "f416997e8b71", 
  "StdinOnce": false, 
  "Labels": {}, 
  "AttachStdin": false, 
  "User": "", 
  "Env": [
    "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin", 
    "GOSU_VERSION=1.7", 
    "REDIS_VERSION=3.2.0", 
    "REDIS_DOWNLOAD_URL=http://download.redis.io/releases/redis-3.2.0.tar.gz", 
    "REDIS_DOWNLOAD_SHA1=0c1820931094369c8cc19fc1be62f598bc5961ca"
  ], 
  "ExposedPorts": {
    "6379/tcp": {}
  }, 
  "OnBuild": [], 
  "AttachStderr": false, 
  "Entrypoint": [
    "docker-entrypoint.sh"
  ], 
  "AttachStdout": false, 
  "OpenStdin": false
}
Number of layers: 8
Layers:
  sha256:89fd7ac1e6768d1dd82e596e9dade676e87f1309da2a07f6e748c657b3c634b6 - 647 Bytes
  sha256:8c429fec161a6c1042680f2033c2f7f5efc9b666f9c9ee22bded5d00e43f87f7 - 807933 Bytes
  sha256:4f93af242dfb5159fb9b2a303a1e71df5a39bd1a9a6561c746216897924b8dbf - 16615562 Bytes
  sha256:a3ed95caeb02ffe68cdd9fd84406680ae93d633cb16422d00e8a7c22955b46d4 - 32 Bytes
  sha256:8b87079b7a06f9b72e3cca2c984c60e118229c60f0bff855d822f758c112b485 - 51355855 Bytes
  sha256:284e33235544c2285bd64ce90c1d8c909c92823ab76199dc33bbfe82f74e1870 - 2040 Bytes
  sha256:77b759f85e4a66409a1765a074e3d71edb417ca2e4fdf67fc5c02d7d0a6088ad - 5447529 Bytes
  sha256:53c576ba5eccafa633606c947a44fed94a7ff4b8f965b8fdf10e0109cf64d9ff - 96 Bytes
Image size: 74229694 Bytes

Web服务模式运行

1. 使用docker-compose启动服务

项目提供docker-compose.yml文件，可直接启动服务：

nohighlight
docker-compose up

服务将在Docker IP的5000端口可用。

2. 测试API

可通过以下URL测试API（将<docker_ip>替换为实际Docker IP）：

• http://<docker_ip>:5000/nginx
• http://<docker_ip>:5000/redis:3.2
• http://<docker_ip>:5000/library/redis
• http://<docker_ip>:5000/index.docker.io/library/redis
• http://<docker_ip>:5000/index.docker.io/library/ubuntu:latest
• http://<docker_ip>:5000/index.docker.io/giantswarm/helloworld
• http://<docker_ip>:5000/quay.io/giantswarm/helloworld

Web服务输出示例

API返回JSON格式的镜像信息：

json
{
  "duration": 3.5770351886749268, 
  "error": null, 
  "metadata": {
    "architecture": "amd64", 
    "config": {
      "AttachStderr": false, 
      "AttachStdin": false, 
      "AttachStdout": false, 
      "Cmd": [
        "/bin/sh", 
        "-c", 
        "#(nop) CMD [\"nginx\" \"-g\" \"daemon off;\"]"
      ], 
      "Domainname": "", 
      "Entrypoint": null, 
      "Env": [
        "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin", 
        "NGINX_VERSION=1.9.15-1~jessie"
      ], 
      "ExposedPorts": {
        "443/tcp": {}, 
        "80/tcp": {}
      }, 
      "Hostname": "f416997e8b71", 
      "Image": "317a0530f60c747e425f5a011a943939db69d53beaad8f89c81ace4b487442df", 
      "Labels": {}, 
      "OnBuild": [], 
      "OpenStdin": false, 
      "StdinOnce": false, 
      "Tty": false, 
      "User": "", 
      "Volumes": null, 
      "WorkingDir": ""
    }, 
    "history_length": 8, 
    "image_size": 71175964, 
    "layers": [
      {
        "digest": "sha256:31c7abf879e0ca73db0d8cf61f06343aa653efd1be8cf1dec67f839a9beb71fa", 
        "size": 19819882
      }, 
      {
        "digest": "sha256:4ef177b369db36e463a9bd44b64669f2da2c80436d9d52178840c37783edcf0b", 
        "size": 195
      }, 
      {
        "digest": "sha256:8b87079b7a06f9b72e3cca2c984c60e118229c60f0bff855d822f758c112b485", 
        "size": 51355855
      }, 
      {
        "digest": "sha256:a3ed95caeb02ffe68cdd9fd84406680ae93d633cb16422d00e8a7c22955b46d4", 
        "size": 32
      }
    ], 
    "name": "library/nginx", 
    "num_layers": 4, 
    "schema_version": 1, 
    "tag": "latest"
  }
}

开发环境设置

如需进行开发，可按以下步骤设置Python环境：

nohighlight
git clone https://github.com/giantswarm/inspect-docker-image.git
cd inspect-docker-image/
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt

运行开发版本

• 执行CLI：

  nohighlight
  python imageinspector.py redis:3.2
  

• 启动Web服务（调试模式）：

  nohighlight
  DEBUGGING=1 python service.py