DockerAliases Class

Summary

Contains functionality for working with Docker commands. Contains functionality for working with manifest annotate command. Contains functionality for working with manifest create command. Contains functionality for working with manifest inspect command. Contains functionality for working with manifest push command.
Assembly
Cake.Docker.dll
Namespace
Cake.Docker
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["DockerAliases"] class Type type-node

Syntax

public static class DockerAliases

Attributes

Type Description
CakeAliasCategoryAttribute

Methods

Name Value Summary
DockerBuild(ICakeContext, DockerImageBuildSettings, string) void
Builds an image given settings.
static
DockerBuild(ICakeContext, string) void
Builds an image using default settings.
static
DockerBuildXBake(ICakeContext, DockerBuildXBakeSettings, IEnumerable<string>) void
Build from a file given settings.
static
DockerBuildXBake(ICakeContext, IEnumerable<string>) void
Build from a file using default settings.
static
DockerBuildXBuild(ICakeContext, DockerBuildXBuildSettings, string) void
Start a build given settings.
static
DockerBuildXBuild(ICakeContext, string) void
Start a build using default settings.
static
DockerBuildXCreate(ICakeContext, DockerBuildXCreateSettings, string) void
Create a new builder instance given settings.
static
DockerBuildXCreate(ICakeContext, string) void
Create a new builder instance using default settings.
static
DockerBuildXDu(ICakeContext, DockerBuildXDuSettings) IEnumerable<string>
Disk usage given settings.
static
DockerBuildXImageToolsCreate(ICakeContext, DockerBuildXImageToolsCreateSettings, IEnumerable<string>) void
Create a new image based on source images given settings.
static
DockerBuildXImageToolsCreate(ICakeContext, IEnumerable<string>) void
Create a new image based on source images using default settings.
static
DockerBuildXImageToolsInspect(ICakeContext, DockerBuildXImageToolsInspectSettings, string) IEnumerable<string>
Show details of image in the registry given settings.
static
DockerBuildXImageToolsInspect(ICakeContext, string) IEnumerable<string>
Show details of image in the registry using default settings..
static
DockerBuildXInspect(ICakeContext, DockerBuildXInspectSettings, string) IEnumerable<string>
Inspect current builder instance given settings.
static
DockerBuildXInspect(ICakeContext, string) IEnumerable<string>
Inspect current builder instance using default settings..
static
DockerBuildXInstall(ICakeContext) void
Install buildx as a ‘docker builder’ alias.
static
DockerBuildXLs(ICakeContext, DockerBuildXLsSettings) IEnumerable<string>
List images given settings.
static
DockerBuildXPrune(ICakeContext, DockerBuildXPruneSettings) void
Remove build cache.
static
DockerBuildXRm(ICakeContext, DockerBuildXRmSettings, string) void
Remove a builder instance given settings.
static
DockerBuildXRm(ICakeContext, string) void
Remove a builder instance using default settings.
static
DockerBuildXStop(ICakeContext, DockerBuildXStopSettings, string) void
Stop builder instance given settings.
static
DockerBuildXStop(ICakeContext, string) void
Stop builder instance using default settings.
static
DockerBuildXUninstall(ICakeContext) void
Uninstall the ‘docker builder’ alias.
static
DockerBuildXUse(ICakeContext, DockerBuildXUseSettings, string) void
Set the current builder instance given settings.
static
DockerBuildXUse(ICakeContext, string) void
Set the current builder instance using default settings.
static
DockerBuildXVersion(ICakeContext, DockerBuildXVersionSettings) IEnumerable<string>
List images given settings.
static
DockerComposeBuild(ICakeContext, DockerComposeBuildSettings, string[]) void
Runs docker-compose build given settings.
static
DockerComposeBuild(ICakeContext, string[]) void
Runs docker-compose build with default settings.
static
DockerComposeCp(ICakeContext, string, string) void
Runs docker compose cp with default settings.
static
DockerComposeCp(ICakeContext, string, string, DockerComposeCpSettings) void
Copy files from/to container given settings.
static
DockerComposeCreate(ICakeContext, DockerComposeCreateSettings, string[]) void
Runs docker-compose create given settings.
static
DockerComposeCreate(ICakeContext, string[]) void
Runs docker-compose create with default settings.
static
DockerComposeDown(ICakeContext) void
Runs docker-compose down with default settings.
static
DockerComposeDown(ICakeContext, DockerComposeDownSettings) void
Runs docker-compose down given settings.
static
DockerComposeExec(ICakeContext, DockerComposeExecSettings, string, string, string[]) void
Runs docker-compose exec given settings.
static
DockerComposeExec(ICakeContext, string, string, string[]) void
Runs docker-compose exec with default settings.
static
DockerComposeKill(ICakeContext) void
Runs docker-compose kill with default settings.
static
DockerComposeKill(ICakeContext, DockerComposeKillSettings) void
Runs docker-compose kill given settings.
static
DockerComposeLogs(ICakeContext) IEnumerable<string>
Runs docker-compose logs with default settings.
static
DockerComposeLogs(ICakeContext, DockerComposeLogsSettings) IEnumerable<string>
Runs docker-compose logs given settings.
static
DockerComposePause(ICakeContext, DockerComposeSettings, string[]) void
Runs docker-compose pause.
static
DockerComposePause(ICakeContext, string[]) void
Runs docker-compose pause with default settings.
static
DockerComposePort(ICakeContext, DockerComposePortSettings, string, int) IEnumerable<string>
Runs docker-compose port.
static
DockerComposePort(ICakeContext, string, int) void
Runs docker-compose port with default settings.
static
DockerComposePs(ICakeContext, DockerComposePsSettings, string[]) IEnumerable<string>
Runs docker-compose ps.
static
DockerComposePs(ICakeContext, string[]) void
Runs docker-compose ps with default settings.
static
DockerComposePull(ICakeContext, DockerComposePullSettings, string[]) void
Runs docker-compose pull given settings.
static
DockerComposePull(ICakeContext, string[]) void
Runs docker-compose pull with default settings.
static
DockerComposePush(ICakeContext, DockerComposePushSettings, string[]) void
Runs docker-compose push given settings.
static
DockerComposePush(ICakeContext, string[]) void
Runs docker-compose push with default settings.
static
DockerComposeRestart(ICakeContext, DockerComposeRestartSettings, string[]) void
Runs docker-compose restart given settings.
static
DockerComposeRestart(ICakeContext, string[]) void
Runs docker-compose restart with default settings.
static
DockerComposeRm(ICakeContext, DockerComposeRmSettings, string[]) void
Runs docker-compose rm given settings.
static
DockerComposeRm(ICakeContext, string[]) void
Runs docker-compose rm with default settings.
static
DockerComposeRun(ICakeContext, DockerComposeRunSettings, string, string, string[]) void
Runs docker-compose run given settings.
static
DockerComposeRun(ICakeContext, DockerComposeRunSettings, string, string[]) void
Runs docker-compose run given settings.
static
DockerComposeRun(ICakeContext, string, string, string[]) void
Runs docker-compose run with default settings.
static
DockerComposeRun(ICakeContext, string, string[]) void
Runs docker-compose run with default settings.
static
DockerComposeScale(ICakeContext, DockerComposeSettings, string[]) void
Runs docker-compose scale.
static
DockerComposeScale(ICakeContext, string[]) void
Runs docker-compose scale with default settings.
static
DockerComposeStart(ICakeContext, DockerComposeSettings, string[]) void
Runs docker-compose start.
static
DockerComposeStart(ICakeContext, string[]) void
Runs docker-compose start with default settings.
static
DockerComposeStop(ICakeContext, DockerComposeBuildSettings, string[]) void
Runs docker-compose stop given settings.
static
DockerComposeStop(ICakeContext, string[]) void
Runs docker-compose stop with default settings.
static
DockerComposeUnpause(ICakeContext, DockerComposeSettings, string[]) void
Runs docker-compose unpause.
static
DockerComposeUnpause(ICakeContext, string[]) void
Runs docker-compose unpause with default settings.
static
DockerComposeUp(ICakeContext, DockerComposeUpSettings, string[]) void
Runs docker-compose up given settings.
static
DockerComposeUp(ICakeContext, string[]) void
Runs docker-compose up with default settings.
static
DockerContainerLs(ICakeContext, DockerContainerLsSettings) IEnumerable<string>
List containers given settings.
static
DockerCp(ICakeContext, string, string) void
Copy files from/to using default settings.
static
DockerCp(ICakeContext, string, string, DockerContainerCpSettings) void
Copy files from/to container given settings.
static
DockerCreate(ICakeContext, DockerContainerCreateSettings, string, string, string[]) string
Creates a new container given settings.
static
DockerCreate(ICakeContext, string, string, string[]) string
Creates a new container using default settings.
static
DockerCustomCommand(ICakeContext, DockerCustomCommandSettings, string) IEnumerable<string>
Run a custom docker command
static
DockerCustomCommand(ICakeContext, string) IEnumerable<string>
Run a custom docker command
static
DockerExec(ICakeContext, DockerContainerExecSettings, string, string, string[]) void
Execs a command using given settings.
static
DockerExec(ICakeContext, string, string, string[]) void
Execs a command using default settings.
static
DockerImageLs(ICakeContext, DockerImageLsSettings) IEnumerable<string>
List images given settings.
static
DockerImagePrune(ICakeContext) IEnumerable<string>
Remove unused images.
static
DockerImagePrune(ICakeContext, DockerImagePruneSettings) IEnumerable<string>
Remove unused images given settings.
static
DockerLoad(ICakeContext, DockerImageLoadSettings) void
Load an image from a tar archive or STDIN.
static
DockerLogin(ICakeContext, DockerRegistryLoginSettings, string) void
Register or log in to a Docker registry. If no server is specified, the docker engine default is used.
static
DockerLogin(ICakeContext, string, string, string) void
Register or log in to a Docker registry. If no server is specified, the docker engine default is used.
static
DockerLogout(ICakeContext, DockerRegistryLogoutSettings, string) void
Logout from a Docker registry. If no server is specified, the docker engine default is used.
static
DockerLogout(ICakeContext, string) void
Logout from a Docker registry. If no server is specified, the docker engine default is used.
static
DockerLogs(ICakeContext, DockerContainerLogsSettings, string) IEnumerable<string>
Logs container using the given settings.
static
DockerLogs(ICakeContext, string) IEnumerable<string>
Logs container using default settings.
static
DockerManifestAnnotate(ICakeContext, DockerManifestAnnotateSettings, string, string) void
Add additional information to a local image manifest
static
DockerManifestAnnotate(ICakeContext, string, string) void
Add additional information to a local image manifest
static
DockerManifestCreate(ICakeContext, DockerManifestCreateSettings, string, string, string[]) void
Create a local manifest list for annotating and pushing to a registry
static
DockerManifestCreate(ICakeContext, string, string, string[]) void
Create a local manifest list for annotating and pushing to a registry
static
DockerManifestInspect(ICakeContext, DockerManifestInspectSettings, string, string) void
Display an image manifest, or manifest list
static
DockerManifestInspect(ICakeContext, string) void
Display an image manifest, or manifest list
static
DockerManifestInspect(ICakeContext, string, string) void
Display an image manifest, or manifest list
static
DockerManifestPush(ICakeContext, DockerManifestPushSettings, string) void
Push a manifest list to a repository
static
DockerManifestPush(ICakeContext, string) void
Push a manifest list to a repository
static
DockerNetworkConnect(ICakeContext, DockerNetworkConnectSettings, string, string, string[]) void
Connects a container to a network given settings.
static
DockerNetworkConnect(ICakeContext, string, string, string[]) void
Connects a container to a network using default settings.
static
DockerNetworkCreate(ICakeContext, DockerNetworkCreateSettings, string[]) void
Creates a network given settings.
static
DockerNetworkCreate(ICakeContext, string[]) void
Creates a network using default settings.
static
DockerNetworkDisconnect(ICakeContext, DockerNetworkDisconnectSettings, string[]) void
Disconnects a network given settings.
static
DockerNetworkDisconnect(ICakeContext, string[]) void
Disconnects a network using default settings.
static
DockerNetworkRemove(ICakeContext, string, string[]) void
Removes a network.
static
DockerNetworkRemove(ICakeContext, string[], string[]) void
Removes networks.
static
DockerPs(ICakeContext, DockerContainerPsSettings) string
List containers given settings.
static
DockerPull(ICakeContext, DockerImagePullSettings, string) void
Pull an image or a repository from the registry with given settings.
static
DockerPull(ICakeContext, string) void
Pull an image or a repository from the registry.
static
DockerPush(ICakeContext, DockerImagePushSettings, string) void
Push an image or a repository to the registry with given settings.
static
DockerPush(ICakeContext, string) void
Push an image or a repository to the registry.
static
DockerRemove(ICakeContext, DockerImageRemoveSettings, string[]) void
Removes an array of images using the give settings.
static
DockerRm(ICakeContext, DockerContainerRmSettings, string[]) void
Removes an array of containers using the given .
static
DockerRm(ICakeContext, string[]) void
Removes an array of containers using default settings.
static
DockerRmi(ICakeContext, string[]) void
Removes an array of images using default settings.
static
DockerRun(ICakeContext, DockerContainerRunSettings, string, string, string[]) string
Creates a new container given settings.
static
DockerRun(ICakeContext, string, string, string[]) string
Creates a new container using default settings.
static
DockerRunWithoutResult(ICakeContext, DockerContainerRunSettings, string, string, string[]) void
Creates a new container given settings and doesn't return the output like Cake.Docker.DockerAliases.DockerRun(Cake.Core.ICakeContext,Cake.Docker.DockerContainerRunSettings,System.String,System.String,System.String[]) does. This way one can capture stdout.
static
DockerRunWithoutResult(ICakeContext, string, string, string[]) void
Creates a new container using default settings. and doesn't return the output like Cake.Docker.DockerAliases.DockerRun(Cake.Core.ICakeContext,System.String,System.String,System.String[]) does. This way one can capture stdout.
static
DockerSave(ICakeContext, DockerImageSaveSettings, string[]) void
Save one or more images to a tar archive (streamed to STDOUT by default).
static
DockerStart(ICakeContext, DockerContainerStartSettings, string[]) void
Starts an array of containers using the give settings.
static
DockerStart(ICakeContext, string[]) void
Starts an array of containers using default settings.
static
DockerStop(ICakeContext, DockerContainerStopSettings, string[]) void
Stops an array of containers using the give settings.
static
DockerStop(ICakeContext, string[]) void
Stops an array of containers using default settings.
static
DockerSwarmInit(ICakeContext, DockerSwarmInitSettings, string[]) void
Initializes a swarm given settings.
static
DockerSwarmInit(ICakeContext, string[]) void
Initializes a swarm using default settings.
static
DockerSwarmJoin(ICakeContext, DockerSwarmJoinSettings, string[]) void
Joins a swarm given settings.
static
DockerSwarmJoin(ICakeContext, string[]) void
Joins a swarm using default settings.
static
DockerSwarmLeave(ICakeContext, DockerSwarmLeaveSettings, string[]) void
Leaves a swarm given settings.
static
DockerSwarmLeave(ICakeContext, string[]) void
Leaves a swarm using default settings.
static
DockerSwarmUpdate(ICakeContext, DockerSwarmUpdateSettings, string[]) void
Updates a swarm given settings.
static
DockerSwarmUpdate(ICakeContext, string[]) void
Updates a swarm using default settings.
static
DockerTag(ICakeContext, string, string) void
Tag an image into a repository.
static
DockerVolumeCreate(ICakeContext, DockerVolumeCreateSettings, string) void
Runs docker volume create given settings.
static
DockerVolumeCreate(ICakeContext, string) void
Runs docker volume create with default settings.
static
DockerVolumeInspect(ICakeContext, DockerVolumeInspectSettings, string[]) IEnumerable<string>
Display detailed information on one or more volumes given settings.
static
DockerVolumeInspect(ICakeContext, string[]) IEnumerable<string>
Display detailed information on one or more volumes.
static
DockerVolumeLs(ICakeContext, DockerVolumeLsSettings) IEnumerable<string>
List volumes given settings.
static
DockerVolumePrune(ICakeContext, DockerVolumePruneSettings) void
Remove all unused local volumes given settings.
static
DockerVolumeRm(ICakeContext, DockerVolumeRmSettings, string[]) void
Remove one or more volumes given settings.
static
DockerVolumeRm(ICakeContext, string[]) void
Remove one or more volumes.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin