sam_oneal/pulumi-docker-build
1
0
Fork 0
Code Actions Packages Releases Wiki Activity

Add note about stability and tweak index docs

Browse Source
This commit is contained in:
Bryce Lampe
2024-04-22 15:57:02 -07:00
parent a6247a78b1
commit 72bd40b97c
14 changed files with 160 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
sdk/python/pulumi_docker_build/index.py generated
View File

@@ -104,13 +104,25 @@ class Index(pulumi.CustomResource):
tag: Optional[pulumi.Input[str]] = None,
__props__=None):
"""
An index (or manifest list) referencing one or more existing images.
A wrapper around `docker buildx imagetools create` to create an index
(or manifest list) referencing one or more existing images.
Useful for crafting a multi-platform image from several
platform-specific images.
In most cases you do not need an `Index` to build a multi-platform
image -- specifying multiple platforms on the `Image` will handle this
for you automatically.
This creates an OCI image index or a Docker manifest list depending on
the media types of the source images.
However, as of April 2024, building multi-platform images _with
caching_ will only export a cache for one platform at a time (see [this
discussion](https://github.com/docker/buildx/discussions/1382) for more
details).
Therefore this resource can be helpful if you are building
multi-platform images with caching: each platform can be built and
cached separately, and an `Index` can join them all together. An
example of this is shown below.
This resource creates an OCI image index or a Docker manifest list
depending on the media types of the source images.
## Example Usage
### Multi-platform registry caching
@@ -179,13 +191,25 @@ class Index(pulumi.CustomResource):
args: IndexArgs,
opts: Optional[pulumi.ResourceOptions] = None):
"""
An index (or manifest list) referencing one or more existing images.
A wrapper around `docker buildx imagetools create` to create an index
(or manifest list) referencing one or more existing images.
Useful for crafting a multi-platform image from several
platform-specific images.
In most cases you do not need an `Index` to build a multi-platform
image -- specifying multiple platforms on the `Image` will handle this
for you automatically.
This creates an OCI image index or a Docker manifest list depending on
the media types of the source images.
However, as of April 2024, building multi-platform images _with
caching_ will only export a cache for one platform at a time (see [this
discussion](https://github.com/docker/buildx/discussions/1382) for more
details).
Therefore this resource can be helpful if you are building
multi-platform images with caching: each platform can be built and
cached separately, and an `Index` can join them all together. An
example of this is shown below.
This resource creates an OCI image index or a Docker manifest list
depending on the media types of the source images.
## Example Usage
### Multi-platform registry caching