drone-docker-buildx/_docs/data/data.yaml

268 lines
7.4 KiB
YAML
Raw Normal View History

2022-06-02 19:48:53 +00:00
---
properties:
- name: dry_run
2022-06-02 19:48:53 +00:00
description: Disable docker push.
type: bool
required: false
- name: mirror
2022-06-02 19:48:53 +00:00
description: Use a registry mirror to pull images.
type: string
required: false
- name: storage_driver
2022-06-02 19:48:53 +00:00
description: The docker daemon storage driver.
type: string
required: false
- name: storage_path
2022-06-02 19:48:53 +00:00
description: The docker daemon storage path.
defaultValue: /var/lib/docker
type: string
required: false
- name: bip
2022-06-02 19:48:53 +00:00
description: Allows the docker daemon to bride IP address.
type: string
required: false
- name: mtu
2022-06-02 19:48:53 +00:00
description: A docker daemon custom MTU.
type: string
required: false
- name: custom_dns
2022-06-02 19:48:53 +00:00
description: Custom docker daemon DNS server.
type: list
required: false
- name: custom_dns_search
2022-06-02 19:48:53 +00:00
description: Custom docker daemon DNS search domain.
type: list
required: false
- name: insecure
2022-06-02 19:48:53 +00:00
description: Enable the usage of insecure registries.
type: bool
defaultValue: false
required: false
- name: ipv6
2022-06-02 19:48:53 +00:00
description: Enable docker daemon IPv6 support.
type: bool
defaultValue: false
required: false
- name: experimental
2022-06-02 19:48:53 +00:00
description: Enable docker daemon experimental mode.
type: bool
defaultValue: false
required: false
- name: debug
2022-06-02 19:48:53 +00:00
description: Enable verbose debug mode for the docker daemon.
type: string
defaultValue: false
required: false
- name: daemon_off
2022-06-02 19:48:53 +00:00
description: Disable the startup of the docker daemon.
type: string
defaultValue: false
required: false
- name: buildkit_config
description: |
Content of the docker buildkit toml [config](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md). Example:
```TOML
- name: Build
image: thegeeklab/drone-docker-buildx:23
settings:
repo: example/repo
buildkit_config: |
[registry."registry.local:30081"]
http = true
insecure = true
```
2022-06-02 19:48:53 +00:00
type: string
defaultValue: false
required: false
- name: dockerfile
2022-06-02 19:48:53 +00:00
description: Set dockerfile to use for the image build.
defaultValue: Dockerfile
type: string
required: false
- name: context
2022-06-02 19:48:53 +00:00
description: Set the path of the build context to use.
defaultValue: .
type: string
required: false
- name: named_context
description: Set additional named [build contexts](https://docs.docker.com/engine/reference/commandline/buildx_build/#build-context) (e.g., name=path).
type: list
required: false
- name: tags
2022-06-02 19:48:53 +00:00
description: Set repository tags to use for the image. Tags can also be loaded from a `.tags` file.
defaultValue: latest
type: list
required: false
- name: auto_tag
2022-06-02 19:48:53 +00:00
description: |
Generate tag names automatically based on git branch and git tag. When this feature is enabled and the event type is `tag`,
the plugin will automatically tag the image using the standard semVer convention. For example:
- `1.0.0` produces docker tags `1`, `1.0`, `1.0.0`
- `1.0.0-rc.1` produces docker tags `1.0.0-rc.1`
When the event type is `push` and the target branch is your default branch, the plugin will automatically tag the image
as `latest`. All other event types and branches are ignored.
defaultValue: false
type: bool
required: false
- name: auto_tag_suffix
2022-06-02 19:48:53 +00:00
description: Generate tag names with the given suffix.
type: string
required: false
- name: extra_tags
description: |
Set additional tags to be used for the image. Additional tags can also be loaded from an `.extratags` file. This function can be used
to push images to multiple registries at once. Therefore, it is necessary to use the `config` flag to provide a configuration file
that contains the authentication information for all used registries.
type: list
required: false
- name: build_args
2022-06-02 19:48:53 +00:00
description: Ccustom build arguments to pass to the build.
type: list
required: false
- name: build_args_from_env
2022-06-02 19:48:53 +00:00
description: Forward environment variables as custom arguments to the build.
type: list
required: false
- name: quiet
2022-06-02 19:48:53 +00:00
description: Enable suppression of the build output.
defaultValue: false
type: bool
required: false
- name: target
2022-06-02 19:48:53 +00:00
description: The docker build target.
type: string
required: false
- name: cache_from
description: |
Images to consider as [cache sources](https://docs.docker.com/engine/reference/commandline/buildx_build/#cache-from). To properly work,
commas used in the cache source entries need to be escaped:
```Yaml
- name: Build
image: thegeeklab/drone-docker-buildx:23
settings:
repo: example/repo
cache_from:
# using quotes double-escaping is required
- "type=registry\\\\,ref=example"
- 'type=foo\\,ref=bar'
```
2022-06-02 19:48:53 +00:00
type: list
required: false
- name: cache_to
2022-08-21 20:47:59 +00:00
description: |
[Cache destination](https://docs.docker.com/engine/reference/commandline/buildx_build/#cache-to) for the build cache.
type: string
required: false
- name: pull_image
2022-06-02 19:48:53 +00:00
description: Enforce to pull the base image at build time.
defaultValue: true
type: bool
required: false
- name: compress
2022-06-02 19:48:53 +00:00
description: Enable compression of the build context using gzip.
defaultValue: false
type: bool
required: false
- name: output
2022-06-02 19:48:53 +00:00
description: |
[Export action](https://docs.docker.com/engine/reference/commandline/buildx_build/#output) for the build result
(format: `path` or `type=TYPE[,KEY=VALUE]`).
defaultValue: false
type: bool
required: false
- name: repo
description: |
Repository name for the image. If the image is to be pushed to registries other than the default DockerHub,
it is necessary to set `repo` as fully-qualified name.
2022-06-02 19:48:53 +00:00
type: string
required: false
- name: registry
2022-06-02 19:48:53 +00:00
description: Docker registry to upload images.
defaultValue: https://index.docker.io/v1/
type: string
required: false
- name: username
2022-06-02 19:48:53 +00:00
description: Username for authentication with the registry.
type: string
required: false
- name: password
2022-06-02 19:48:53 +00:00
description: Password for authentication with the registry.
type: string
required: false
- name: email
2022-06-02 19:48:53 +00:00
description: E-Mail address for authentication with the registry.
type: string
required: false
- name: config
2022-06-02 19:48:53 +00:00
description: Content of the docker daemon json config.
type: string
required: false
- name: no_cache
2022-06-02 19:48:53 +00:00
description: Disable the usage of cached intermediate containers.
defaultValue: false
type: string
required: false
- name: add_host
2022-06-02 19:48:53 +00:00
description: Additional `host:ip` mapping.
type: list
required: false
- name: platforms
2022-06-02 19:48:53 +00:00
description: Target platforms for build.
type: list
required: false
- name: labels
description: Labels to add to the image.
type: list
required: false
- name: provenance
description: Generate [provenance](https://docs.docker.com/build/attestations/slsa-provenance/) attestation for the build (shorthand for `--attest=type=provenance`).
type: string
required: false
- name: sbom
description: Generate [sbom](https://docs.docker.com/build/attestations/sbom/) attestation for the build (shorthand for `--attest type=sbom`).
type: string
required: false