Unverified Commit db139804 authored by Joel Holdsworth's avatar Joel Holdsworth
Browse files

dockerTools: Updated Docker and OCI spec links 



Co-authored-by: default avatarcommiterate <111539270+commiterate@users.noreply.github.com>
parent 43759f5f

doc/build-helpers/images/dockertools.section.md

+3 −3
Original line number Diff line number Diff line 
# pkgs.dockerTools {#sec-pkgs-dockerTools}



`pkgs.dockerTools` is a set of functions for creating and manipulating Docker images according to the [Docker Image Specification v1.3.0](https://github.com/moby/moby/blob/46f7ab808b9504d735d600e259ca0723f76fb164/image/spec/spec.md#image-json-field-descriptions).

`pkgs.dockerTools` is a set of functions for creating and manipulating Docker images according to the [Docker Image Specification v1.3.1](https://github.com/moby/docker-image-spec/blob/v1.3.1/spec.md).

Docker itself is not used to perform any of the operations done by these functions.



## buildImage {#ssec-pkgs-dockerTools-buildImage}
@@ -130,7 +130,7 @@ Similarly, if you encounter errors similar to `Error_Protocol ("certificate has 
`config` (Attribute Set or Null; _optional_)



: Used to specify the configuration of the containers that will be started off the generated image.

  Must be an attribute set, with each attribute as listed in the [Docker Image Specification v1.3.0](https://github.com/moby/moby/blob/46f7ab808b9504d735d600e259ca0723f76fb164/image/spec/spec.md#image-json-field-descriptions).

  Must be an attribute set, with each attribute as listed in the [Docker Image Specification v1.3.1](https://github.com/moby/docker-image-spec/blob/v1.3.1/spec.md#image-json-field-descriptions).



  _Default value:_ `null`.
@@ -138,7 +138,7 @@ Similarly, if you encounter errors similar to `Error_Protocol ("certificate has 


: Used to specify the image architecture.

  This is useful for multi-architecture builds that don't need cross compiling.

  If specified, its value should follow the [OCI Image Configuration Specification](https://github.com/opencontainers/image-spec/blob/main/config.md#properties), which should still be compatible with Docker.

  If specified, its value should follow the [OCI Image Configuration Specification](https://github.com/opencontainers/image-spec/blob/v1.1.1/config.md#properties), which should still be compatible with Docker.

  According to the linked specification, all possible values for `$GOARCH` in [the Go docs](https://go.dev/doc/install/source#environment) should be valid, but will commonly be one of `386`, `amd64`, `arm`, or `arm64`.



  _Default value:_ the same value from `pkgs.go.GOARCH`.