@lakutata/docker 3.0.0-beta.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/LICENSE +23 -0
- package/README.md +309 -0
- package/THIRD_PARTY_NOTICES.md +299 -0
- package/dist/cjs/client/BuildContext.d.ts +22 -0
- package/dist/cjs/client/BuildContext.js +76 -0
- package/dist/cjs/client/BuildKitProgress.d.ts +81 -0
- package/dist/cjs/client/BuildKitProgress.js +195 -0
- package/dist/cjs/client/DockerClient.d.ts +196 -0
- package/dist/cjs/client/DockerClient.js +312 -0
- package/dist/cjs/client/DockerConnection.d.ts +154 -0
- package/dist/cjs/client/DockerConnection.js +397 -0
- package/dist/cjs/client/DockerIgnore.d.ts +44 -0
- package/dist/cjs/client/DockerIgnore.js +186 -0
- package/dist/cjs/client/DockerRequestError.d.ts +17 -0
- package/dist/cjs/client/DockerRequestError.js +24 -0
- package/dist/cjs/client/DockerStreams.d.ts +35 -0
- package/dist/cjs/client/DockerStreams.js +117 -0
- package/dist/cjs/client/types/ContainerCreateResponse.d.ts +7 -0
- package/dist/cjs/client/types/ContainerCreateResponse.js +2 -0
- package/dist/cjs/client/types/ContainerStopQuery.d.ts +13 -0
- package/dist/cjs/client/types/ContainerStopQuery.js +2 -0
- package/dist/cjs/client/types/DeviceMapping.d.ts +8 -0
- package/dist/cjs/client/types/DeviceMapping.js +2 -0
- package/dist/cjs/client/types/IdResponse.d.ts +6 -0
- package/dist/cjs/client/types/IdResponse.js +2 -0
- package/dist/cjs/client/types/NetworkCreateResponse.d.ts +7 -0
- package/dist/cjs/client/types/NetworkCreateResponse.js +2 -0
- package/dist/cjs/client/types/PortBinding.d.ts +10 -0
- package/dist/cjs/client/types/PortBinding.js +2 -0
- package/dist/cjs/docker/ConnectionOptionsBuilder.d.ts +128 -0
- package/dist/cjs/docker/ConnectionOptionsBuilder.js +150 -0
- package/dist/cjs/docker/Docker.d.ts +301 -0
- package/dist/cjs/docker/Docker.js +703 -0
- package/dist/cjs/docker/exceptions/DockerConnectionException.d.ts +9 -0
- package/dist/cjs/docker/exceptions/DockerConnectionException.js +16 -0
- package/dist/cjs/docker/exceptions/DockerContainerNotFoundException.d.ts +9 -0
- package/dist/cjs/docker/exceptions/DockerContainerNotFoundException.js +16 -0
- package/dist/cjs/docker/exceptions/DockerImageBuildException.d.ts +9 -0
- package/dist/cjs/docker/exceptions/DockerImageBuildException.js +16 -0
- package/dist/cjs/docker/exceptions/DockerImageImportException.d.ts +9 -0
- package/dist/cjs/docker/exceptions/DockerImageImportException.js +16 -0
- package/dist/cjs/docker/exceptions/DockerImageNotFoundException.d.ts +10 -0
- package/dist/cjs/docker/exceptions/DockerImageNotFoundException.js +17 -0
- package/dist/cjs/docker/exceptions/DockerImagePullException.d.ts +9 -0
- package/dist/cjs/docker/exceptions/DockerImagePullException.js +16 -0
- package/dist/cjs/docker/exceptions/DockerImagePushException.d.ts +8 -0
- package/dist/cjs/docker/exceptions/DockerImagePushException.js +15 -0
- package/dist/cjs/docker/exceptions/DockerImageRepoTagNotFoundException.d.ts +8 -0
- package/dist/cjs/docker/exceptions/DockerImageRepoTagNotFoundException.js +15 -0
- package/dist/cjs/docker/exceptions/DockerNetworkNotFoundException.d.ts +9 -0
- package/dist/cjs/docker/exceptions/DockerNetworkNotFoundException.js +16 -0
- package/dist/cjs/docker/exceptions/DockerRequestException.d.ts +22 -0
- package/dist/cjs/docker/exceptions/DockerRequestException.js +24 -0
- package/dist/cjs/docker/interfaces/IDockerConnectionOptions.d.ts +75 -0
- package/dist/cjs/docker/interfaces/IDockerConnectionOptions.js +2 -0
- package/dist/cjs/docker/interfaces/IDockerHttpConnectionOptions.d.ts +16 -0
- package/dist/cjs/docker/interfaces/IDockerHttpConnectionOptions.js +2 -0
- package/dist/cjs/docker/interfaces/IDockerHttpsConnectionOptions.d.ts +16 -0
- package/dist/cjs/docker/interfaces/IDockerHttpsConnectionOptions.js +2 -0
- package/dist/cjs/docker/interfaces/IDockerKeyObject.d.ts +14 -0
- package/dist/cjs/docker/interfaces/IDockerKeyObject.js +2 -0
- package/dist/cjs/docker/interfaces/IDockerSSHConnectionOptions.d.ts +16 -0
- package/dist/cjs/docker/interfaces/IDockerSSHConnectionOptions.js +2 -0
- package/dist/cjs/docker/interfaces/IDockerSocketConnectionOptions.d.ts +7 -0
- package/dist/cjs/docker/interfaces/IDockerSocketConnectionOptions.js +2 -0
- package/dist/cjs/docker/lib/DockerContainer.d.ts +315 -0
- package/dist/cjs/docker/lib/DockerContainer.js +742 -0
- package/dist/cjs/docker/lib/DockerContainerTTY.d.ts +99 -0
- package/dist/cjs/docker/lib/DockerContainerTTY.js +157 -0
- package/dist/cjs/docker/lib/DockerImage.d.ts +153 -0
- package/dist/cjs/docker/lib/DockerImage.js +273 -0
- package/dist/cjs/docker/lib/EngineSettings.d.ts +41 -0
- package/dist/cjs/docker/lib/EngineSettings.js +86 -0
- package/dist/cjs/docker/lib/ParseBaseImages.d.ts +9 -0
- package/dist/cjs/docker/lib/ParseBaseImages.js +50 -0
- package/dist/cjs/docker/lib/ParseEnvToRecord.d.ts +14 -0
- package/dist/cjs/docker/lib/ParseEnvToRecord.js +25 -0
- package/dist/cjs/docker/lib/ParseRepositoryTag.d.ts +17 -0
- package/dist/cjs/docker/lib/ParseRepositoryTag.js +48 -0
- package/dist/cjs/docker/lib/RegistryAuth.d.ts +8 -0
- package/dist/cjs/docker/lib/RegistryAuth.js +15 -0
- package/dist/cjs/docker/options/DockerPruneOptions.d.ts +38 -0
- package/dist/cjs/docker/options/DockerPruneOptions.js +47 -0
- package/dist/cjs/docker/options/auth/DockerAuthOptions.d.ts +46 -0
- package/dist/cjs/docker/options/auth/DockerAuthOptions.js +59 -0
- package/dist/cjs/docker/options/container/ContainerCommitOptions.d.ts +28 -0
- package/dist/cjs/docker/options/container/ContainerCommitOptions.js +39 -0
- package/dist/cjs/docker/options/container/ContainerCreateTTYOptions.d.ts +32 -0
- package/dist/cjs/docker/options/container/ContainerCreateTTYOptions.js +43 -0
- package/dist/cjs/docker/options/container/ContainerExecOptions.d.ts +26 -0
- package/dist/cjs/docker/options/container/ContainerExecOptions.js +38 -0
- package/dist/cjs/docker/options/container/ContainerExportDirectoryOptions.d.ts +27 -0
- package/dist/cjs/docker/options/container/ContainerExportDirectoryOptions.js +39 -0
- package/dist/cjs/docker/options/container/ContainerKillOptions.d.ts +25 -0
- package/dist/cjs/docker/options/container/ContainerKillOptions.js +36 -0
- package/dist/cjs/docker/options/container/ContainerLogsOptions.d.ts +48 -0
- package/dist/cjs/docker/options/container/ContainerLogsOptions.js +56 -0
- package/dist/cjs/docker/options/container/ContainerRemoveOptions.d.ts +22 -0
- package/dist/cjs/docker/options/container/ContainerRemoveOptions.js +34 -0
- package/dist/cjs/docker/options/container/ContainerSettingOptions.d.ts +137 -0
- package/dist/cjs/docker/options/container/ContainerSettingOptions.js +136 -0
- package/dist/cjs/docker/options/container/ContainerStopOptions.d.ts +28 -0
- package/dist/cjs/docker/options/container/ContainerStopOptions.js +40 -0
- package/dist/cjs/docker/options/container/ContainerTTYConsoleSizeOptions.d.ts +26 -0
- package/dist/cjs/docker/options/container/ContainerTTYConsoleSizeOptions.js +40 -0
- package/dist/cjs/docker/options/image/ImageBuildOptions.d.ts +117 -0
- package/dist/cjs/docker/options/image/ImageBuildOptions.js +111 -0
- package/dist/cjs/docker/options/image/ImageExportOptions.d.ts +33 -0
- package/dist/cjs/docker/options/image/ImageExportOptions.js +44 -0
- package/dist/cjs/docker/options/image/ImageImportOptions.d.ts +28 -0
- package/dist/cjs/docker/options/image/ImageImportOptions.js +42 -0
- package/dist/cjs/docker/options/image/ImagePullOptions.d.ts +49 -0
- package/dist/cjs/docker/options/image/ImagePullOptions.js +63 -0
- package/dist/cjs/docker/options/image/ImagePushOptions.d.ts +41 -0
- package/dist/cjs/docker/options/image/ImagePushOptions.js +56 -0
- package/dist/cjs/docker/options/image/ImageRemoveOptions.d.ts +26 -0
- package/dist/cjs/docker/options/image/ImageRemoveOptions.js +38 -0
- package/dist/cjs/docker/options/image/ImageTagOptions.d.ts +25 -0
- package/dist/cjs/docker/options/image/ImageTagOptions.js +38 -0
- package/dist/cjs/docker/options/network/NetworkCreateOptions.d.ts +54 -0
- package/dist/cjs/docker/options/network/NetworkCreateOptions.js +63 -0
- package/dist/cjs/docker/types/ContainerBind.d.ts +19 -0
- package/dist/cjs/docker/types/ContainerBind.js +2 -0
- package/dist/cjs/docker/types/ContainerCapability.d.ts +286 -0
- package/dist/cjs/docker/types/ContainerCapability.js +290 -0
- package/dist/cjs/docker/types/ContainerConfig.d.ts +67 -0
- package/dist/cjs/docker/types/ContainerConfig.js +2 -0
- package/dist/cjs/docker/types/ContainerDevice.d.ts +19 -0
- package/dist/cjs/docker/types/ContainerDevice.js +2 -0
- package/dist/cjs/docker/types/ContainerExecResult.d.ts +20 -0
- package/dist/cjs/docker/types/ContainerExecResult.js +2 -0
- package/dist/cjs/docker/types/ContainerNetwork.d.ts +46 -0
- package/dist/cjs/docker/types/ContainerNetwork.js +2 -0
- package/dist/cjs/docker/types/ContainerPort.d.ts +25 -0
- package/dist/cjs/docker/types/ContainerPort.js +2 -0
- package/dist/cjs/docker/types/ContainerRestartPolicy.d.ts +11 -0
- package/dist/cjs/docker/types/ContainerRestartPolicy.js +2 -0
- package/dist/cjs/docker/types/ContainerState.d.ts +48 -0
- package/dist/cjs/docker/types/ContainerState.js +2 -0
- package/dist/cjs/docker/types/ContainerStats.d.ts +408 -0
- package/dist/cjs/docker/types/ContainerStats.js +2 -0
- package/dist/cjs/docker/types/DockerOutputCallback.d.ts +8 -0
- package/dist/cjs/docker/types/DockerOutputCallback.js +2 -0
- package/dist/cjs/docker/types/ImageConfig.d.ts +34 -0
- package/dist/cjs/docker/types/ImageConfig.js +2 -0
- package/dist/cjs/docker/types/ImageExposePort.d.ts +17 -0
- package/dist/cjs/docker/types/ImageExposePort.js +2 -0
- package/dist/cjs/docker/types/NetworkInfo.d.ts +59 -0
- package/dist/cjs/docker/types/NetworkInfo.js +2 -0
- package/dist/cjs/docker/types/RepositoryTag.d.ts +15 -0
- package/dist/cjs/docker/types/RepositoryTag.js +2 -0
- package/dist/cjs/exports/Docker.d.ts +73 -0
- package/dist/cjs/exports/Docker.js +92 -0
- package/dist/cjs/package.json +1 -0
- package/dist/esm/client/BuildContext.js +70 -0
- package/dist/esm/client/BuildKitProgress.js +190 -0
- package/dist/esm/client/DockerClient.js +307 -0
- package/dist/esm/client/DockerConnection.js +355 -0
- package/dist/esm/client/DockerIgnore.js +179 -0
- package/dist/esm/client/DockerRequestError.js +20 -0
- package/dist/esm/client/DockerStreams.js +111 -0
- package/dist/esm/client/types/ContainerCreateResponse.js +1 -0
- package/dist/esm/client/types/ContainerStopQuery.js +1 -0
- package/dist/esm/client/types/DeviceMapping.js +1 -0
- package/dist/esm/client/types/IdResponse.js +1 -0
- package/dist/esm/client/types/NetworkCreateResponse.js +1 -0
- package/dist/esm/client/types/PortBinding.js +1 -0
- package/dist/esm/docker/ConnectionOptionsBuilder.js +142 -0
- package/dist/esm/docker/Docker.js +697 -0
- package/dist/esm/docker/exceptions/DockerConnectionException.js +12 -0
- package/dist/esm/docker/exceptions/DockerContainerNotFoundException.js +12 -0
- package/dist/esm/docker/exceptions/DockerImageBuildException.js +12 -0
- package/dist/esm/docker/exceptions/DockerImageImportException.js +12 -0
- package/dist/esm/docker/exceptions/DockerImageNotFoundException.js +13 -0
- package/dist/esm/docker/exceptions/DockerImagePullException.js +12 -0
- package/dist/esm/docker/exceptions/DockerImagePushException.js +11 -0
- package/dist/esm/docker/exceptions/DockerImageRepoTagNotFoundException.js +11 -0
- package/dist/esm/docker/exceptions/DockerNetworkNotFoundException.js +12 -0
- package/dist/esm/docker/exceptions/DockerRequestException.js +20 -0
- package/dist/esm/docker/interfaces/IDockerConnectionOptions.js +1 -0
- package/dist/esm/docker/interfaces/IDockerHttpConnectionOptions.js +1 -0
- package/dist/esm/docker/interfaces/IDockerHttpsConnectionOptions.js +1 -0
- package/dist/esm/docker/interfaces/IDockerKeyObject.js +1 -0
- package/dist/esm/docker/interfaces/IDockerSSHConnectionOptions.js +1 -0
- package/dist/esm/docker/interfaces/IDockerSocketConnectionOptions.js +1 -0
- package/dist/esm/docker/lib/DockerContainer.js +739 -0
- package/dist/esm/docker/lib/DockerContainerTTY.js +154 -0
- package/dist/esm/docker/lib/DockerImage.js +270 -0
- package/dist/esm/docker/lib/EngineSettings.js +78 -0
- package/dist/esm/docker/lib/ParseBaseImages.js +47 -0
- package/dist/esm/docker/lib/ParseEnvToRecord.js +22 -0
- package/dist/esm/docker/lib/ParseRepositoryTag.js +45 -0
- package/dist/esm/docker/lib/RegistryAuth.js +12 -0
- package/dist/esm/docker/options/DockerPruneOptions.js +43 -0
- package/dist/esm/docker/options/auth/DockerAuthOptions.js +55 -0
- package/dist/esm/docker/options/container/ContainerCommitOptions.js +35 -0
- package/dist/esm/docker/options/container/ContainerCreateTTYOptions.js +39 -0
- package/dist/esm/docker/options/container/ContainerExecOptions.js +34 -0
- package/dist/esm/docker/options/container/ContainerExportDirectoryOptions.js +35 -0
- package/dist/esm/docker/options/container/ContainerKillOptions.js +32 -0
- package/dist/esm/docker/options/container/ContainerLogsOptions.js +52 -0
- package/dist/esm/docker/options/container/ContainerRemoveOptions.js +30 -0
- package/dist/esm/docker/options/container/ContainerSettingOptions.js +132 -0
- package/dist/esm/docker/options/container/ContainerStopOptions.js +36 -0
- package/dist/esm/docker/options/container/ContainerTTYConsoleSizeOptions.js +36 -0
- package/dist/esm/docker/options/image/ImageBuildOptions.js +107 -0
- package/dist/esm/docker/options/image/ImageExportOptions.js +40 -0
- package/dist/esm/docker/options/image/ImageImportOptions.js +38 -0
- package/dist/esm/docker/options/image/ImagePullOptions.js +59 -0
- package/dist/esm/docker/options/image/ImagePushOptions.js +52 -0
- package/dist/esm/docker/options/image/ImageRemoveOptions.js +34 -0
- package/dist/esm/docker/options/image/ImageTagOptions.js +34 -0
- package/dist/esm/docker/options/network/NetworkCreateOptions.js +59 -0
- package/dist/esm/docker/types/ContainerBind.js +1 -0
- package/dist/esm/docker/types/ContainerCapability.js +287 -0
- package/dist/esm/docker/types/ContainerConfig.js +1 -0
- package/dist/esm/docker/types/ContainerDevice.js +1 -0
- package/dist/esm/docker/types/ContainerExecResult.js +1 -0
- package/dist/esm/docker/types/ContainerNetwork.js +1 -0
- package/dist/esm/docker/types/ContainerPort.js +1 -0
- package/dist/esm/docker/types/ContainerRestartPolicy.js +1 -0
- package/dist/esm/docker/types/ContainerState.js +1 -0
- package/dist/esm/docker/types/ContainerStats.js +1 -0
- package/dist/esm/docker/types/DockerOutputCallback.js +1 -0
- package/dist/esm/docker/types/ImageConfig.js +1 -0
- package/dist/esm/docker/types/ImageExposePort.js +1 -0
- package/dist/esm/docker/types/NetworkInfo.js +1 -0
- package/dist/esm/docker/types/RepositoryTag.js +1 -0
- package/dist/esm/exports/Docker.js +73 -0
- package/dist/types/client/BuildContext.d.ts +22 -0
- package/dist/types/client/BuildKitProgress.d.ts +81 -0
- package/dist/types/client/DockerClient.d.ts +196 -0
- package/dist/types/client/DockerConnection.d.ts +154 -0
- package/dist/types/client/DockerIgnore.d.ts +44 -0
- package/dist/types/client/DockerRequestError.d.ts +17 -0
- package/dist/types/client/DockerStreams.d.ts +35 -0
- package/dist/types/client/types/ContainerCreateResponse.d.ts +7 -0
- package/dist/types/client/types/ContainerStopQuery.d.ts +13 -0
- package/dist/types/client/types/DeviceMapping.d.ts +8 -0
- package/dist/types/client/types/IdResponse.d.ts +6 -0
- package/dist/types/client/types/NetworkCreateResponse.d.ts +7 -0
- package/dist/types/client/types/PortBinding.d.ts +10 -0
- package/dist/types/docker/ConnectionOptionsBuilder.d.ts +128 -0
- package/dist/types/docker/Docker.d.ts +301 -0
- package/dist/types/docker/exceptions/DockerConnectionException.d.ts +9 -0
- package/dist/types/docker/exceptions/DockerContainerNotFoundException.d.ts +9 -0
- package/dist/types/docker/exceptions/DockerImageBuildException.d.ts +9 -0
- package/dist/types/docker/exceptions/DockerImageImportException.d.ts +9 -0
- package/dist/types/docker/exceptions/DockerImageNotFoundException.d.ts +10 -0
- package/dist/types/docker/exceptions/DockerImagePullException.d.ts +9 -0
- package/dist/types/docker/exceptions/DockerImagePushException.d.ts +8 -0
- package/dist/types/docker/exceptions/DockerImageRepoTagNotFoundException.d.ts +8 -0
- package/dist/types/docker/exceptions/DockerNetworkNotFoundException.d.ts +9 -0
- package/dist/types/docker/exceptions/DockerRequestException.d.ts +22 -0
- package/dist/types/docker/interfaces/IDockerConnectionOptions.d.ts +75 -0
- package/dist/types/docker/interfaces/IDockerHttpConnectionOptions.d.ts +16 -0
- package/dist/types/docker/interfaces/IDockerHttpsConnectionOptions.d.ts +16 -0
- package/dist/types/docker/interfaces/IDockerKeyObject.d.ts +14 -0
- package/dist/types/docker/interfaces/IDockerSSHConnectionOptions.d.ts +16 -0
- package/dist/types/docker/interfaces/IDockerSocketConnectionOptions.d.ts +7 -0
- package/dist/types/docker/lib/DockerContainer.d.ts +315 -0
- package/dist/types/docker/lib/DockerContainerTTY.d.ts +99 -0
- package/dist/types/docker/lib/DockerImage.d.ts +153 -0
- package/dist/types/docker/lib/EngineSettings.d.ts +41 -0
- package/dist/types/docker/lib/ParseBaseImages.d.ts +9 -0
- package/dist/types/docker/lib/ParseEnvToRecord.d.ts +14 -0
- package/dist/types/docker/lib/ParseRepositoryTag.d.ts +17 -0
- package/dist/types/docker/lib/RegistryAuth.d.ts +8 -0
- package/dist/types/docker/options/DockerPruneOptions.d.ts +38 -0
- package/dist/types/docker/options/auth/DockerAuthOptions.d.ts +46 -0
- package/dist/types/docker/options/container/ContainerCommitOptions.d.ts +28 -0
- package/dist/types/docker/options/container/ContainerCreateTTYOptions.d.ts +32 -0
- package/dist/types/docker/options/container/ContainerExecOptions.d.ts +26 -0
- package/dist/types/docker/options/container/ContainerExportDirectoryOptions.d.ts +27 -0
- package/dist/types/docker/options/container/ContainerKillOptions.d.ts +25 -0
- package/dist/types/docker/options/container/ContainerLogsOptions.d.ts +48 -0
- package/dist/types/docker/options/container/ContainerRemoveOptions.d.ts +22 -0
- package/dist/types/docker/options/container/ContainerSettingOptions.d.ts +137 -0
- package/dist/types/docker/options/container/ContainerStopOptions.d.ts +28 -0
- package/dist/types/docker/options/container/ContainerTTYConsoleSizeOptions.d.ts +26 -0
- package/dist/types/docker/options/image/ImageBuildOptions.d.ts +117 -0
- package/dist/types/docker/options/image/ImageExportOptions.d.ts +33 -0
- package/dist/types/docker/options/image/ImageImportOptions.d.ts +28 -0
- package/dist/types/docker/options/image/ImagePullOptions.d.ts +49 -0
- package/dist/types/docker/options/image/ImagePushOptions.d.ts +41 -0
- package/dist/types/docker/options/image/ImageRemoveOptions.d.ts +26 -0
- package/dist/types/docker/options/image/ImageTagOptions.d.ts +25 -0
- package/dist/types/docker/options/network/NetworkCreateOptions.d.ts +54 -0
- package/dist/types/docker/types/ContainerBind.d.ts +19 -0
- package/dist/types/docker/types/ContainerCapability.d.ts +286 -0
- package/dist/types/docker/types/ContainerConfig.d.ts +67 -0
- package/dist/types/docker/types/ContainerDevice.d.ts +19 -0
- package/dist/types/docker/types/ContainerExecResult.d.ts +20 -0
- package/dist/types/docker/types/ContainerNetwork.d.ts +46 -0
- package/dist/types/docker/types/ContainerPort.d.ts +25 -0
- package/dist/types/docker/types/ContainerRestartPolicy.d.ts +11 -0
- package/dist/types/docker/types/ContainerState.d.ts +48 -0
- package/dist/types/docker/types/ContainerStats.d.ts +408 -0
- package/dist/types/docker/types/DockerOutputCallback.d.ts +8 -0
- package/dist/types/docker/types/ImageConfig.d.ts +34 -0
- package/dist/types/docker/types/ImageExposePort.d.ts +17 -0
- package/dist/types/docker/types/NetworkInfo.d.ts +59 -0
- package/dist/types/docker/types/RepositoryTag.d.ts +15 -0
- package/dist/types/exports/Docker.d.ts +73 -0
- package/package.json +57 -0
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
2
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
3
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
4
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
5
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
6
|
+
};
|
|
7
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
8
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
9
|
+
};
|
|
10
|
+
import { DTO } from '@lakutata/core';
|
|
11
|
+
import { Expect } from '@lakutata/core/decorator/dto';
|
|
12
|
+
import { Stream } from 'node:stream';
|
|
13
|
+
/**
|
|
14
|
+
* How `DockerImage.export()` saves an image as a tar archive (`docker save`), which {@link Docker.importImage} or
|
|
15
|
+
* `docker load` loads back. `destination` is required.
|
|
16
|
+
* @example
|
|
17
|
+
* ```typescript
|
|
18
|
+
* import {Docker} from 'lakutata/com/docker'
|
|
19
|
+
*
|
|
20
|
+
* declare const docker: Docker
|
|
21
|
+
*
|
|
22
|
+
* const image = await docker.getImage('api:1.4.0')
|
|
23
|
+
* //Loaded back as api:stable
|
|
24
|
+
* await image.export({destination: '/backup/api.tar', repoTag: 'api:stable'})
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
export class ImageExportOptions extends DTO {
|
|
28
|
+
}
|
|
29
|
+
__decorate([
|
|
30
|
+
Expect(DTO.Alternatives(DTO.String(), DTO.InstanceOf(Stream)).required()),
|
|
31
|
+
__metadata("design:type", Object)
|
|
32
|
+
], ImageExportOptions.prototype, "destination", void 0);
|
|
33
|
+
__decorate([
|
|
34
|
+
Expect(DTO.String().optional()),
|
|
35
|
+
__metadata("design:type", String)
|
|
36
|
+
], ImageExportOptions.prototype, "repoTag", void 0);
|
|
37
|
+
__decorate([
|
|
38
|
+
Expect(DTO.Boolean().optional().default(true)),
|
|
39
|
+
__metadata("design:type", Boolean)
|
|
40
|
+
], ImageExportOptions.prototype, "createRepoTagIfNotExists", void 0);
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
2
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
3
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
4
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
5
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
6
|
+
};
|
|
7
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
8
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
9
|
+
};
|
|
10
|
+
import { DTO } from '@lakutata/core';
|
|
11
|
+
import { Expect } from '@lakutata/core/decorator/dto';
|
|
12
|
+
import { Stream } from 'node:stream';
|
|
13
|
+
/**
|
|
14
|
+
* How {@link Docker.importImage} loads an image from a tar archive made by `DockerImage.export()` or `docker save`
|
|
15
|
+
* (`docker load`), the loaded image returned. `source` is required.
|
|
16
|
+
* @example
|
|
17
|
+
* ```typescript
|
|
18
|
+
* import {createReadStream} from 'node:fs'
|
|
19
|
+
* import {Docker} from 'lakutata/com/docker'
|
|
20
|
+
*
|
|
21
|
+
* declare const docker: Docker
|
|
22
|
+
*
|
|
23
|
+
* const image = await docker.importImage({source: '/backup/api.tar'})
|
|
24
|
+
* //Or from a stream: an upload, a download
|
|
25
|
+
* const copy = await docker.importImage({source: createReadStream('/backup/api.tar')})
|
|
26
|
+
* console.log(image.repoTags, copy.id)
|
|
27
|
+
* ```
|
|
28
|
+
*/
|
|
29
|
+
export class ImageImportOptions extends DTO {
|
|
30
|
+
}
|
|
31
|
+
__decorate([
|
|
32
|
+
Expect(DTO.Alternatives(DTO.String(), DTO.InstanceOf(Stream)).required()),
|
|
33
|
+
__metadata("design:type", Object)
|
|
34
|
+
], ImageImportOptions.prototype, "source", void 0);
|
|
35
|
+
__decorate([
|
|
36
|
+
Expect(DTO.Boolean().optional().default(false)),
|
|
37
|
+
__metadata("design:type", Boolean)
|
|
38
|
+
], ImageImportOptions.prototype, "quiet", void 0);
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
2
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
3
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
4
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
5
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
6
|
+
};
|
|
7
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
8
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
9
|
+
};
|
|
10
|
+
import { DTO } from '@lakutata/core';
|
|
11
|
+
import { Expect } from '@lakutata/core/decorator/dto';
|
|
12
|
+
import { DockerAuthOptions } from '../auth/DockerAuthOptions.js';
|
|
13
|
+
/**
|
|
14
|
+
* Which image {@link Docker.pullImage} pulls from its registry (`docker pull`), the pulled image returned. `repo` is
|
|
15
|
+
* required.
|
|
16
|
+
* @example
|
|
17
|
+
* ```typescript
|
|
18
|
+
* import {Docker} from 'lakutata/com/docker'
|
|
19
|
+
*
|
|
20
|
+
* declare const docker: Docker
|
|
21
|
+
*
|
|
22
|
+
* const nginx = await docker.pullImage({repo: 'nginx', tag: '1.27-alpine'})
|
|
23
|
+
* const app = await docker.pullImage({
|
|
24
|
+
* repo: 'registry.example.com:5000/team/app',
|
|
25
|
+
* tag: '2.1.0',
|
|
26
|
+
* platform: 'linux/arm64',
|
|
27
|
+
* auth: {serverAddress: 'registry.example.com:5000', username: 'ci', password: process.env.REGISTRY_PASSWORD ?? ''},
|
|
28
|
+
* outputCallback: (output: Record<string, any>): void => console.log(output.status, output.id ?? '')
|
|
29
|
+
* })
|
|
30
|
+
* console.log(nginx.id, app.id)
|
|
31
|
+
* ```
|
|
32
|
+
*/
|
|
33
|
+
export class ImagePullOptions extends DTO {
|
|
34
|
+
}
|
|
35
|
+
__decorate([
|
|
36
|
+
Expect(DTO.String().required()),
|
|
37
|
+
__metadata("design:type", String)
|
|
38
|
+
], ImagePullOptions.prototype, "repo", void 0);
|
|
39
|
+
__decorate([
|
|
40
|
+
Expect(DTO.String().optional().default('latest')),
|
|
41
|
+
__metadata("design:type", String)
|
|
42
|
+
], ImagePullOptions.prototype, "tag", void 0);
|
|
43
|
+
__decorate([
|
|
44
|
+
Expect(DTO.String().optional()),
|
|
45
|
+
__metadata("design:type", String)
|
|
46
|
+
], ImagePullOptions.prototype, "platform", void 0);
|
|
47
|
+
__decorate([
|
|
48
|
+
Expect(DockerAuthOptions.optional()),
|
|
49
|
+
__metadata("design:type", DockerAuthOptions
|
|
50
|
+
/**
|
|
51
|
+
* Receive the pull progress as Docker sends it (`{status: 'Downloading', id: '<layer>', progressDetail: {current,
|
|
52
|
+
* total}}`).
|
|
53
|
+
*/
|
|
54
|
+
)
|
|
55
|
+
], ImagePullOptions.prototype, "auth", void 0);
|
|
56
|
+
__decorate([
|
|
57
|
+
Expect(DTO.Function().optional()),
|
|
58
|
+
__metadata("design:type", Function)
|
|
59
|
+
], ImagePullOptions.prototype, "outputCallback", void 0);
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
2
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
3
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
4
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
5
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
6
|
+
};
|
|
7
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
8
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
9
|
+
};
|
|
10
|
+
import { DTO } from '@lakutata/core';
|
|
11
|
+
import { Expect } from '@lakutata/core/decorator/dto';
|
|
12
|
+
import { DockerAuthOptions } from '../auth/DockerAuthOptions.js';
|
|
13
|
+
/**
|
|
14
|
+
* Where `DockerImage.push()` pushes an image (`docker push`): the image is tagged `repo:tag` first, then pushed to the
|
|
15
|
+
* registry of `repo`. `repo` is required.
|
|
16
|
+
* @example
|
|
17
|
+
* ```typescript
|
|
18
|
+
* import {Docker} from 'lakutata/com/docker'
|
|
19
|
+
*
|
|
20
|
+
* declare const docker: Docker
|
|
21
|
+
*
|
|
22
|
+
* const image = await docker.getImage('api:1.4.0')
|
|
23
|
+
* await image.push({
|
|
24
|
+
* repo: 'registry.example.com:5000/team/api',
|
|
25
|
+
* tag: '1.4.0',
|
|
26
|
+
* auth: {serverAddress: 'registry.example.com:5000', username: 'ci', password: process.env.REGISTRY_PASSWORD ?? ''}
|
|
27
|
+
* })
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
export class ImagePushOptions extends DTO {
|
|
31
|
+
}
|
|
32
|
+
__decorate([
|
|
33
|
+
Expect(DTO.String().required()),
|
|
34
|
+
__metadata("design:type", String)
|
|
35
|
+
], ImagePushOptions.prototype, "repo", void 0);
|
|
36
|
+
__decorate([
|
|
37
|
+
Expect(DTO.String().optional().default('latest')),
|
|
38
|
+
__metadata("design:type", String)
|
|
39
|
+
], ImagePushOptions.prototype, "tag", void 0);
|
|
40
|
+
__decorate([
|
|
41
|
+
Expect(DockerAuthOptions.optional()),
|
|
42
|
+
__metadata("design:type", DockerAuthOptions
|
|
43
|
+
/**
|
|
44
|
+
* Receive the push progress as Docker sends it (`{status: 'Pushing', id: '<layer>', progressDetail: {current,
|
|
45
|
+
* total}}`).
|
|
46
|
+
*/
|
|
47
|
+
)
|
|
48
|
+
], ImagePushOptions.prototype, "auth", void 0);
|
|
49
|
+
__decorate([
|
|
50
|
+
Expect(DTO.Function().optional()),
|
|
51
|
+
__metadata("design:type", Function)
|
|
52
|
+
], ImagePushOptions.prototype, "outputCallback", void 0);
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
2
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
3
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
4
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
5
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
6
|
+
};
|
|
7
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
8
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
9
|
+
};
|
|
10
|
+
import { DTO } from '@lakutata/core';
|
|
11
|
+
import { Expect } from '@lakutata/core/decorator/dto';
|
|
12
|
+
/**
|
|
13
|
+
* How `DockerImage.remove()` removes an image by its ID (`docker rmi`).
|
|
14
|
+
* @example
|
|
15
|
+
* ```typescript
|
|
16
|
+
* import {Docker} from 'lakutata/com/docker'
|
|
17
|
+
*
|
|
18
|
+
* declare const docker: Docker
|
|
19
|
+
*
|
|
20
|
+
* const image = await docker.getImage('api:1.3.0')
|
|
21
|
+
* //Fails when a container uses the image
|
|
22
|
+
* await image.remove({force: false})
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
export class ImageRemoveOptions extends DTO {
|
|
26
|
+
}
|
|
27
|
+
__decorate([
|
|
28
|
+
Expect(DTO.Boolean().optional().default(true)),
|
|
29
|
+
__metadata("design:type", Boolean)
|
|
30
|
+
], ImageRemoveOptions.prototype, "force", void 0);
|
|
31
|
+
__decorate([
|
|
32
|
+
Expect(DTO.Boolean().optional()),
|
|
33
|
+
__metadata("design:type", Boolean)
|
|
34
|
+
], ImageRemoveOptions.prototype, "noprune", void 0);
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
2
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
3
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
4
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
5
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
6
|
+
};
|
|
7
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
8
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
9
|
+
};
|
|
10
|
+
import { DTO } from '@lakutata/core';
|
|
11
|
+
import { Expect } from '@lakutata/core/decorator/dto';
|
|
12
|
+
/**
|
|
13
|
+
* The name `DockerImage.tag()` gives an image (`docker tag`), in addition to its other ones. `repo` is required.
|
|
14
|
+
* @example
|
|
15
|
+
* ```typescript
|
|
16
|
+
* import {Docker} from 'lakutata/com/docker'
|
|
17
|
+
*
|
|
18
|
+
* declare const docker: Docker
|
|
19
|
+
*
|
|
20
|
+
* const image = await docker.getImage('api:1.4.0')
|
|
21
|
+
* await image.tag({repo: 'registry.example.com:5000/team/api', tag: 'stable'})
|
|
22
|
+
* console.log(image.repoTags)
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
export class ImageTagOptions extends DTO {
|
|
26
|
+
}
|
|
27
|
+
__decorate([
|
|
28
|
+
Expect(DTO.String().required()),
|
|
29
|
+
__metadata("design:type", String)
|
|
30
|
+
], ImageTagOptions.prototype, "repo", void 0);
|
|
31
|
+
__decorate([
|
|
32
|
+
Expect(DTO.String().optional()),
|
|
33
|
+
__metadata("design:type", String)
|
|
34
|
+
], ImageTagOptions.prototype, "tag", void 0);
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
2
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
3
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
4
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
5
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
6
|
+
};
|
|
7
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
8
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
9
|
+
};
|
|
10
|
+
import { DTO } from '@lakutata/core';
|
|
11
|
+
import { Expect } from '@lakutata/core/decorator/dto';
|
|
12
|
+
/**
|
|
13
|
+
* The network {@link Docker.createNetwork} creates (`docker network create`), the created network returned. Only `name`
|
|
14
|
+
* is required.
|
|
15
|
+
* @example
|
|
16
|
+
* ```typescript
|
|
17
|
+
* import {Docker} from 'lakutata/com/docker'
|
|
18
|
+
*
|
|
19
|
+
* declare const docker: Docker
|
|
20
|
+
*
|
|
21
|
+
* const network = await docker.createNetwork({
|
|
22
|
+
* name: 'back',
|
|
23
|
+
* internal: true,
|
|
24
|
+
* NetworkIPAMConfigs: [{subnet: '172.28.0.0/16', range: '172.28.5.0/24', gateway: '172.28.0.1'}]
|
|
25
|
+
* })
|
|
26
|
+
* //Its containers get their addresses from 172.28.5.0/24, or the static ones given to their settings
|
|
27
|
+
* console.log(network.id)
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
export class NetworkCreateOptions extends DTO {
|
|
31
|
+
}
|
|
32
|
+
__decorate([
|
|
33
|
+
Expect(DTO.String().required()),
|
|
34
|
+
__metadata("design:type", String)
|
|
35
|
+
], NetworkCreateOptions.prototype, "name", void 0);
|
|
36
|
+
__decorate([
|
|
37
|
+
Expect(DTO.Object().optional().default({})),
|
|
38
|
+
__metadata("design:type", Object)
|
|
39
|
+
], NetworkCreateOptions.prototype, "options", void 0);
|
|
40
|
+
__decorate([
|
|
41
|
+
Expect(DTO.String().valid('bridge', 'ipvlan', 'macvlan').optional().default('bridge')),
|
|
42
|
+
__metadata("design:type", String)
|
|
43
|
+
], NetworkCreateOptions.prototype, "driver", void 0);
|
|
44
|
+
__decorate([
|
|
45
|
+
Expect(DTO.Array(DTO.Object({
|
|
46
|
+
subnet: DTO.String().ip({ cidr: 'required' }).required(),
|
|
47
|
+
range: DTO.String().ip({ cidr: 'required' }).optional(),
|
|
48
|
+
gateway: DTO.String().ip({ cidr: 'forbidden' }).required()
|
|
49
|
+
})).optional().default([])),
|
|
50
|
+
__metadata("design:type", Array)
|
|
51
|
+
], NetworkCreateOptions.prototype, "NetworkIPAMConfigs", void 0);
|
|
52
|
+
__decorate([
|
|
53
|
+
Expect(DTO.Boolean().optional()),
|
|
54
|
+
__metadata("design:type", Boolean)
|
|
55
|
+
], NetworkCreateOptions.prototype, "internal", void 0);
|
|
56
|
+
__decorate([
|
|
57
|
+
Expect(DTO.Boolean().optional()),
|
|
58
|
+
__metadata("design:type", Boolean)
|
|
59
|
+
], NetworkCreateOptions.prototype, "enableIPv6", void 0);
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,287 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Linux capabilities a container's processes can be given, by their names without the `CAP_` prefix (see
|
|
3
|
+
* capabilities(7)), for {@link ContainerSettingOptions.capabilities} (`docker run --cap-add`). Docker grants a default
|
|
4
|
+
* set already (`CHOWN`, `DAC_OVERRIDE`, `FOWNER`, `FSETID`, `KILL`, `SETGID`, `SETUID`, `SETPCAP`, `NET_BIND_SERVICE`,
|
|
5
|
+
* `NET_RAW`, `SYS_CHROOT`, `MKNOD`, `AUDIT_WRITE`, `SETFCAP`); a privileged container has them all.
|
|
6
|
+
*/
|
|
7
|
+
export var ContainerCapability;
|
|
8
|
+
(function (ContainerCapability) {
|
|
9
|
+
/**
|
|
10
|
+
* Enable and disable kernel auditing; change auditing filter rules; retrieve auditing status and filtering rules.
|
|
11
|
+
* (since Linux 2.6.11)
|
|
12
|
+
*/
|
|
13
|
+
ContainerCapability["AUDIT_CONTROL"] = "AUDIT_CONTROL";
|
|
14
|
+
/**
|
|
15
|
+
* Allow reading the audit log via a multicast netlink socket.
|
|
16
|
+
* (since Linux 3.16)
|
|
17
|
+
*/
|
|
18
|
+
ContainerCapability["AUDIT_READ"] = "AUDIT_READ";
|
|
19
|
+
/**
|
|
20
|
+
* Write records to kernel auditing log.
|
|
21
|
+
* (since Linux 2.6.11)
|
|
22
|
+
*/
|
|
23
|
+
ContainerCapability["AUDIT_WRITE"] = "AUDIT_WRITE";
|
|
24
|
+
/**
|
|
25
|
+
* Employ features that can block system suspend (epoll(7) EPOLLWAKEUP, /proc/sys/wake_lock).
|
|
26
|
+
* (since Linux 3.5)
|
|
27
|
+
*/
|
|
28
|
+
ContainerCapability["BLOCK_SUSPEND"] = "BLOCK_SUSPEND";
|
|
29
|
+
/**
|
|
30
|
+
* Employ privileged BPF operations; see bpf(2) and bpf-helpers(7).
|
|
31
|
+
* This capability was added in Linux 5.8 to separate out BPF functionality from the overloaded CAP_SYS_ADMIN capability.
|
|
32
|
+
* (since Linux 5.8)
|
|
33
|
+
*/
|
|
34
|
+
ContainerCapability["BPF"] = "BPF";
|
|
35
|
+
/**
|
|
36
|
+
* • Update /proc/sys/kernel/ns_last_pid (see pid_namespaces(7));
|
|
37
|
+
* • employ the set_tid feature of clone3(2);
|
|
38
|
+
* • read the contents of the symbolic links in /proc/pid/map_files for other processes.
|
|
39
|
+
* This capability was added in Linux 5.9 to separate out checkpoint/restore functionality from the overloaded CAP_SYS_ADMIN capability.
|
|
40
|
+
* (since Linux 5.9)
|
|
41
|
+
*/
|
|
42
|
+
ContainerCapability["CHECKPOINT_RESTORE"] = "CHECKPOINT_RESTORE";
|
|
43
|
+
/**
|
|
44
|
+
* Make arbitrary changes to file UIDs and GIDs (see chown(2)).
|
|
45
|
+
*/
|
|
46
|
+
ContainerCapability["CHOWN"] = "CHOWN";
|
|
47
|
+
/**
|
|
48
|
+
* Bypass file read, write, and execute permission checks. (DAC is an abbreviation of "discretionary access control".)
|
|
49
|
+
*/
|
|
50
|
+
ContainerCapability["DAC_OVERRIDE"] = "DAC_OVERRIDE";
|
|
51
|
+
/**
|
|
52
|
+
* • Bypass file read permission checks and directory read and execute permission checks;
|
|
53
|
+
* • invoke open_by_handle_at(2);
|
|
54
|
+
* • use the linkat(2) AT_EMPTY_PATH flag to create a link to a file referred to by a file descriptor.
|
|
55
|
+
*/
|
|
56
|
+
ContainerCapability["DAC_READ_SEARCH"] = "DAC_READ_SEARCH";
|
|
57
|
+
/**
|
|
58
|
+
* • Bypass permission checks on operations that normally require the filesystem UID of the process to match the UID of the file (e.g., chmod(2), utime(2)), excluding those operations covered by CAP_DAC_OVERRIDE and CAP_DAC_READ_SEARCH;
|
|
59
|
+
* • set inode flags (see ioctl_iflags(2)) on arbitrary files;
|
|
60
|
+
* • set Access Control Lists (ACLs) on arbitrary files;
|
|
61
|
+
* • ignore directory sticky bit on file deletion;
|
|
62
|
+
* • modify user extended attributes on sticky directory owned by any user;
|
|
63
|
+
* • specify O_NOATIME for arbitrary files in open(2) and fcntl(2).
|
|
64
|
+
*/
|
|
65
|
+
ContainerCapability["FOWNER"] = "FOWNER";
|
|
66
|
+
/**
|
|
67
|
+
* • Don't clear set-user-ID and set-group-ID mode bits when a file is modified;
|
|
68
|
+
* • set the set-group-ID bit for a file whose GID does not match the filesystem or any of the supplementary GIDs of the calling process.
|
|
69
|
+
*/
|
|
70
|
+
ContainerCapability["FSETID"] = "FSETID";
|
|
71
|
+
/**
|
|
72
|
+
* • Lock memory (mlock(2), mlockall(2), mmap(2), shmctl(2));
|
|
73
|
+
* • Allocate memory using huge pages (memfd_create(2), mmap(2), shmctl(2)).
|
|
74
|
+
*/
|
|
75
|
+
ContainerCapability["IPC_LOCK"] = "IPC_LOCK";
|
|
76
|
+
/**
|
|
77
|
+
* Bypass permission checks for operations on System V IPC objects.
|
|
78
|
+
*/
|
|
79
|
+
ContainerCapability["IPC_OWNER"] = "IPC_OWNER";
|
|
80
|
+
/**
|
|
81
|
+
* Bypass permission checks for sending signals (see kill(2)). This includes use of the ioctl(2) KDSIGACCEPT operation.
|
|
82
|
+
*/
|
|
83
|
+
ContainerCapability["KILL"] = "KILL";
|
|
84
|
+
/**
|
|
85
|
+
* Establish leases on arbitrary files (see fcntl(2)).
|
|
86
|
+
* (since Linux 2.4)
|
|
87
|
+
*/
|
|
88
|
+
ContainerCapability["LEASE"] = "LEASE";
|
|
89
|
+
/**
|
|
90
|
+
* Set the FS_APPEND_FL and FS_IMMUTABLE_FL inode flags (see ioctl_iflags(2)).
|
|
91
|
+
*/
|
|
92
|
+
ContainerCapability["LINUX_IMMUTABLE"] = "LINUX_IMMUTABLE";
|
|
93
|
+
/**
|
|
94
|
+
* Allow MAC configuration or state changes. Implemented for the Smack Linux Security Module (LSM).
|
|
95
|
+
* (since Linux 2.6.25)
|
|
96
|
+
*/
|
|
97
|
+
ContainerCapability["MAC_ADMIN"] = "MAC_ADMIN";
|
|
98
|
+
/**
|
|
99
|
+
* Override Mandatory Access Control (MAC). Implemented for the Smack LSM.
|
|
100
|
+
* (since Linux 2.6.25)
|
|
101
|
+
*/
|
|
102
|
+
ContainerCapability["MAC_OVERRIDE"] = "MAC_OVERRIDE";
|
|
103
|
+
/**
|
|
104
|
+
* Create special files using mknod(2).
|
|
105
|
+
* (since Linux 2.4)
|
|
106
|
+
*/
|
|
107
|
+
ContainerCapability["MKNOD"] = "MKNOD";
|
|
108
|
+
/**
|
|
109
|
+
* Perform various network-related operations:
|
|
110
|
+
* • interface configuration;
|
|
111
|
+
* • administration of IP firewall, masquerading, and accounting;
|
|
112
|
+
* • modify routing tables;
|
|
113
|
+
* • bind to any address for transparent proxying;
|
|
114
|
+
* • set type-of-service (TOS);
|
|
115
|
+
* • clear driver statistics;
|
|
116
|
+
* • set promiscuous mode;
|
|
117
|
+
* • enabling multicasting;
|
|
118
|
+
* • use setsockopt(2) to set the following socket options: SO_DEBUG, SO_MARK, SO_PRIORITY (for a priority outside the range 0 to 6), SO_RCVBUFFORCE, and SO_SNDBUFFORCE.
|
|
119
|
+
*/
|
|
120
|
+
ContainerCapability["NET_ADMIN"] = "NET_ADMIN";
|
|
121
|
+
/**
|
|
122
|
+
* Bind a socket to Internet domain privileged ports (port numbers less than 1024).
|
|
123
|
+
*/
|
|
124
|
+
ContainerCapability["NET_BIND_SERVICE"] = "NET_BIND_SERVICE";
|
|
125
|
+
/**
|
|
126
|
+
* (Unused) Make socket broadcasts, and listen to multicasts.
|
|
127
|
+
*/
|
|
128
|
+
ContainerCapability["NET_BROADCAST"] = "NET_BROADCAST";
|
|
129
|
+
/**
|
|
130
|
+
* • Use RAW and PACKET sockets;
|
|
131
|
+
* • bind to any address for transparent proxying.
|
|
132
|
+
*/
|
|
133
|
+
ContainerCapability["NET_RAW"] = "NET_RAW";
|
|
134
|
+
/**
|
|
135
|
+
* Employ various performance-monitoring mechanisms, including:
|
|
136
|
+
* • call perf_event_open(2);
|
|
137
|
+
* • employ various BPF operations that have performance implications.
|
|
138
|
+
* This capability was added in Linux 5.8 to separate out performance monitoring functionality from the overloaded CAP_SYS_ADMIN capability. See also the kernel source file Documentation/admin-guide/perf-security.rst.
|
|
139
|
+
* (since Linux 5.8)
|
|
140
|
+
*/
|
|
141
|
+
ContainerCapability["PERFMON"] = "PERFMON";
|
|
142
|
+
/**
|
|
143
|
+
* • Make arbitrary manipulations of process GIDs and supplementary GID list;
|
|
144
|
+
* • forge GID when passing socket credentials via UNIX domain sockets;
|
|
145
|
+
* • write a group ID mapping in a user namespace (see user_namespaces(7)).
|
|
146
|
+
*/
|
|
147
|
+
ContainerCapability["SETGID"] = "SETGID";
|
|
148
|
+
/**
|
|
149
|
+
* Set arbitrary capabilities on a file.
|
|
150
|
+
* Since Linux 5.12, this capability is also needed to map user ID 0 in a new user namespace; see user_namespaces(7) for details.
|
|
151
|
+
* (since Linux 2.6.24)
|
|
152
|
+
*/
|
|
153
|
+
ContainerCapability["SETFCAP"] = "SETFCAP";
|
|
154
|
+
/**
|
|
155
|
+
* If file capabilities are supported (i.e., since Linux 2.6.24): add any capability from the calling thread's bounding set to its inheritable set; drop capabilities from the bounding set (via prctl(2) PR_CAPBSET_DROP); make changes to the securebits flags.
|
|
156
|
+
* If file capabilities are not supported (i.e., before Linux 2.6.24): grant or remove any capability in the caller's permitted capability set to or from any other process. (This property of CAP_SETPCAP is not available when the kernel is configured to support file capabilities, since CAP_SETPCAP has entirely different semantics for such kernels.)
|
|
157
|
+
*/
|
|
158
|
+
ContainerCapability["SETPCAP"] = "SETPCAP";
|
|
159
|
+
/**
|
|
160
|
+
* • Make arbitrary manipulations of process UIDs (setuid(2), setreuid(2), setresuid(2), setfsuid(2));
|
|
161
|
+
* • forge UID when passing socket credentials via UNIX domain sockets;
|
|
162
|
+
* • write a user ID mapping in a user namespace (see user_namespaces(7)).
|
|
163
|
+
*/
|
|
164
|
+
ContainerCapability["SETUID"] = "SETUID";
|
|
165
|
+
/**
|
|
166
|
+
* Note: this capability is overloaded; see Notes to kernel developers below.
|
|
167
|
+
* • Perform a range of system administration operations including: quotactl(2), mount(2), umount(2), pivot_root(2), swapon(2), swapoff(2), sethostname(2), and setdomainname(2);
|
|
168
|
+
* • perform privileged syslog(2) operations (since Linux 2.6.37, CAP_SYSLOG should be used to permit such operations);
|
|
169
|
+
* • perform VM86_REQUEST_IRQ vm86(2) command;
|
|
170
|
+
* • access the same checkpoint/restore functionality that is governed by CAP_CHECKPOINT_RESTORE (but the latter, weaker capability is preferred for accessing that functionality).
|
|
171
|
+
* • perform the same BPF operations as are governed by CAP_BPF (but the latter, weaker capability is preferred for accessing that functionality).
|
|
172
|
+
* • employ the same performance monitoring mechanisms as are governed by CAP_PERFMON (but the latter, weaker capability is preferred for accessing that functionality).
|
|
173
|
+
* • perform IPC_SET and IPC_RMID operations on arbitrary System V IPC objects;
|
|
174
|
+
* • override RLIMIT_NPROC resource limit;
|
|
175
|
+
* • perform operations on trusted and security extended attributes (see xattr(7));
|
|
176
|
+
* • use lookup_dcookie(2);
|
|
177
|
+
* • use ioprio_set(2) to assign IOPRIO_CLASS_RT and (before Linux 2.6.25) IOPRIO_CLASS_IDLE I/O scheduling classes;
|
|
178
|
+
* • forge PID when passing socket credentials via UNIX domain sockets;
|
|
179
|
+
* • exceed /proc/sys/fs/file-max, the system-wide limit on the number of open files, in system calls that open files (e.g., accept(2), execve(2), open(2), pipe(2));
|
|
180
|
+
* • employ CLONE_* flags that create new namespaces with clone(2) and unshare(2) (but, since Linux 3.8, creating user namespaces does not require any capability);
|
|
181
|
+
* • access privileged perf event information;
|
|
182
|
+
* • call setns(2) (requires CAP_SYS_ADMIN in the target namespace);
|
|
183
|
+
* • call fanotify_init(2);
|
|
184
|
+
* • perform privileged KEYCTL_CHOWN and KEYCTL_SETPERM keyctl(2) operations;
|
|
185
|
+
* • perform madvise(2) MADV_HWPOISON operation;
|
|
186
|
+
* • employ the TIOCSTI ioctl(2) to insert characters into the input queue of a terminal other than the caller's controlling terminal;
|
|
187
|
+
* • employ the obsolete nfsservctl(2) system call;
|
|
188
|
+
* • employ the obsolete bdflush(2) system call;
|
|
189
|
+
* • perform various privileged block-device ioctl(2) operations;
|
|
190
|
+
* • perform various privileged filesystem ioctl(2) operations;
|
|
191
|
+
* • perform privileged ioctl(2) operations on the /dev/random device (see random(4));
|
|
192
|
+
* • install a seccomp(2) filter without first having to set the no_new_privs thread attribute;
|
|
193
|
+
* • modify allow/deny rules for device control groups;
|
|
194
|
+
* • employ the ptrace(2) PTRACE_SECCOMP_GET_FILTER operation to dump tracee's seccomp filters;
|
|
195
|
+
* • employ the ptrace(2) PTRACE_SETOPTIONS operation to suspend the tracee's seccomp protections (i.e., the PTRACE_O_SUSPEND_SECCOMP flag);
|
|
196
|
+
* • perform administrative operations on many device drivers;
|
|
197
|
+
* • modify autogroup nice values by writing to /proc/pid/autogroup (see sched(7)).
|
|
198
|
+
*/
|
|
199
|
+
ContainerCapability["SYS_ADMIN"] = "SYS_ADMIN";
|
|
200
|
+
/**
|
|
201
|
+
* Use reboot(2) and kexec_load(2).
|
|
202
|
+
*/
|
|
203
|
+
ContainerCapability["SYS_BOOT"] = "SYS_BOOT";
|
|
204
|
+
/**
|
|
205
|
+
* • Use chroot(2);
|
|
206
|
+
* • change mount namespaces using setns(2).
|
|
207
|
+
*/
|
|
208
|
+
ContainerCapability["SYS_CHROOT"] = "SYS_CHROOT";
|
|
209
|
+
/**
|
|
210
|
+
* • Load and unload kernel modules (see init_module(2) and delete_module(2));
|
|
211
|
+
* • before Linux 2.6.25: drop capabilities from the system-wide capability bounding set.
|
|
212
|
+
*/
|
|
213
|
+
ContainerCapability["SYS_MODULE"] = "SYS_MODULE";
|
|
214
|
+
/**
|
|
215
|
+
* • Lower the process nice value (nice(2), setpriority(2)) and change the nice value for arbitrary processes;
|
|
216
|
+
* • set real-time scheduling policies for calling process, and set scheduling policies and priorities for arbitrary processes (sched_setscheduler(2), sched_setparam(2), sched_setattr(2));
|
|
217
|
+
* • set CPU affinity for arbitrary processes (sched_setaffinity(2));
|
|
218
|
+
* • set I/O scheduling class and priority for arbitrary processes (ioprio_set(2));
|
|
219
|
+
* • apply migrate_pages(2) to arbitrary processes and allow processes to be migrated to arbitrary nodes;
|
|
220
|
+
* • apply move_pages(2) to arbitrary processes;
|
|
221
|
+
* • use the MPOL_MF_MOVE_ALL flag with mbind(2) and move_pages(2).
|
|
222
|
+
*/
|
|
223
|
+
ContainerCapability["SYS_NICE"] = "SYS_NICE";
|
|
224
|
+
/**
|
|
225
|
+
* Use acct(2).
|
|
226
|
+
*/
|
|
227
|
+
ContainerCapability["SYS_PACCT"] = "SYS_PACCT";
|
|
228
|
+
/**
|
|
229
|
+
* • Trace arbitrary processes using ptrace(2);
|
|
230
|
+
* • apply get_robust_list(2) to arbitrary processes;
|
|
231
|
+
* • transfer data to or from the memory of arbitrary processes using process_vm_readv(2) and process_vm_writev(2);
|
|
232
|
+
* • inspect processes using kcmp(2).
|
|
233
|
+
*/
|
|
234
|
+
ContainerCapability["SYS_PTRACE"] = "SYS_PTRACE";
|
|
235
|
+
/**
|
|
236
|
+
* • Perform I/O port operations (iopl(2) and ioperm(2));
|
|
237
|
+
* • access /proc/kcore;
|
|
238
|
+
* • employ the FIBMAP ioctl(2) operation;
|
|
239
|
+
* • open devices for accessing x86 model-specific registers (MSRs, see msr(4));
|
|
240
|
+
* • update /proc/sys/vm/mmap_min_addr;
|
|
241
|
+
* • create memory mappings at addresses below the value specified by /proc/sys/vm/mmap_min_addr;
|
|
242
|
+
* • map files in /proc/bus/pci;
|
|
243
|
+
* • open /dev/mem and /dev/kmem;
|
|
244
|
+
* • perform various SCSI device commands;
|
|
245
|
+
* • perform certain operations on hpsa(4) and cciss(4) devices;
|
|
246
|
+
* • perform a range of device-specific operations on other devices.
|
|
247
|
+
*/
|
|
248
|
+
ContainerCapability["SYS_RAWIO"] = "SYS_RAWIO";
|
|
249
|
+
/**
|
|
250
|
+
* • Use reserved space on ext2 filesystems;
|
|
251
|
+
* • make ioctl(2) calls controlling ext3 journaling;
|
|
252
|
+
* • override disk quota limits;
|
|
253
|
+
* • increase resource limits (see setrlimit(2));
|
|
254
|
+
* • override RLIMIT_NPROC resource limit;
|
|
255
|
+
* • override maximum number of consoles on console allocation;
|
|
256
|
+
* • override maximum number of keymaps;
|
|
257
|
+
* • allow more than 64hz interrupts from the real-time clock;
|
|
258
|
+
* • raise msg_qbytes limit for a System V message queue above the limit in /proc/sys/kernel/msgmnb (see msgop(2) and msgctl(2));
|
|
259
|
+
* • allow the RLIMIT_NOFILE resource limit on the number of "in-flight" file descriptors to be bypassed when passing file descriptors to another process via a UNIX domain socket (see unix(7));
|
|
260
|
+
* • override the /proc/sys/fs/pipe-size-max limit when setting the capacity of a pipe using the F_SETPIPE_SZ fcntl(2) command;
|
|
261
|
+
* • use F_SETPIPE_SZ to increase the capacity of a pipe above the limit specified by /proc/sys/fs/pipe-max-size;
|
|
262
|
+
* • override /proc/sys/fs/mqueue/queues_max, /proc/sys/fs/mqueue/msg_max, and /proc/sys/fs/mqueue/msgsize_max limits when creating POSIX message queues (see mq_overview(7));
|
|
263
|
+
* • employ the prctl(2) PR_SET_MM operation;
|
|
264
|
+
* • set /proc/pid/oom_score_adj to a value lower than the value last set by a process with CAP_SYS_RESOURCE.
|
|
265
|
+
*/
|
|
266
|
+
ContainerCapability["SYS_RESOURCE"] = "SYS_RESOURCE";
|
|
267
|
+
/**
|
|
268
|
+
* Set system clock (settimeofday(2), stime(2), adjtimex(2));
|
|
269
|
+
* set real-time (hardware) clock.
|
|
270
|
+
*/
|
|
271
|
+
ContainerCapability["SYS_TIME"] = "SYS_TIME";
|
|
272
|
+
/**
|
|
273
|
+
* Use vhangup(2); employ various privileged ioctl(2) operations on virtual terminals.
|
|
274
|
+
*/
|
|
275
|
+
ContainerCapability["SYS_TTY_CONFIG"] = "SYS_TTY_CONFIG";
|
|
276
|
+
/**
|
|
277
|
+
* • Perform privileged syslog(2) operations. See syslog(2) for information on which operations require privilege.
|
|
278
|
+
* • View kernel addresses exposed via /proc and other interfaces when /proc/sys/kernel/kptr_restrict has the value 1. (See the discussion of the kptr_restrict in proc(5).)
|
|
279
|
+
* (since Linux 2.6.37)
|
|
280
|
+
*/
|
|
281
|
+
ContainerCapability["SYSLOG"] = "SYSLOG";
|
|
282
|
+
/**
|
|
283
|
+
* Trigger something that will wake up the system (set CLOCK_REALTIME_ALARM and CLOCK_BOOTTIME_ALARM timers).
|
|
284
|
+
* (since Linux 3.0)
|
|
285
|
+
*/
|
|
286
|
+
ContainerCapability["WAKE_ALARM"] = "WAKE_ALARM";
|
|
287
|
+
})(ContainerCapability || (ContainerCapability = {}));
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|