Docker

Collect Docker images from a repository.

Details

Transfer Tag

hoppr.core_plugins.collect_docker_plugin

Supported PURLs

docker

System Dependencies

skopeo

Transfer File Example

---
schemaVersion: v1
kind: transfer

stages:
  collect:
    plugins:
      - name: hoppr.core_plugins.collect_docker_plugin
        config:
          process_timeout: 300

max_processes: 3

Configuration Options

Option	Details
skopeo_command	String. Defaults to skopeo. Command to be used to execute skopeo commands. May be overridden with another command that uses the same syntax, or a fully qualified path if skopeo is not on the default $PATH.
process_timeout	Number of seconds to attempt collect before timeout. Default: 300

[System Dependencies]

Certain Linux distributions may require additional configuration. See the installation page for more information.

Proxy and Certificate Configuration

The Docker Collector plugin uses Skopeo to download container images, so the proxy and certificate configurations are not handled directly by the plugin, instead they must be configured as specified by Skopeo and its dependencies.

To configure proxies, set the following environment variables:

Environment Variable Name	Description
http_proxy	Proxy for the HTTP protocol.
https_proxy	Proxy for the HTTPS protocol.
no_proxy	Comma-separated list of domains where proxies won't be used.

Skopeo uses the containers/image library, so for specifying certificates, a custom TLS configuration for a container registry can be configured by creating a directory under $HOME/.config/containers/certs.d or /etc/containers/certs.d. The name of the directory must correspond to the host:port of the registry (e.g., my-registry.com:5000). For more details, see [https://github.com/containers/image/blob/main/docs/containers-certs.d.5.md].

Credentials Configuration

To specify credentials, you need a credentials file.

Sample credentials file:

---
schemaVersion: v1
kind: Credentials

metadata:
  name: Registry Credentials
  version: v1
  description: Sample credentials file

credential_required_services:
  - url: registry.gitlab.com
    user_env: CI_REGISTRY_USER
    pass_env: CI_REGISTRY_PASSWORD

SBOM Generation Tools

• syft (cli tool)
• sbom-cli-plugin (cli tool)

note

For more tools visit the CycloneDX Tool Center