Skip to main content

BuildImageOptions

@webda/oci

Interface: BuildImageOptions

Defined in: packages/oci/src/image.ts:68

Options of buildImage

Extends​

Properties​

annotations?​

optional annotations?: Record<string, string>

Defined in: packages/oci/src/image.ts:100

Annotations of the manifests

baseImage​

baseImage: string

Defined in: packages/oci/src/image.ts:72

Base image reference, or SCRATCH

cmd?​

optional cmd?: string[]

Defined in: packages/oci/src/image.ts:88

Command, replaces the base one

createdBy?​

optional createdBy?: string

Defined in: packages/oci/src/image.ts:118

Description of the layer in the history

credentials?​

optional credentials?: Record<string, RegistryCredentials>

Defined in: packages/oci/src/image.ts:50

Credentials per registry host, they take precedence over the Docker configuration

Inherited from​

RegistryOptions.credentials

dockerConfig?​

optional dockerConfig?: any

Defined in: packages/oci/src/image.ts:54

Docker configuration, read from ~/.docker/config.json by default

Inherited from​

RegistryOptions.dockerConfig

entrypoint?​

optional entrypoint?: string[]

Defined in: packages/oci/src/image.ts:84

Entrypoint, replaces the base one

env?​

optional env?: Record<string, string>

Defined in: packages/oci/src/image.ts:92

Environment variables, added to or replacing the base ones

exposedPorts?​

optional exposedPorts?: string[]

Defined in: packages/oci/src/image.ts:108

Exposed ports, 8080/tcp

fetch?​

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/oci/src/image.ts:62

fetch implementation, for tests

Call Signature​

(input, init?): Promise<Response>

MDN Reference

Parameters​
input​

RequestInfo | URL

init?​

RequestInit

Returns​

Promise<Response>

Call Signature​

(input, init?): Promise<Response>

MDN Reference

Parameters​
input​

string | Request | URL

init?​

RequestInit

Returns​

Promise<Response>

Inherited from​

RegistryOptions.fetch

includeBaseLayers?​

optional includeBaseLayers?: boolean

Defined in: packages/oci/src/image.ts:125

Copy the base layers into the layout so it is complete; the push copies them registry to registry otherwise

Default​

true

insecureRegistries?​

optional insecureRegistries?: string[]

Defined in: packages/oci/src/image.ts:58

Registries reached over plain http, localhost and 127.0.0.1 always are

Inherited from​

RegistryOptions.insecureRegistries

labels?​

optional labels?: Record<string, string>

Defined in: packages/oci/src/image.ts:96

Labels of the configuration, added to the base ones

mtime?​

optional mtime?: number

Defined in: packages/oci/src/image.ts:114

Creation time of the image and modification time of the files, in seconds

Default​

0

platforms?​

optional platforms?: string[]

Defined in: packages/oci/src/image.ts:76

Platforms to build, linux/amd64 by default: several platforms produce an index

tags?​

optional tags?: string[]

Defined in: packages/oci/src/image.ts:129

Tags recorded in the layout index.json

user?​

optional user?: string

Defined in: packages/oci/src/image.ts:104

User to run as, the base one when undefined

workdir?​

optional workdir?: string

Defined in: packages/oci/src/image.ts:80

Working directory of the image