cpln.getImages

Use this data source to access information about all Images within Control Plane.

Optional

• query (Block List, Max: 1) (see below).

query

Optional:

• fetch (String) Type of fetch. Specify either: links or items. Default: items.
• spec (Block List, Max: 1) (see below).

query.spec

Optional:

• match (String) Type of match. Available values: all, any, none. Default: all.
• terms (Block List) (see below).

query.spec.terms

Terms can only contain one of the following attributes: property, rel, tag.

Optional:

• op (String) Type of query operation. Available values: =, >, >=, <, <=, !=, exists, !exists. Default: =.

• property (String) Property to use for query evaluation.

• rel (String) Rel to use use for query evaluation.

• tag (String) Tag key to use for query evaluation.

• value (String) Testing value for query evaluation.

Outputs

The following attributes are exported:

• images (Block List) (see below).

images

• cpln_id (String) The ID, in GUID format, of the Image.
• name (String) Name of the Image.
• tags (Map of String) Key-value map of resource tags.
• self_link (String) Full link to this resource. Can be referenced by other resources.
• tag (String) Tag of the image.
• repository (String) Respository name of the image.
• digest (String) A unique SHA256 hash used to identify a specific image version within the image registry.
• manifest (Block List, Max: 1) (see below)

manifest

The manifest provides configuration and layers information about the image. It plays a crucial role in the Docker image distribution system, enabling image creation, verification, and replication in a consistent and secure manner.

• config (Block List, Max: 1) (see below).
• layers (Block List) (see below).
• media_type (String) Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
• schema_version (Number) The version of the Docker Image Manifest format.

config and layers

The config is a JSON blob that contains the image configuration data which includes environment variables, default command to run, and other settings necessary to run the container based on this image.

Layers lists the digests of the image’s layers. These layers are filesystem changes or additions made in each step of the Docker image’s creation process. The layers are stored separately and pulled as needed, which allows for efficient storage and transfer of images. Each layer is represented by a SHA256 digest, ensuring the integrity and authenticity of the image.

• size (Number) The size of the image or layer in bytes. This helps in estimating the space required and the download time.
• digest (String) A unique SHA256 hash used to identify a specific image version within the image registry.
• media_type (String) Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.

Using getImages

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getImages(args: GetImagesArgs, opts?: InvokeOptions): Promise<GetImagesResult>
function getImagesOutput(args: GetImagesOutputArgs, opts?: InvokeOptions): Output<GetImagesResult>

def get_images(query: Optional[GetImagesQuery] = None,
               opts: Optional[InvokeOptions] = None) -> GetImagesResult
def get_images_output(query: Optional[pulumi.Input[GetImagesQueryArgs]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetImagesResult]

func GetImages(ctx *Context, args *GetImagesArgs, opts ...InvokeOption) (*GetImagesResult, error)
func GetImagesOutput(ctx *Context, args *GetImagesOutputArgs, opts ...InvokeOption) GetImagesResultOutput

public static class GetImages 
{
    public static Task<GetImagesResult> InvokeAsync(GetImagesArgs args, InvokeOptions? opts = null)
    public static Output<GetImagesResult> Invoke(GetImagesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetImagesResult> getImages(GetImagesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: cpln:index/getImages:getImages
  arguments:
    # arguments dictionary

The following arguments are supported:

getImages Result

The following output properties are available:

Supporting Types

GetImagesImage

GetImagesImageManifest

GetImagesImageManifestConfig

GetImagesImageManifestLayer

GetImagesQuery

GetImagesQuerySpec

GetImagesQuerySpecTerm

Package Details

Repository

cpln pulumiverse/pulumi-cpln

License

Apache-2.0

Notes

This Pulumi package is based on the cpln Terraform Provider.