@pulumi/docker 4.6.0-alpha.4 → 4.6.0-beta.2

package/types/output.d.ts

@@ -1,4 +1,5 @@
 import * as outputs from "../types/output";
+import * as enums from "../types/enums";
 export interface ContainerCapabilities {
     /**
      * List of linux capabilities to add.
@@ -142,13 +143,37 @@ export interface ContainerMountVolumeOptionsLabel {
     value: string;
 }
 export interface ContainerNetworkData {
+    /**
+     * The network gateway of the container.
+     */
     gateway: string;
+    /**
+     * The IPV6 address of the container.
+     */
     globalIpv6Address: string;
+    /**
+     * The IPV6 prefix length address of the container.
+     */
     globalIpv6PrefixLength: number;
+    /**
+     * The IP address of the container.
+     */
     ipAddress: string;
+    /**
+     * The IP prefix length of the container.
+     */
     ipPrefixLength: number;
+    /**
+     * The IPV6 gateway of the container.
+     */
     ipv6Gateway: string;
+    /**
+     * The MAC address of the container.
+     */
     macAddress: string;
+    /**
+     * The name of the network
+     */
     networkName: string;
 }
 export interface ContainerNetworksAdvanced {
@@ -206,6 +231,9 @@ export interface ContainerUpload {
      * Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text. Conflicts with `contentBase64` & `source`
      */
     content?: string;
+    /**
+     * Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for larger binary content such as the result of the `base64encode` interpolation function. See here for the reason. Conflicts with `content` & `source`
+     */
     contentBase64?: string;
     /**
      * If `true`, the file will be uploaded with user executable permission. Defaults to `false`.
@@ -247,11 +275,23 @@ export interface ContainerVolume {
     volumeName?: string;
 }
 export interface GetNetworkIpamConfig {
+    /**
+     * Auxiliary IPv4 or IPv6 addresses used by Network driver
+     */
     auxAddress?: {
         [key: string]: any;
     };
+    /**
+     * The IP address of the gateway
+     */
     gateway?: string;
+    /**
+     * The ip range in CIDR form
+     */
     ipRange?: string;
+    /**
+     * The subnet in CIDR form
+     */
     subnet?: string;
 }
 export interface NetworkIpamConfig {
@@ -708,7 +748,7 @@ export interface ServiceTaskSpecContainerSpec {
      */
     privileges?: outputs.ServiceTaskSpecContainerSpecPrivileges;
     /**
-     * Whether the mount should be read-only
+     * Mount the container's root filesystem as read only
      */
     readOnly?: boolean;
     /**
@@ -730,7 +770,7 @@ export interface ServiceTaskSpecContainerSpec {
         [key: string]: any;
     };
     /**
-     * SELinux user label
+     * The user inside the container
      */
     user?: string;
 }
@@ -792,7 +832,7 @@ export interface ServiceTaskSpecContainerSpecHealthcheck {
      */
     tests: string[];
     /**
-     * The timeout of the service to reach the desired state `(s|m)`. Defaults to `3m`
+     * Maximum time to allow one check to run (ms|s|m|h). Defaults to `0s`.
      */
     timeout?: string;
 }
@@ -854,7 +894,7 @@ export interface ServiceTaskSpecContainerSpecMountBindOptions {
 }
 export interface ServiceTaskSpecContainerSpecMountTmpfsOptions {
     /**
-     * The mode of resolution to use for internal load balancing between tasks
+     * The permission mode for the tmpfs mount in an integer
      */
     mode?: number;
     /**
@@ -926,7 +966,7 @@ export interface ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext {
      */
     role?: string;
     /**
-     * The mount type
+     * SELinux type label
      */
     type?: string;
     /**
@@ -936,11 +976,11 @@ export interface ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext {
 }
 export interface ServiceTaskSpecContainerSpecSecret {
     /**
-     * Represents the file GID. Defaults to `0`.
+     * Represents the file GID. Defaults to `0`
      */
     fileGid?: string;
     /**
-     * Represents represents the FileMode of the file. Defaults to `0o444`.
+     * Represents represents the FileMode of the file. Defaults to `0o444`
      */
     fileMode?: number;
     /**
@@ -948,7 +988,7 @@ export interface ServiceTaskSpecContainerSpecSecret {
      */
     fileName: string;
     /**
-     * Represents the file UID. Defaults to `0`.
+     * Represents the file UID. Defaults to `0`
      */
     fileUid?: string;
     /**
@@ -962,11 +1002,11 @@ export interface ServiceTaskSpecContainerSpecSecret {
 }
 export interface ServiceTaskSpecLogDriver {
     /**
-     * A random name for the port
+     * The logging driver to use
      */
     name: string;
     /**
-     * A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.)
+     * The options for the logging driver
      */
     options?: {
         [key: string]: string;
@@ -982,7 +1022,7 @@ export interface ServiceTaskSpecNetworksAdvanced {
      */
     driverOpts?: string[];
     /**
-     * A random name for the port
+     * The name/id of the network.
      */
     name: string;
 }
@@ -1044,7 +1084,7 @@ export interface ServiceTaskSpecResourcesReservation {
      */
     memoryBytes?: number;
     /**
-     * CPU shares in units of `1/1e9` (or `10^-9`) of the CPU. Should be at least `1000000`
+     * CPU shares in units of 1/1e9 (or 10^-9) of the CPU. Should be at least `1000000`
      */
     nanoCpus?: number;
 }
@@ -1064,7 +1104,7 @@ export interface ServiceTaskSpecRestartPolicy {
      */
     condition?: string;
     /**
-     * The interval to check if the desired state is reached `(ms|s)`. Defaults to `7s`.
+     * Delay between restart attempts (ms|s|m|h)
      */
     delay?: string;
     /**
@@ -1113,41 +1153,778 @@ export interface VolumeLabel {
     value: string;
 }
 export declare namespace buildx {
-    interface Manifest {
-        digest: string;
-        platform: outputs.buildx.Platform;
+    interface BuildContext {
+        /**
+         * Resources to use for build context.
+         *
+         * The location can be:
+         * * A relative or absolute path to a local directory (`.`, `./app`,
+         *   `/app`, etc.).
+         * * A remote URL of a Git repository, tarball, or plain text file
+         *   (`https://github.com/user/myrepo.git`, `http://server/context.tar.gz`,
+         *   etc.).
+         */
+        location: string;
+        /**
+         * Additional build contexts to use.
+         *
+         * These contexts are accessed with `FROM name` or `--from=name`
+         * statements when using Dockerfile 1.4+ syntax.
+         *
+         * Values can be local paths, HTTP URLs, or  `docker-image://` images.
+         */
+        named?: {
+            [key: string]: outputs.buildx.Context;
+        };
+    }
+    interface BuilderConfig {
+        /**
+         * Name of an existing buildx builder to use.
+         *
+         * Only `docker-container`, `kubernetes`, or `remote` drivers are
+         * supported. The legacy `docker` driver is not supported.
+         *
+         * Equivalent to Docker's `--builder` flag.
+         */
+        name?: string;
+    }
+    interface CacheFromAzureBlob {
+        /**
+         * Base URL of the storage account.
+         */
+        accountUrl?: string;
+        /**
+         * The name of the cache image.
+         */
+        name: string;
+        /**
+         * Blob storage account key.
+         */
+        secretAccessKey?: string;
+    }
+    interface CacheFromEntry {
+        /**
+         * Upload build caches to Azure's blob storage service.
+         */
+        azblob?: outputs.buildx.CacheFromAzureBlob;
+        /**
+         * When `true` this entry will be excluded. Defaults to `false`.
+         */
+        disabled?: boolean;
+        /**
+         * Recommended for use with GitHub Actions workflows.
+         *
+         * An action like `crazy-max/ghaction-github-runtime` is recommended to
+         * expose appropriate credentials to your GitHub workflow.
+         */
+        gha?: outputs.buildx.CacheFromGitHubActions;
+        /**
+         * A simple backend which caches images on your local filesystem.
+         */
+        local?: outputs.buildx.CacheFromLocal;
+        /**
+         * A raw string as you would provide it to the Docker CLI (e.g.,
+         * `type=inline`).
+         */
+        raw?: string;
+        /**
+         * Upload build caches to remote registries.
+         */
+        registry?: outputs.buildx.CacheFromRegistry;
+        /**
+         * Upload build caches to AWS S3 or an S3-compatible services such as
+         * MinIO.
+         */
+        s3?: outputs.buildx.CacheFromS3;
+    }
+    /**
+     * cacheFromEntryProvideDefaults sets the appropriate defaults for CacheFromEntry
+     */
+    function cacheFromEntryProvideDefaults(val: CacheFromEntry): CacheFromEntry;
+    interface CacheFromGitHubActions {
+        /**
+         * The scope to use for cache keys. Defaults to `buildkit`.
+         *
+         * This should be set if building and caching multiple images in one
+         * workflow, otherwise caches will overwrite each other.
+         */
+        scope?: string;
+        /**
+         * The GitHub Actions token to use. This is not a personal access tokens
+         * and is typically generated automatically as part of each job.
+         *
+         * Defaults to `$ACTIONS_RUNTIME_TOKEN`, although a separate action like
+         * `crazy-max/ghaction-github-runtime` is recommended to expose this
+         * environment variable to your jobs.
+         */
+        token?: string;
+        /**
+         * The cache server URL to use for artifacts.
+         *
+         * Defaults to `$ACTIONS_RUNTIME_URL`, although a separate action like
+         * `crazy-max/ghaction-github-runtime` is recommended to expose this
+         * environment variable to your jobs.
+         */
+        url?: string;
+    }
+    /**
+     * cacheFromGitHubActionsProvideDefaults sets the appropriate defaults for CacheFromGitHubActions
+     */
+    function cacheFromGitHubActionsProvideDefaults(val: CacheFromGitHubActions): CacheFromGitHubActions;
+    interface CacheFromLocal {
+        /**
+         * Digest of manifest to import.
+         */
+        digest?: string;
+        /**
+         * Path of the local directory where cache gets imported from.
+         */
+        src: string;
+    }
+    interface CacheFromRegistry {
+        /**
+         * Fully qualified name of the cache image to import.
+         */
+        ref: string;
+    }
+    interface CacheFromS3 {
+        /**
+         * Defaults to `$AWS_ACCESS_KEY_ID`.
+         */
+        accessKeyId?: string;
+        /**
+         * Prefix to prepend to blob filenames.
+         */
+        blobsPrefix?: string;
+        /**
+         * Name of the S3 bucket.
+         */
+        bucket: string;
+        /**
+         * Endpoint of the S3 bucket.
+         */
+        endpointUrl?: string;
+        /**
+         * Prefix to prepend on manifest filenames.
+         */
+        manifestsPrefix?: string;
+        /**
+         * Name of the cache image.
+         */
+        name?: string;
+        /**
+         * The geographic location of the bucket. Defaults to `$AWS_REGION`.
+         */
+        region: string;
+        /**
+         * Defaults to `$AWS_SECRET_ACCESS_KEY`.
+         */
+        secretAccessKey?: string;
+        /**
+         * Defaults to `$AWS_SESSION_TOKEN`.
+         */
+        sessionToken?: string;
+        /**
+         * Uses `bucket` in the URL instead of hostname when `true`.
+         */
+        usePathStyle?: boolean;
+    }
+    /**
+     * cacheFromS3ProvideDefaults sets the appropriate defaults for CacheFromS3
+     */
+    function cacheFromS3ProvideDefaults(val: CacheFromS3): CacheFromS3;
+    interface CacheToAzureBlob {
+        /**
+         * Base URL of the storage account.
+         */
+        accountUrl?: string;
+        /**
+         * Ignore errors caused by failed cache exports.
+         */
+        ignoreError?: boolean;
+        /**
+         * The cache mode to use. Defaults to `min`.
+         */
+        mode?: enums.buildx.CacheMode;
+        /**
+         * The name of the cache image.
+         */
+        name: string;
+        /**
+         * Blob storage account key.
+         */
+        secretAccessKey?: string;
+    }
+    /**
+     * cacheToAzureBlobProvideDefaults sets the appropriate defaults for CacheToAzureBlob
+     */
+    function cacheToAzureBlobProvideDefaults(val: CacheToAzureBlob): CacheToAzureBlob;
+    interface CacheToEntry {
+        /**
+         * Push cache to Azure's blob storage service.
+         */
+        azblob?: outputs.buildx.CacheToAzureBlob;
+        /**
+         * When `true` this entry will be excluded. Defaults to `false`.
+         */
+        disabled?: boolean;
+        /**
+         * Recommended for use with GitHub Actions workflows.
+         *
+         * An action like `crazy-max/ghaction-github-runtime` is recommended to
+         * expose appropriate credentials to your GitHub workflow.
+         */
+        gha?: outputs.buildx.CacheToGitHubActions;
+        /**
+         * The inline cache storage backend is the simplest implementation to get
+         * started with, but it does not handle multi-stage builds. Consider the
+         * `registry` cache backend instead.
+         */
+        inline?: outputs.buildx.CacheToInline;
+        /**
+         * A simple backend which caches imagines on your local filesystem.
+         */
+        local?: outputs.buildx.CacheToLocal;
+        /**
+         * A raw string as you would provide it to the Docker CLI (e.g.,
+         * `type=inline`)
+         */
+        raw?: string;
+        /**
+         * Push caches to remote registries. Incompatible with the `docker` build
+         * driver.
+         */
+        registry?: outputs.buildx.CacheToRegistry;
+        /**
+         * Push cache to AWS S3 or S3-compatible services such as MinIO.
+         */
+        s3?: outputs.buildx.CacheToS3;
+    }
+    /**
+     * cacheToEntryProvideDefaults sets the appropriate defaults for CacheToEntry
+     */
+    function cacheToEntryProvideDefaults(val: CacheToEntry): CacheToEntry;
+    interface CacheToGitHubActions {
+        /**
+         * Ignore errors caused by failed cache exports.
+         */
+        ignoreError?: boolean;
+        /**
+         * The cache mode to use. Defaults to `min`.
+         */
+        mode?: enums.buildx.CacheMode;
+        /**
+         * The scope to use for cache keys. Defaults to `buildkit`.
+         *
+         * This should be set if building and caching multiple images in one
+         * workflow, otherwise caches will overwrite each other.
+         */
+        scope?: string;
+        /**
+         * The GitHub Actions token to use. This is not a personal access tokens
+         * and is typically generated automatically as part of each job.
+         *
+         * Defaults to `$ACTIONS_RUNTIME_TOKEN`, although a separate action like
+         * `crazy-max/ghaction-github-runtime` is recommended to expose this
+         * environment variable to your jobs.
+         */
+        token?: string;
+        /**
+         * The cache server URL to use for artifacts.
+         *
+         * Defaults to `$ACTIONS_RUNTIME_URL`, although a separate action like
+         * `crazy-max/ghaction-github-runtime` is recommended to expose this
+         * environment variable to your jobs.
+         */
+        url?: string;
+    }
+    /**
+     * cacheToGitHubActionsProvideDefaults sets the appropriate defaults for CacheToGitHubActions
+     */
+    function cacheToGitHubActionsProvideDefaults(val: CacheToGitHubActions): CacheToGitHubActions;
+    interface CacheToInline {
+    }
+    interface CacheToLocal {
+        /**
+         * The compression type to use.
+         */
+        compression?: enums.buildx.CompressionType;
+        /**
+         * Compression level from 0 to 22.
+         */
+        compressionLevel?: number;
+        /**
+         * Path of the local directory to export the cache.
+         */
+        dest: string;
+        /**
+         * Forcefully apply compression.
+         */
+        forceCompression?: boolean;
+        /**
+         * Ignore errors caused by failed cache exports.
+         */
+        ignoreError?: boolean;
+        /**
+         * The cache mode to use. Defaults to `min`.
+         */
+        mode?: enums.buildx.CacheMode;
+    }
+    /**
+     * cacheToLocalProvideDefaults sets the appropriate defaults for CacheToLocal
+     */
+    function cacheToLocalProvideDefaults(val: CacheToLocal): CacheToLocal;
+    interface CacheToRegistry {
+        /**
+         * The compression type to use.
+         */
+        compression?: enums.buildx.CompressionType;
+        /**
+         * Compression level from 0 to 22.
+         */
+        compressionLevel?: number;
         /**
-         * The manifest's ref
+         * Forcefully apply compression.
+         */
+        forceCompression?: boolean;
+        /**
+         * Ignore errors caused by failed cache exports.
+         */
+        ignoreError?: boolean;
+        /**
+         * Export cache manifest as an OCI-compatible image manifest instead of a
+         * manifest list (requires OCI media types).
+         *
+         * Defaults to `false`.
+         */
+        imageManifest?: boolean;
+        /**
+         * The cache mode to use. Defaults to `min`.
+         */
+        mode?: enums.buildx.CacheMode;
+        /**
+         * Whether to use OCI media types in exported manifests. Defaults to
+         * `true`.
+         */
+        ociMediaTypes?: boolean;
+        /**
+         * Fully qualified name of the cache image to import.
          */
         ref: string;
-        size: number;
     }
-    interface Platform {
-        architecture: string;
-        os: string;
+    /**
+     * cacheToRegistryProvideDefaults sets the appropriate defaults for CacheToRegistry
+     */
+    function cacheToRegistryProvideDefaults(val: CacheToRegistry): CacheToRegistry;
+    interface CacheToS3 {
+        /**
+         * Defaults to `$AWS_ACCESS_KEY_ID`.
+         */
+        accessKeyId?: string;
+        /**
+         * Prefix to prepend to blob filenames.
+         */
+        blobsPrefix?: string;
+        /**
+         * Name of the S3 bucket.
+         */
+        bucket: string;
+        /**
+         * Endpoint of the S3 bucket.
+         */
+        endpointUrl?: string;
+        /**
+         * Ignore errors caused by failed cache exports.
+         */
+        ignoreError?: boolean;
+        /**
+         * Prefix to prepend on manifest filenames.
+         */
+        manifestsPrefix?: string;
+        /**
+         * The cache mode to use. Defaults to `min`.
+         */
+        mode?: enums.buildx.CacheMode;
+        /**
+         * Name of the cache image.
+         */
+        name?: string;
+        /**
+         * The geographic location of the bucket. Defaults to `$AWS_REGION`.
+         */
+        region: string;
+        /**
+         * Defaults to `$AWS_SECRET_ACCESS_KEY`.
+         */
+        secretAccessKey?: string;
+        /**
+         * Defaults to `$AWS_SESSION_TOKEN`.
+         */
+        sessionToken?: string;
+        /**
+         * Uses `bucket` in the URL instead of hostname when `true`.
+         */
+        usePathStyle?: boolean;
+    }
+    /**
+     * cacheToS3ProvideDefaults sets the appropriate defaults for CacheToS3
+     */
+    function cacheToS3ProvideDefaults(val: CacheToS3): CacheToS3;
+    interface Context {
+        /**
+         * Resources to use for build context.
+         *
+         * The location can be:
+         * * A relative or absolute path to a local directory (`.`, `./app`,
+         *   `/app`, etc.).
+         * * A remote URL of a Git repository, tarball, or plain text file
+         *   (`https://github.com/user/myrepo.git`, `http://server/context.tar.gz`,
+         *   etc.).
+         */
+        location: string;
+    }
+    interface Dockerfile {
+        /**
+         * Raw Dockerfile contents.
+         *
+         * Conflicts with `location`.
+         *
+         * Equivalent to invoking Docker with `-f -`.
+         */
+        inline?: string;
+        /**
+         * Location of the Dockerfile to use.
+         *
+         * Can be a relative or absolute path to a local file, or a remote URL.
+         *
+         * Defaults to `${context.location}/Dockerfile` if context is on-disk.
+         *
+         * Conflicts with `inline`.
+         */
+        location?: string;
+    }
+    interface ExportDocker {
+        /**
+         * Attach an arbitrary key/value annotation to the image.
+         */
+        annotations?: {
+            [key: string]: string;
+        };
+        /**
+         * The compression type to use.
+         */
+        compression?: enums.buildx.CompressionType;
+        /**
+         * Compression level from 0 to 22.
+         */
+        compressionLevel?: number;
+        /**
+         * The local export path.
+         */
+        dest?: string;
+        /**
+         * Forcefully apply compression.
+         */
+        forceCompression?: boolean;
+        /**
+         * Specify images names to export. This is overridden if tags are already specified.
+         */
+        names?: string[];
+        /**
+         * Use OCI media types in exporter manifests.
+         */
+        ociMediaTypes?: boolean;
+        /**
+         * Bundle the output into a tarball layout.
+         */
+        tar?: boolean;
+    }
+    /**
+     * exportDockerProvideDefaults sets the appropriate defaults for ExportDocker
+     */
+    function exportDockerProvideDefaults(val: ExportDocker): ExportDocker;
+    interface ExportEntry {
+        /**
+         * When `true` this entry will be excluded. Defaults to `false`.
+         */
+        disabled?: boolean;
+        /**
+         * Export as a Docker image layout.
+         */
+        docker?: outputs.buildx.ExportDocker;
+        /**
+         * Outputs the build result into a container image format.
+         */
+        image?: outputs.buildx.ExportImage;
+        /**
+         * Export to a local directory as files and directories.
+         */
+        local?: outputs.buildx.ExportLocal;
+        /**
+         * Identical to the Docker exporter but uses OCI media types by default.
+         */
+        oci?: outputs.buildx.ExportOCI;
+        /**
+         * A raw string as you would provide it to the Docker CLI (e.g.,
+         * `type=docker`)
+         */
+        raw?: string;
+        /**
+         * Identical to the Image exporter, but pushes by default.
+         */
+        registry?: outputs.buildx.ExportRegistry;
+        /**
+         * Export to a local directory as a tarball.
+         */
+        tar?: outputs.buildx.ExportTar;
+    }
+    /**
+     * exportEntryProvideDefaults sets the appropriate defaults for ExportEntry
+     */
+    function exportEntryProvideDefaults(val: ExportEntry): ExportEntry;
+    interface ExportImage {
+        /**
+         * Attach an arbitrary key/value annotation to the image.
+         */
+        annotations?: {
+            [key: string]: string;
+        };
+        /**
+         * The compression type to use.
+         */
+        compression?: enums.buildx.CompressionType;
+        /**
+         * Compression level from 0 to 22.
+         */
+        compressionLevel?: number;
+        /**
+         * Name image with `prefix@<digest>`, used for anonymous images.
+         */
+        danglingNamePrefix?: string;
+        /**
+         * Forcefully apply compression.
+         */
+        forceCompression?: boolean;
+        /**
+         * Allow pushing to an insecure registry.
+         */
+        insecure?: boolean;
+        /**
+         * Add additional canonical name (`name@<digest>`).
+         */
+        nameCanonical?: boolean;
+        /**
+         * Specify images names to export. This is overridden if tags are already specified.
+         */
+        names?: string[];
+        /**
+         * Use OCI media types in exporter manifests.
+         */
+        ociMediaTypes?: boolean;
+        /**
+         * Push after creating the image.
+         */
+        push?: boolean;
+        /**
+         * Push image without name.
+         */
+        pushByDigest?: boolean;
+        /**
+         * Store resulting images to the worker's image store and ensure all of
+         * its blobs are in the content store.
+         *
+         * Defaults to `true`.
+         *
+         * Ignored if the worker doesn't have image store (when using OCI workers,
+         * for example).
+         */
+        store?: boolean;
+        /**
+         * Unpack image after creation (for use with containerd). Defaults to
+         * `false`.
+         */
+        unpack?: boolean;
+    }
+    /**
+     * exportImageProvideDefaults sets the appropriate defaults for ExportImage
+     */
+    function exportImageProvideDefaults(val: ExportImage): ExportImage;
+    interface ExportLocal {
+        /**
+         * Output path.
+         */
+        dest: string;
+    }
+    interface ExportOCI {
+        /**
+         * Attach an arbitrary key/value annotation to the image.
+         */
+        annotations?: {
+            [key: string]: string;
+        };
+        /**
+         * The compression type to use.
+         */
+        compression?: enums.buildx.CompressionType;
+        /**
+         * Compression level from 0 to 22.
+         */
+        compressionLevel?: number;
+        /**
+         * The local export path.
+         */
+        dest?: string;
+        /**
+         * Forcefully apply compression.
+         */
+        forceCompression?: boolean;
+        /**
+         * Specify images names to export. This is overridden if tags are already specified.
+         */
+        names?: string[];
+        /**
+         * Use OCI media types in exporter manifests.
+         */
+        ociMediaTypes?: boolean;
+        /**
+         * Bundle the output into a tarball layout.
+         */
+        tar?: boolean;
+    }
+    /**
+     * exportOCIProvideDefaults sets the appropriate defaults for ExportOCI
+     */
+    function exportOCIProvideDefaults(val: ExportOCI): ExportOCI;
+    interface ExportRegistry {
+        /**
+         * Attach an arbitrary key/value annotation to the image.
+         */
+        annotations?: {
+            [key: string]: string;
+        };
+        /**
+         * The compression type to use.
+         */
+        compression?: enums.buildx.CompressionType;
+        /**
+         * Compression level from 0 to 22.
+         */
+        compressionLevel?: number;
+        /**
+         * Name image with `prefix@<digest>`, used for anonymous images.
+         */
+        danglingNamePrefix?: string;
+        /**
+         * Forcefully apply compression.
+         */
+        forceCompression?: boolean;
+        /**
+         * Allow pushing to an insecure registry.
+         */
+        insecure?: boolean;
+        /**
+         * Add additional canonical name (`name@<digest>`).
+         */
+        nameCanonical?: boolean;
+        /**
+         * Specify images names to export. This is overridden if tags are already specified.
+         */
+        names?: string[];
+        /**
+         * Use OCI media types in exporter manifests.
+         */
+        ociMediaTypes?: boolean;
+        /**
+         * Push after creating the image.
+         */
+        push?: boolean;
+        /**
+         * Push image without name.
+         */
+        pushByDigest?: boolean;
+        /**
+         * Store resulting images to the worker's image store and ensure all of
+         * its blobs are in the content store.
+         *
+         * Defaults to `true`.
+         *
+         * Ignored if the worker doesn't have image store (when using OCI workers,
+         * for example).
+         */
+        store?: boolean;
+        /**
+         * Unpack image after creation (for use with containerd). Defaults to
+         * `false`.
+         */
+        unpack?: boolean;
+    }
+    /**
+     * exportRegistryProvideDefaults sets the appropriate defaults for ExportRegistry
+     */
+    function exportRegistryProvideDefaults(val: ExportRegistry): ExportRegistry;
+    interface ExportTar {
+        /**
+         * Output path.
+         */
+        dest: string;
     }
     interface RegistryAuth {
         /**
-         * The registry's address (e.g. "docker.io")
+         * The registry's address (e.g. "docker.io").
          */
         address: string;
         /**
-         * Password or token for the registry
+         * Password or token for the registry.
          */
         password?: string;
         /**
-         * Username for the registry
+         * Username for the registry.
          */
         username?: string;
     }
+    interface SSH {
+        /**
+         * Useful for distinguishing different servers that are part of the same
+         * build.
+         *
+         * A value of `default` is appropriate if only dealing with a single host.
+         */
+        id: string;
+        /**
+         * SSH agent socket or private keys to expose to the build under the given
+         * identifier.
+         *
+         * Defaults to `[$SSH_AUTH_SOCK]`.
+         *
+         * Note that your keys are **not** automatically added when using an
+         * agent. Run `ssh-add -l` locally to confirm which public keys are
+         * visible to the agent; these will be exposed to your build.
+         */
+        paths?: string[];
+    }
 }
 export declare namespace config {
     interface RegistryAuth {
+        /**
+         * Address of the registry.
+         */
         address: string;
         authDisabled?: boolean;
+        /**
+         * Path to docker json file for registry auth. Defaults to `~/.docker/config.json`. If `DOCKER_CONFIG` is set, the value of `DOCKER_CONFIG` is used as the path. `configFile` has predencen over all other options.
+         */
         configFile?: string;
+        /**
+         * Plain content of the docker json file for registry auth. `configFileContent` has precedence over username/password.
+         */
         configFileContent?: string;
+        /**
+         * Password for the registry. Defaults to `DOCKER_REGISTRY_PASS` env variable if set.
+         */
         password?: string;
+        /**
+         * Username for the registry. Defaults to `DOCKER_REGISTRY_USER` env variable if set.
+         */
         username?: string;
     }
 }