@pulumi/docker 4.6.0-beta.4 → 4.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/config/vars.d.ts +6 -8
- package/config/vars.js.map +1 -1
- package/container.d.ts +46 -57
- package/container.js +22 -21
- package/container.js.map +1 -1
- package/getLogs.d.ts +1 -1
- package/getLogs.js +14 -1
- package/getLogs.js.map +1 -1
- package/getNetwork.d.ts +2 -2
- package/getNetwork.js +4 -1
- package/getNetwork.js.map +1 -1
- package/getPlugin.d.ts +27 -9
- package/getPlugin.js +32 -9
- package/getPlugin.js.map +1 -1
- package/getRegistryImage.d.ts +9 -9
- package/getRegistryImage.js +13 -9
- package/getRegistryImage.js.map +1 -1
- package/getRemoteImage.d.ts +9 -1
- package/getRemoteImage.js +12 -1
- package/getRemoteImage.js.map +1 -1
- package/image.d.ts +8 -6
- package/image.js +7 -4
- package/image.js.map +1 -1
- package/index.d.ts +1 -2
- package/index.js +1 -3
- package/index.js.map +1 -1
- package/network.d.ts +19 -19
- package/network.js +13 -13
- package/package.json +4 -3
- package/plugin.d.ts +3 -20
- package/plugin.js +0 -17
- package/plugin.js.map +1 -1
- package/provider.d.ts +11 -14
- package/provider.js.map +1 -1
- package/registryImage.d.ts +3 -20
- package/registryImage.js +0 -17
- package/registryImage.js.map +1 -1
- package/remoteImage.d.ts +44 -16
- package/remoteImage.js +32 -4
- package/remoteImage.js.map +1 -1
- package/secret.d.ts +1 -1
- package/secret.js +1 -1
- package/service.d.ts +23 -30
- package/service.js +23 -30
- package/service.js.map +1 -1
- package/serviceConfig.d.ts +13 -13
- package/serviceConfig.js +13 -13
- package/types/enums/index.d.ts +0 -2
- package/types/enums/index.js +1 -4
- package/types/enums/index.js.map +1 -1
- package/types/input.d.ts +3 -767
- package/types/input.js +0 -116
- package/types/input.js.map +1 -1
- package/types/output.d.ts +4 -769
- package/types/output.js +0 -115
- package/types/output.js.map +1 -1
- package/volume.d.ts +16 -16
- package/volume.js +13 -13
- package/buildx/image.d.ts +0 -916
- package/buildx/image.js +0 -558
- package/buildx/image.js.map +0 -1
- package/buildx/index.d.ts +0 -7
- package/buildx/index.js +0 -42
- package/buildx/index.js.map +0 -1
- package/buildx/index_.d.ts +0 -140
- package/buildx/index_.js +0 -130
- package/buildx/index_.js.map +0 -1
- package/package.json.bak +0 -28
- package/types/enums/buildx/index.d.ts +0 -72
- package/types/enums/buildx/index.js +0 -74
- package/types/enums/buildx/index.js.map +0 -1
package/types/output.d.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import * as outputs from "../types/output";
|
|
2
|
-
import * as enums from "../types/enums";
|
|
3
2
|
export interface ContainerCapabilities {
|
|
4
3
|
/**
|
|
5
4
|
* List of linux capabilities to add.
|
|
@@ -279,7 +278,7 @@ export interface GetNetworkIpamConfig {
|
|
|
279
278
|
* Auxiliary IPv4 or IPv6 addresses used by Network driver
|
|
280
279
|
*/
|
|
281
280
|
auxAddress?: {
|
|
282
|
-
[key: string]:
|
|
281
|
+
[key: string]: string;
|
|
283
282
|
};
|
|
284
283
|
/**
|
|
285
284
|
* The IP address of the gateway
|
|
@@ -299,7 +298,7 @@ export interface NetworkIpamConfig {
|
|
|
299
298
|
* Auxiliary IPv4 or IPv6 addresses used by Network driver
|
|
300
299
|
*/
|
|
301
300
|
auxAddress?: {
|
|
302
|
-
[key: string]:
|
|
301
|
+
[key: string]: string;
|
|
303
302
|
};
|
|
304
303
|
/**
|
|
305
304
|
* The IP address of the gateway
|
|
@@ -767,7 +766,7 @@ export interface ServiceTaskSpecContainerSpec {
|
|
|
767
766
|
* Sysctls config (Linux only)
|
|
768
767
|
*/
|
|
769
768
|
sysctl?: {
|
|
770
|
-
[key: string]:
|
|
769
|
+
[key: string]: string;
|
|
771
770
|
};
|
|
772
771
|
/**
|
|
773
772
|
* The user inside the container
|
|
@@ -1152,774 +1151,10 @@ export interface VolumeLabel {
|
|
|
1152
1151
|
*/
|
|
1153
1152
|
value: string;
|
|
1154
1153
|
}
|
|
1155
|
-
export declare namespace buildx {
|
|
1156
|
-
interface BuildContext {
|
|
1157
|
-
/**
|
|
1158
|
-
* Resources to use for build context.
|
|
1159
|
-
*
|
|
1160
|
-
* The location can be:
|
|
1161
|
-
* * A relative or absolute path to a local directory (`.`, `./app`,
|
|
1162
|
-
* `/app`, etc.).
|
|
1163
|
-
* * A remote URL of a Git repository, tarball, or plain text file
|
|
1164
|
-
* (`https://github.com/user/myrepo.git`, `http://server/context.tar.gz`,
|
|
1165
|
-
* etc.).
|
|
1166
|
-
*/
|
|
1167
|
-
location: string;
|
|
1168
|
-
/**
|
|
1169
|
-
* Additional build contexts to use.
|
|
1170
|
-
*
|
|
1171
|
-
* These contexts are accessed with `FROM name` or `--from=name`
|
|
1172
|
-
* statements when using Dockerfile 1.4+ syntax.
|
|
1173
|
-
*
|
|
1174
|
-
* Values can be local paths, HTTP URLs, or `docker-image://` images.
|
|
1175
|
-
*/
|
|
1176
|
-
named?: {
|
|
1177
|
-
[key: string]: outputs.buildx.Context;
|
|
1178
|
-
};
|
|
1179
|
-
}
|
|
1180
|
-
interface BuilderConfig {
|
|
1181
|
-
/**
|
|
1182
|
-
* Name of an existing buildx builder to use.
|
|
1183
|
-
*
|
|
1184
|
-
* Only `docker-container`, `kubernetes`, or `remote` drivers are
|
|
1185
|
-
* supported. The legacy `docker` driver is not supported.
|
|
1186
|
-
*
|
|
1187
|
-
* Equivalent to Docker's `--builder` flag.
|
|
1188
|
-
*/
|
|
1189
|
-
name?: string;
|
|
1190
|
-
}
|
|
1191
|
-
interface CacheFrom {
|
|
1192
|
-
/**
|
|
1193
|
-
* Upload build caches to Azure's blob storage service.
|
|
1194
|
-
*/
|
|
1195
|
-
azblob?: outputs.buildx.CacheFromAzureBlob;
|
|
1196
|
-
/**
|
|
1197
|
-
* When `true` this entry will be excluded. Defaults to `false`.
|
|
1198
|
-
*/
|
|
1199
|
-
disabled?: boolean;
|
|
1200
|
-
/**
|
|
1201
|
-
* Recommended for use with GitHub Actions workflows.
|
|
1202
|
-
*
|
|
1203
|
-
* An action like `crazy-max/ghaction-github-runtime` is recommended to
|
|
1204
|
-
* expose appropriate credentials to your GitHub workflow.
|
|
1205
|
-
*/
|
|
1206
|
-
gha?: outputs.buildx.CacheFromGitHubActions;
|
|
1207
|
-
/**
|
|
1208
|
-
* A simple backend which caches images on your local filesystem.
|
|
1209
|
-
*/
|
|
1210
|
-
local?: outputs.buildx.CacheFromLocal;
|
|
1211
|
-
/**
|
|
1212
|
-
* A raw string as you would provide it to the Docker CLI (e.g.,
|
|
1213
|
-
* `type=inline`).
|
|
1214
|
-
*/
|
|
1215
|
-
raw?: string;
|
|
1216
|
-
/**
|
|
1217
|
-
* Upload build caches to remote registries.
|
|
1218
|
-
*/
|
|
1219
|
-
registry?: outputs.buildx.CacheFromRegistry;
|
|
1220
|
-
/**
|
|
1221
|
-
* Upload build caches to AWS S3 or an S3-compatible services such as
|
|
1222
|
-
* MinIO.
|
|
1223
|
-
*/
|
|
1224
|
-
s3?: outputs.buildx.CacheFromS3;
|
|
1225
|
-
}
|
|
1226
|
-
/**
|
|
1227
|
-
* cacheFromProvideDefaults sets the appropriate defaults for CacheFrom
|
|
1228
|
-
*/
|
|
1229
|
-
function cacheFromProvideDefaults(val: CacheFrom): CacheFrom;
|
|
1230
|
-
interface CacheFromAzureBlob {
|
|
1231
|
-
/**
|
|
1232
|
-
* Base URL of the storage account.
|
|
1233
|
-
*/
|
|
1234
|
-
accountUrl?: string;
|
|
1235
|
-
/**
|
|
1236
|
-
* The name of the cache image.
|
|
1237
|
-
*/
|
|
1238
|
-
name: string;
|
|
1239
|
-
/**
|
|
1240
|
-
* Blob storage account key.
|
|
1241
|
-
*/
|
|
1242
|
-
secretAccessKey?: string;
|
|
1243
|
-
}
|
|
1244
|
-
interface CacheFromGitHubActions {
|
|
1245
|
-
/**
|
|
1246
|
-
* The scope to use for cache keys. Defaults to `buildkit`.
|
|
1247
|
-
*
|
|
1248
|
-
* This should be set if building and caching multiple images in one
|
|
1249
|
-
* workflow, otherwise caches will overwrite each other.
|
|
1250
|
-
*/
|
|
1251
|
-
scope?: string;
|
|
1252
|
-
/**
|
|
1253
|
-
* The GitHub Actions token to use. This is not a personal access tokens
|
|
1254
|
-
* and is typically generated automatically as part of each job.
|
|
1255
|
-
*
|
|
1256
|
-
* Defaults to `$ACTIONS_RUNTIME_TOKEN`, although a separate action like
|
|
1257
|
-
* `crazy-max/ghaction-github-runtime` is recommended to expose this
|
|
1258
|
-
* environment variable to your jobs.
|
|
1259
|
-
*/
|
|
1260
|
-
token?: string;
|
|
1261
|
-
/**
|
|
1262
|
-
* The cache server URL to use for artifacts.
|
|
1263
|
-
*
|
|
1264
|
-
* Defaults to `$ACTIONS_RUNTIME_URL`, although a separate action like
|
|
1265
|
-
* `crazy-max/ghaction-github-runtime` is recommended to expose this
|
|
1266
|
-
* environment variable to your jobs.
|
|
1267
|
-
*/
|
|
1268
|
-
url?: string;
|
|
1269
|
-
}
|
|
1270
|
-
/**
|
|
1271
|
-
* cacheFromGitHubActionsProvideDefaults sets the appropriate defaults for CacheFromGitHubActions
|
|
1272
|
-
*/
|
|
1273
|
-
function cacheFromGitHubActionsProvideDefaults(val: CacheFromGitHubActions): CacheFromGitHubActions;
|
|
1274
|
-
interface CacheFromLocal {
|
|
1275
|
-
/**
|
|
1276
|
-
* Digest of manifest to import.
|
|
1277
|
-
*/
|
|
1278
|
-
digest?: string;
|
|
1279
|
-
/**
|
|
1280
|
-
* Path of the local directory where cache gets imported from.
|
|
1281
|
-
*/
|
|
1282
|
-
src: string;
|
|
1283
|
-
}
|
|
1284
|
-
interface CacheFromRegistry {
|
|
1285
|
-
/**
|
|
1286
|
-
* Fully qualified name of the cache image to import.
|
|
1287
|
-
*/
|
|
1288
|
-
ref: string;
|
|
1289
|
-
}
|
|
1290
|
-
interface CacheFromS3 {
|
|
1291
|
-
/**
|
|
1292
|
-
* Defaults to `$AWS_ACCESS_KEY_ID`.
|
|
1293
|
-
*/
|
|
1294
|
-
accessKeyId?: string;
|
|
1295
|
-
/**
|
|
1296
|
-
* Prefix to prepend to blob filenames.
|
|
1297
|
-
*/
|
|
1298
|
-
blobsPrefix?: string;
|
|
1299
|
-
/**
|
|
1300
|
-
* Name of the S3 bucket.
|
|
1301
|
-
*/
|
|
1302
|
-
bucket: string;
|
|
1303
|
-
/**
|
|
1304
|
-
* Endpoint of the S3 bucket.
|
|
1305
|
-
*/
|
|
1306
|
-
endpointUrl?: string;
|
|
1307
|
-
/**
|
|
1308
|
-
* Prefix to prepend on manifest filenames.
|
|
1309
|
-
*/
|
|
1310
|
-
manifestsPrefix?: string;
|
|
1311
|
-
/**
|
|
1312
|
-
* Name of the cache image.
|
|
1313
|
-
*/
|
|
1314
|
-
name?: string;
|
|
1315
|
-
/**
|
|
1316
|
-
* The geographic location of the bucket. Defaults to `$AWS_REGION`.
|
|
1317
|
-
*/
|
|
1318
|
-
region: string;
|
|
1319
|
-
/**
|
|
1320
|
-
* Defaults to `$AWS_SECRET_ACCESS_KEY`.
|
|
1321
|
-
*/
|
|
1322
|
-
secretAccessKey?: string;
|
|
1323
|
-
/**
|
|
1324
|
-
* Defaults to `$AWS_SESSION_TOKEN`.
|
|
1325
|
-
*/
|
|
1326
|
-
sessionToken?: string;
|
|
1327
|
-
/**
|
|
1328
|
-
* Uses `bucket` in the URL instead of hostname when `true`.
|
|
1329
|
-
*/
|
|
1330
|
-
usePathStyle?: boolean;
|
|
1331
|
-
}
|
|
1332
|
-
/**
|
|
1333
|
-
* cacheFromS3ProvideDefaults sets the appropriate defaults for CacheFromS3
|
|
1334
|
-
*/
|
|
1335
|
-
function cacheFromS3ProvideDefaults(val: CacheFromS3): CacheFromS3;
|
|
1336
|
-
interface CacheTo {
|
|
1337
|
-
/**
|
|
1338
|
-
* Push cache to Azure's blob storage service.
|
|
1339
|
-
*/
|
|
1340
|
-
azblob?: outputs.buildx.CacheToAzureBlob;
|
|
1341
|
-
/**
|
|
1342
|
-
* When `true` this entry will be excluded. Defaults to `false`.
|
|
1343
|
-
*/
|
|
1344
|
-
disabled?: boolean;
|
|
1345
|
-
/**
|
|
1346
|
-
* Recommended for use with GitHub Actions workflows.
|
|
1347
|
-
*
|
|
1348
|
-
* An action like `crazy-max/ghaction-github-runtime` is recommended to
|
|
1349
|
-
* expose appropriate credentials to your GitHub workflow.
|
|
1350
|
-
*/
|
|
1351
|
-
gha?: outputs.buildx.CacheToGitHubActions;
|
|
1352
|
-
/**
|
|
1353
|
-
* The inline cache storage backend is the simplest implementation to get
|
|
1354
|
-
* started with, but it does not handle multi-stage builds. Consider the
|
|
1355
|
-
* `registry` cache backend instead.
|
|
1356
|
-
*/
|
|
1357
|
-
inline?: outputs.buildx.CacheToInline;
|
|
1358
|
-
/**
|
|
1359
|
-
* A simple backend which caches imagines on your local filesystem.
|
|
1360
|
-
*/
|
|
1361
|
-
local?: outputs.buildx.CacheToLocal;
|
|
1362
|
-
/**
|
|
1363
|
-
* A raw string as you would provide it to the Docker CLI (e.g.,
|
|
1364
|
-
* `type=inline`)
|
|
1365
|
-
*/
|
|
1366
|
-
raw?: string;
|
|
1367
|
-
/**
|
|
1368
|
-
* Push caches to remote registries. Incompatible with the `docker` build
|
|
1369
|
-
* driver.
|
|
1370
|
-
*/
|
|
1371
|
-
registry?: outputs.buildx.CacheToRegistry;
|
|
1372
|
-
/**
|
|
1373
|
-
* Push cache to AWS S3 or S3-compatible services such as MinIO.
|
|
1374
|
-
*/
|
|
1375
|
-
s3?: outputs.buildx.CacheToS3;
|
|
1376
|
-
}
|
|
1377
|
-
/**
|
|
1378
|
-
* cacheToProvideDefaults sets the appropriate defaults for CacheTo
|
|
1379
|
-
*/
|
|
1380
|
-
function cacheToProvideDefaults(val: CacheTo): CacheTo;
|
|
1381
|
-
interface CacheToAzureBlob {
|
|
1382
|
-
/**
|
|
1383
|
-
* Base URL of the storage account.
|
|
1384
|
-
*/
|
|
1385
|
-
accountUrl?: string;
|
|
1386
|
-
/**
|
|
1387
|
-
* Ignore errors caused by failed cache exports.
|
|
1388
|
-
*/
|
|
1389
|
-
ignoreError?: boolean;
|
|
1390
|
-
/**
|
|
1391
|
-
* The cache mode to use. Defaults to `min`.
|
|
1392
|
-
*/
|
|
1393
|
-
mode?: enums.buildx.CacheMode;
|
|
1394
|
-
/**
|
|
1395
|
-
* The name of the cache image.
|
|
1396
|
-
*/
|
|
1397
|
-
name: string;
|
|
1398
|
-
/**
|
|
1399
|
-
* Blob storage account key.
|
|
1400
|
-
*/
|
|
1401
|
-
secretAccessKey?: string;
|
|
1402
|
-
}
|
|
1403
|
-
/**
|
|
1404
|
-
* cacheToAzureBlobProvideDefaults sets the appropriate defaults for CacheToAzureBlob
|
|
1405
|
-
*/
|
|
1406
|
-
function cacheToAzureBlobProvideDefaults(val: CacheToAzureBlob): CacheToAzureBlob;
|
|
1407
|
-
interface CacheToGitHubActions {
|
|
1408
|
-
/**
|
|
1409
|
-
* Ignore errors caused by failed cache exports.
|
|
1410
|
-
*/
|
|
1411
|
-
ignoreError?: boolean;
|
|
1412
|
-
/**
|
|
1413
|
-
* The cache mode to use. Defaults to `min`.
|
|
1414
|
-
*/
|
|
1415
|
-
mode?: enums.buildx.CacheMode;
|
|
1416
|
-
/**
|
|
1417
|
-
* The scope to use for cache keys. Defaults to `buildkit`.
|
|
1418
|
-
*
|
|
1419
|
-
* This should be set if building and caching multiple images in one
|
|
1420
|
-
* workflow, otherwise caches will overwrite each other.
|
|
1421
|
-
*/
|
|
1422
|
-
scope?: string;
|
|
1423
|
-
/**
|
|
1424
|
-
* The GitHub Actions token to use. This is not a personal access tokens
|
|
1425
|
-
* and is typically generated automatically as part of each job.
|
|
1426
|
-
*
|
|
1427
|
-
* Defaults to `$ACTIONS_RUNTIME_TOKEN`, although a separate action like
|
|
1428
|
-
* `crazy-max/ghaction-github-runtime` is recommended to expose this
|
|
1429
|
-
* environment variable to your jobs.
|
|
1430
|
-
*/
|
|
1431
|
-
token?: string;
|
|
1432
|
-
/**
|
|
1433
|
-
* The cache server URL to use for artifacts.
|
|
1434
|
-
*
|
|
1435
|
-
* Defaults to `$ACTIONS_RUNTIME_URL`, although a separate action like
|
|
1436
|
-
* `crazy-max/ghaction-github-runtime` is recommended to expose this
|
|
1437
|
-
* environment variable to your jobs.
|
|
1438
|
-
*/
|
|
1439
|
-
url?: string;
|
|
1440
|
-
}
|
|
1441
|
-
/**
|
|
1442
|
-
* cacheToGitHubActionsProvideDefaults sets the appropriate defaults for CacheToGitHubActions
|
|
1443
|
-
*/
|
|
1444
|
-
function cacheToGitHubActionsProvideDefaults(val: CacheToGitHubActions): CacheToGitHubActions;
|
|
1445
|
-
/**
|
|
1446
|
-
* Include an inline cache with the exported image.
|
|
1447
|
-
*/
|
|
1448
|
-
interface CacheToInline {
|
|
1449
|
-
}
|
|
1450
|
-
interface CacheToLocal {
|
|
1451
|
-
/**
|
|
1452
|
-
* The compression type to use.
|
|
1453
|
-
*/
|
|
1454
|
-
compression?: enums.buildx.CompressionType;
|
|
1455
|
-
/**
|
|
1456
|
-
* Compression level from 0 to 22.
|
|
1457
|
-
*/
|
|
1458
|
-
compressionLevel?: number;
|
|
1459
|
-
/**
|
|
1460
|
-
* Path of the local directory to export the cache.
|
|
1461
|
-
*/
|
|
1462
|
-
dest: string;
|
|
1463
|
-
/**
|
|
1464
|
-
* Forcefully apply compression.
|
|
1465
|
-
*/
|
|
1466
|
-
forceCompression?: boolean;
|
|
1467
|
-
/**
|
|
1468
|
-
* Ignore errors caused by failed cache exports.
|
|
1469
|
-
*/
|
|
1470
|
-
ignoreError?: boolean;
|
|
1471
|
-
/**
|
|
1472
|
-
* The cache mode to use. Defaults to `min`.
|
|
1473
|
-
*/
|
|
1474
|
-
mode?: enums.buildx.CacheMode;
|
|
1475
|
-
}
|
|
1476
|
-
/**
|
|
1477
|
-
* cacheToLocalProvideDefaults sets the appropriate defaults for CacheToLocal
|
|
1478
|
-
*/
|
|
1479
|
-
function cacheToLocalProvideDefaults(val: CacheToLocal): CacheToLocal;
|
|
1480
|
-
interface CacheToRegistry {
|
|
1481
|
-
/**
|
|
1482
|
-
* The compression type to use.
|
|
1483
|
-
*/
|
|
1484
|
-
compression?: enums.buildx.CompressionType;
|
|
1485
|
-
/**
|
|
1486
|
-
* Compression level from 0 to 22.
|
|
1487
|
-
*/
|
|
1488
|
-
compressionLevel?: number;
|
|
1489
|
-
/**
|
|
1490
|
-
* Forcefully apply compression.
|
|
1491
|
-
*/
|
|
1492
|
-
forceCompression?: boolean;
|
|
1493
|
-
/**
|
|
1494
|
-
* Ignore errors caused by failed cache exports.
|
|
1495
|
-
*/
|
|
1496
|
-
ignoreError?: boolean;
|
|
1497
|
-
/**
|
|
1498
|
-
* Export cache manifest as an OCI-compatible image manifest instead of a
|
|
1499
|
-
* manifest list. Requires `ociMediaTypes` to also be `true`.
|
|
1500
|
-
*
|
|
1501
|
-
* Some registries like AWS ECR will not work with caching if this is
|
|
1502
|
-
* `false`.
|
|
1503
|
-
*
|
|
1504
|
-
* Defaults to `false` to match Docker's default behavior.
|
|
1505
|
-
*/
|
|
1506
|
-
imageManifest?: boolean;
|
|
1507
|
-
/**
|
|
1508
|
-
* The cache mode to use. Defaults to `min`.
|
|
1509
|
-
*/
|
|
1510
|
-
mode?: enums.buildx.CacheMode;
|
|
1511
|
-
/**
|
|
1512
|
-
* Whether to use OCI media types in exported manifests. Defaults to
|
|
1513
|
-
* `true`.
|
|
1514
|
-
*/
|
|
1515
|
-
ociMediaTypes?: boolean;
|
|
1516
|
-
/**
|
|
1517
|
-
* Fully qualified name of the cache image to import.
|
|
1518
|
-
*/
|
|
1519
|
-
ref: string;
|
|
1520
|
-
}
|
|
1521
|
-
/**
|
|
1522
|
-
* cacheToRegistryProvideDefaults sets the appropriate defaults for CacheToRegistry
|
|
1523
|
-
*/
|
|
1524
|
-
function cacheToRegistryProvideDefaults(val: CacheToRegistry): CacheToRegistry;
|
|
1525
|
-
interface CacheToS3 {
|
|
1526
|
-
/**
|
|
1527
|
-
* Defaults to `$AWS_ACCESS_KEY_ID`.
|
|
1528
|
-
*/
|
|
1529
|
-
accessKeyId?: string;
|
|
1530
|
-
/**
|
|
1531
|
-
* Prefix to prepend to blob filenames.
|
|
1532
|
-
*/
|
|
1533
|
-
blobsPrefix?: string;
|
|
1534
|
-
/**
|
|
1535
|
-
* Name of the S3 bucket.
|
|
1536
|
-
*/
|
|
1537
|
-
bucket: string;
|
|
1538
|
-
/**
|
|
1539
|
-
* Endpoint of the S3 bucket.
|
|
1540
|
-
*/
|
|
1541
|
-
endpointUrl?: string;
|
|
1542
|
-
/**
|
|
1543
|
-
* Ignore errors caused by failed cache exports.
|
|
1544
|
-
*/
|
|
1545
|
-
ignoreError?: boolean;
|
|
1546
|
-
/**
|
|
1547
|
-
* Prefix to prepend on manifest filenames.
|
|
1548
|
-
*/
|
|
1549
|
-
manifestsPrefix?: string;
|
|
1550
|
-
/**
|
|
1551
|
-
* The cache mode to use. Defaults to `min`.
|
|
1552
|
-
*/
|
|
1553
|
-
mode?: enums.buildx.CacheMode;
|
|
1554
|
-
/**
|
|
1555
|
-
* Name of the cache image.
|
|
1556
|
-
*/
|
|
1557
|
-
name?: string;
|
|
1558
|
-
/**
|
|
1559
|
-
* The geographic location of the bucket. Defaults to `$AWS_REGION`.
|
|
1560
|
-
*/
|
|
1561
|
-
region: string;
|
|
1562
|
-
/**
|
|
1563
|
-
* Defaults to `$AWS_SECRET_ACCESS_KEY`.
|
|
1564
|
-
*/
|
|
1565
|
-
secretAccessKey?: string;
|
|
1566
|
-
/**
|
|
1567
|
-
* Defaults to `$AWS_SESSION_TOKEN`.
|
|
1568
|
-
*/
|
|
1569
|
-
sessionToken?: string;
|
|
1570
|
-
/**
|
|
1571
|
-
* Uses `bucket` in the URL instead of hostname when `true`.
|
|
1572
|
-
*/
|
|
1573
|
-
usePathStyle?: boolean;
|
|
1574
|
-
}
|
|
1575
|
-
/**
|
|
1576
|
-
* cacheToS3ProvideDefaults sets the appropriate defaults for CacheToS3
|
|
1577
|
-
*/
|
|
1578
|
-
function cacheToS3ProvideDefaults(val: CacheToS3): CacheToS3;
|
|
1579
|
-
interface Context {
|
|
1580
|
-
/**
|
|
1581
|
-
* Resources to use for build context.
|
|
1582
|
-
*
|
|
1583
|
-
* The location can be:
|
|
1584
|
-
* * A relative or absolute path to a local directory (`.`, `./app`,
|
|
1585
|
-
* `/app`, etc.).
|
|
1586
|
-
* * A remote URL of a Git repository, tarball, or plain text file
|
|
1587
|
-
* (`https://github.com/user/myrepo.git`, `http://server/context.tar.gz`,
|
|
1588
|
-
* etc.).
|
|
1589
|
-
*/
|
|
1590
|
-
location: string;
|
|
1591
|
-
}
|
|
1592
|
-
interface Dockerfile {
|
|
1593
|
-
/**
|
|
1594
|
-
* Raw Dockerfile contents.
|
|
1595
|
-
*
|
|
1596
|
-
* Conflicts with `location`.
|
|
1597
|
-
*
|
|
1598
|
-
* Equivalent to invoking Docker with `-f -`.
|
|
1599
|
-
*/
|
|
1600
|
-
inline?: string;
|
|
1601
|
-
/**
|
|
1602
|
-
* Location of the Dockerfile to use.
|
|
1603
|
-
*
|
|
1604
|
-
* Can be a relative or absolute path to a local file, or a remote URL.
|
|
1605
|
-
*
|
|
1606
|
-
* Defaults to `${context.location}/Dockerfile` if context is on-disk.
|
|
1607
|
-
*
|
|
1608
|
-
* Conflicts with `inline`.
|
|
1609
|
-
*/
|
|
1610
|
-
location?: string;
|
|
1611
|
-
}
|
|
1612
|
-
interface Export {
|
|
1613
|
-
/**
|
|
1614
|
-
* A no-op export. Helpful for silencing the 'no exports' warning if you
|
|
1615
|
-
* just want to populate caches.
|
|
1616
|
-
*/
|
|
1617
|
-
cacheonly?: outputs.buildx.ExportCacheOnly;
|
|
1618
|
-
/**
|
|
1619
|
-
* When `true` this entry will be excluded. Defaults to `false`.
|
|
1620
|
-
*/
|
|
1621
|
-
disabled?: boolean;
|
|
1622
|
-
/**
|
|
1623
|
-
* Export as a Docker image layout.
|
|
1624
|
-
*/
|
|
1625
|
-
docker?: outputs.buildx.ExportDocker;
|
|
1626
|
-
/**
|
|
1627
|
-
* Outputs the build result into a container image format.
|
|
1628
|
-
*/
|
|
1629
|
-
image?: outputs.buildx.ExportImage;
|
|
1630
|
-
/**
|
|
1631
|
-
* Export to a local directory as files and directories.
|
|
1632
|
-
*/
|
|
1633
|
-
local?: outputs.buildx.ExportLocal;
|
|
1634
|
-
/**
|
|
1635
|
-
* Identical to the Docker exporter but uses OCI media types by default.
|
|
1636
|
-
*/
|
|
1637
|
-
oci?: outputs.buildx.ExportOCI;
|
|
1638
|
-
/**
|
|
1639
|
-
* A raw string as you would provide it to the Docker CLI (e.g.,
|
|
1640
|
-
* `type=docker`)
|
|
1641
|
-
*/
|
|
1642
|
-
raw?: string;
|
|
1643
|
-
/**
|
|
1644
|
-
* Identical to the Image exporter, but pushes by default.
|
|
1645
|
-
*/
|
|
1646
|
-
registry?: outputs.buildx.ExportRegistry;
|
|
1647
|
-
/**
|
|
1648
|
-
* Export to a local directory as a tarball.
|
|
1649
|
-
*/
|
|
1650
|
-
tar?: outputs.buildx.ExportTar;
|
|
1651
|
-
}
|
|
1652
|
-
/**
|
|
1653
|
-
* exportProvideDefaults sets the appropriate defaults for Export
|
|
1654
|
-
*/
|
|
1655
|
-
function exportProvideDefaults(val: Export): Export;
|
|
1656
|
-
interface ExportCacheOnly {
|
|
1657
|
-
}
|
|
1658
|
-
interface ExportDocker {
|
|
1659
|
-
/**
|
|
1660
|
-
* Attach an arbitrary key/value annotation to the image.
|
|
1661
|
-
*/
|
|
1662
|
-
annotations?: {
|
|
1663
|
-
[key: string]: string;
|
|
1664
|
-
};
|
|
1665
|
-
/**
|
|
1666
|
-
* The compression type to use.
|
|
1667
|
-
*/
|
|
1668
|
-
compression?: enums.buildx.CompressionType;
|
|
1669
|
-
/**
|
|
1670
|
-
* Compression level from 0 to 22.
|
|
1671
|
-
*/
|
|
1672
|
-
compressionLevel?: number;
|
|
1673
|
-
/**
|
|
1674
|
-
* The local export path.
|
|
1675
|
-
*/
|
|
1676
|
-
dest?: string;
|
|
1677
|
-
/**
|
|
1678
|
-
* Forcefully apply compression.
|
|
1679
|
-
*/
|
|
1680
|
-
forceCompression?: boolean;
|
|
1681
|
-
/**
|
|
1682
|
-
* Specify images names to export. This is overridden if tags are already specified.
|
|
1683
|
-
*/
|
|
1684
|
-
names?: string[];
|
|
1685
|
-
/**
|
|
1686
|
-
* Use OCI media types in exporter manifests.
|
|
1687
|
-
*/
|
|
1688
|
-
ociMediaTypes?: boolean;
|
|
1689
|
-
/**
|
|
1690
|
-
* Bundle the output into a tarball layout.
|
|
1691
|
-
*/
|
|
1692
|
-
tar?: boolean;
|
|
1693
|
-
}
|
|
1694
|
-
/**
|
|
1695
|
-
* exportDockerProvideDefaults sets the appropriate defaults for ExportDocker
|
|
1696
|
-
*/
|
|
1697
|
-
function exportDockerProvideDefaults(val: ExportDocker): ExportDocker;
|
|
1698
|
-
interface ExportImage {
|
|
1699
|
-
/**
|
|
1700
|
-
* Attach an arbitrary key/value annotation to the image.
|
|
1701
|
-
*/
|
|
1702
|
-
annotations?: {
|
|
1703
|
-
[key: string]: string;
|
|
1704
|
-
};
|
|
1705
|
-
/**
|
|
1706
|
-
* The compression type to use.
|
|
1707
|
-
*/
|
|
1708
|
-
compression?: enums.buildx.CompressionType;
|
|
1709
|
-
/**
|
|
1710
|
-
* Compression level from 0 to 22.
|
|
1711
|
-
*/
|
|
1712
|
-
compressionLevel?: number;
|
|
1713
|
-
/**
|
|
1714
|
-
* Name image with `prefix@<digest>`, used for anonymous images.
|
|
1715
|
-
*/
|
|
1716
|
-
danglingNamePrefix?: string;
|
|
1717
|
-
/**
|
|
1718
|
-
* Forcefully apply compression.
|
|
1719
|
-
*/
|
|
1720
|
-
forceCompression?: boolean;
|
|
1721
|
-
/**
|
|
1722
|
-
* Allow pushing to an insecure registry.
|
|
1723
|
-
*/
|
|
1724
|
-
insecure?: boolean;
|
|
1725
|
-
/**
|
|
1726
|
-
* Add additional canonical name (`name@<digest>`).
|
|
1727
|
-
*/
|
|
1728
|
-
nameCanonical?: boolean;
|
|
1729
|
-
/**
|
|
1730
|
-
* Specify images names to export. This is overridden if tags are already specified.
|
|
1731
|
-
*/
|
|
1732
|
-
names?: string[];
|
|
1733
|
-
/**
|
|
1734
|
-
* Use OCI media types in exporter manifests.
|
|
1735
|
-
*/
|
|
1736
|
-
ociMediaTypes?: boolean;
|
|
1737
|
-
/**
|
|
1738
|
-
* Push after creating the image.
|
|
1739
|
-
*/
|
|
1740
|
-
push?: boolean;
|
|
1741
|
-
/**
|
|
1742
|
-
* Push image without name.
|
|
1743
|
-
*/
|
|
1744
|
-
pushByDigest?: boolean;
|
|
1745
|
-
/**
|
|
1746
|
-
* Store resulting images to the worker's image store and ensure all of
|
|
1747
|
-
* its blobs are in the content store.
|
|
1748
|
-
*
|
|
1749
|
-
* Defaults to `true`.
|
|
1750
|
-
*
|
|
1751
|
-
* Ignored if the worker doesn't have image store (when using OCI workers,
|
|
1752
|
-
* for example).
|
|
1753
|
-
*/
|
|
1754
|
-
store?: boolean;
|
|
1755
|
-
/**
|
|
1756
|
-
* Unpack image after creation (for use with containerd). Defaults to
|
|
1757
|
-
* `false`.
|
|
1758
|
-
*/
|
|
1759
|
-
unpack?: boolean;
|
|
1760
|
-
}
|
|
1761
|
-
/**
|
|
1762
|
-
* exportImageProvideDefaults sets the appropriate defaults for ExportImage
|
|
1763
|
-
*/
|
|
1764
|
-
function exportImageProvideDefaults(val: ExportImage): ExportImage;
|
|
1765
|
-
interface ExportLocal {
|
|
1766
|
-
/**
|
|
1767
|
-
* Output path.
|
|
1768
|
-
*/
|
|
1769
|
-
dest: string;
|
|
1770
|
-
}
|
|
1771
|
-
interface ExportOCI {
|
|
1772
|
-
/**
|
|
1773
|
-
* Attach an arbitrary key/value annotation to the image.
|
|
1774
|
-
*/
|
|
1775
|
-
annotations?: {
|
|
1776
|
-
[key: string]: string;
|
|
1777
|
-
};
|
|
1778
|
-
/**
|
|
1779
|
-
* The compression type to use.
|
|
1780
|
-
*/
|
|
1781
|
-
compression?: enums.buildx.CompressionType;
|
|
1782
|
-
/**
|
|
1783
|
-
* Compression level from 0 to 22.
|
|
1784
|
-
*/
|
|
1785
|
-
compressionLevel?: number;
|
|
1786
|
-
/**
|
|
1787
|
-
* The local export path.
|
|
1788
|
-
*/
|
|
1789
|
-
dest?: string;
|
|
1790
|
-
/**
|
|
1791
|
-
* Forcefully apply compression.
|
|
1792
|
-
*/
|
|
1793
|
-
forceCompression?: boolean;
|
|
1794
|
-
/**
|
|
1795
|
-
* Specify images names to export. This is overridden if tags are already specified.
|
|
1796
|
-
*/
|
|
1797
|
-
names?: string[];
|
|
1798
|
-
/**
|
|
1799
|
-
* Use OCI media types in exporter manifests.
|
|
1800
|
-
*/
|
|
1801
|
-
ociMediaTypes?: boolean;
|
|
1802
|
-
/**
|
|
1803
|
-
* Bundle the output into a tarball layout.
|
|
1804
|
-
*/
|
|
1805
|
-
tar?: boolean;
|
|
1806
|
-
}
|
|
1807
|
-
/**
|
|
1808
|
-
* exportOCIProvideDefaults sets the appropriate defaults for ExportOCI
|
|
1809
|
-
*/
|
|
1810
|
-
function exportOCIProvideDefaults(val: ExportOCI): ExportOCI;
|
|
1811
|
-
interface ExportRegistry {
|
|
1812
|
-
/**
|
|
1813
|
-
* Attach an arbitrary key/value annotation to the image.
|
|
1814
|
-
*/
|
|
1815
|
-
annotations?: {
|
|
1816
|
-
[key: string]: string;
|
|
1817
|
-
};
|
|
1818
|
-
/**
|
|
1819
|
-
* The compression type to use.
|
|
1820
|
-
*/
|
|
1821
|
-
compression?: enums.buildx.CompressionType;
|
|
1822
|
-
/**
|
|
1823
|
-
* Compression level from 0 to 22.
|
|
1824
|
-
*/
|
|
1825
|
-
compressionLevel?: number;
|
|
1826
|
-
/**
|
|
1827
|
-
* Name image with `prefix@<digest>`, used for anonymous images.
|
|
1828
|
-
*/
|
|
1829
|
-
danglingNamePrefix?: string;
|
|
1830
|
-
/**
|
|
1831
|
-
* Forcefully apply compression.
|
|
1832
|
-
*/
|
|
1833
|
-
forceCompression?: boolean;
|
|
1834
|
-
/**
|
|
1835
|
-
* Allow pushing to an insecure registry.
|
|
1836
|
-
*/
|
|
1837
|
-
insecure?: boolean;
|
|
1838
|
-
/**
|
|
1839
|
-
* Add additional canonical name (`name@<digest>`).
|
|
1840
|
-
*/
|
|
1841
|
-
nameCanonical?: boolean;
|
|
1842
|
-
/**
|
|
1843
|
-
* Specify images names to export. This is overridden if tags are already specified.
|
|
1844
|
-
*/
|
|
1845
|
-
names?: string[];
|
|
1846
|
-
/**
|
|
1847
|
-
* Use OCI media types in exporter manifests.
|
|
1848
|
-
*/
|
|
1849
|
-
ociMediaTypes?: boolean;
|
|
1850
|
-
/**
|
|
1851
|
-
* Push after creating the image.
|
|
1852
|
-
*/
|
|
1853
|
-
push?: boolean;
|
|
1854
|
-
/**
|
|
1855
|
-
* Push image without name.
|
|
1856
|
-
*/
|
|
1857
|
-
pushByDigest?: boolean;
|
|
1858
|
-
/**
|
|
1859
|
-
* Store resulting images to the worker's image store and ensure all of
|
|
1860
|
-
* its blobs are in the content store.
|
|
1861
|
-
*
|
|
1862
|
-
* Defaults to `true`.
|
|
1863
|
-
*
|
|
1864
|
-
* Ignored if the worker doesn't have image store (when using OCI workers,
|
|
1865
|
-
* for example).
|
|
1866
|
-
*/
|
|
1867
|
-
store?: boolean;
|
|
1868
|
-
/**
|
|
1869
|
-
* Unpack image after creation (for use with containerd). Defaults to
|
|
1870
|
-
* `false`.
|
|
1871
|
-
*/
|
|
1872
|
-
unpack?: boolean;
|
|
1873
|
-
}
|
|
1874
|
-
/**
|
|
1875
|
-
* exportRegistryProvideDefaults sets the appropriate defaults for ExportRegistry
|
|
1876
|
-
*/
|
|
1877
|
-
function exportRegistryProvideDefaults(val: ExportRegistry): ExportRegistry;
|
|
1878
|
-
interface ExportTar {
|
|
1879
|
-
/**
|
|
1880
|
-
* Output path.
|
|
1881
|
-
*/
|
|
1882
|
-
dest: string;
|
|
1883
|
-
}
|
|
1884
|
-
interface RegistryAuth {
|
|
1885
|
-
/**
|
|
1886
|
-
* The registry's address (e.g. "docker.io").
|
|
1887
|
-
*/
|
|
1888
|
-
address: string;
|
|
1889
|
-
/**
|
|
1890
|
-
* Password or token for the registry.
|
|
1891
|
-
*/
|
|
1892
|
-
password?: string;
|
|
1893
|
-
/**
|
|
1894
|
-
* Username for the registry.
|
|
1895
|
-
*/
|
|
1896
|
-
username?: string;
|
|
1897
|
-
}
|
|
1898
|
-
interface SSH {
|
|
1899
|
-
/**
|
|
1900
|
-
* Useful for distinguishing different servers that are part of the same
|
|
1901
|
-
* build.
|
|
1902
|
-
*
|
|
1903
|
-
* A value of `default` is appropriate if only dealing with a single host.
|
|
1904
|
-
*/
|
|
1905
|
-
id: string;
|
|
1906
|
-
/**
|
|
1907
|
-
* SSH agent socket or private keys to expose to the build under the given
|
|
1908
|
-
* identifier.
|
|
1909
|
-
*
|
|
1910
|
-
* Defaults to `[$SSH_AUTH_SOCK]`.
|
|
1911
|
-
*
|
|
1912
|
-
* Note that your keys are **not** automatically added when using an
|
|
1913
|
-
* agent. Run `ssh-add -l` locally to confirm which public keys are
|
|
1914
|
-
* visible to the agent; these will be exposed to your build.
|
|
1915
|
-
*/
|
|
1916
|
-
paths?: string[];
|
|
1917
|
-
}
|
|
1918
|
-
}
|
|
1919
1154
|
export declare namespace config {
|
|
1920
1155
|
interface RegistryAuth {
|
|
1921
1156
|
/**
|
|
1922
|
-
* Address of the registry
|
|
1157
|
+
* Address of the registry
|
|
1923
1158
|
*/
|
|
1924
1159
|
address: string;
|
|
1925
1160
|
authDisabled?: boolean;
|