Skip to content

Install-ContainerTools.md

Latest commit

 

History

History
210 lines (152 loc) · 4.08 KB

Install-ContainerTools.md

File metadata and controls

210 lines (152 loc) · 4.08 KB
Raw

external help file: containers-toolkit-help.xml Module Name: containers-toolkit online version: schema: 2.0.0

Install-ContainerTools

SYNOPSIS

Downloads and installs container tool (Containerd, BuildKit, and nerdctl).

SYNTAX

Install-ContainerTools [[-ContainerDVersion] <String>] [[-BuildKitVersion] <String>]
 [[-NerdCTLVersion] <String>] [[-InstallPath] <String>] [[-DownloadPath] <String>] [-RegisterServices]
 [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Downloads container tool (Containerd, BuildKit, and nerdctl) asynchronously and installs them at the specified location.

EXAMPLES

Example 1: Using defaults

Install the latest versions of Containerd, BuildKit, and nerdctl at the default path

PS C:\> Install-ContainerTools

Example 2: Download Containerd version 1.6.8 and default nerdctl and BuildKit versions

Download Containerd version 1.6.8 and default nerdctl and BuildKit versions

PS C:\> Install-ContainerTools -ContainerDVersion 1.6.8

Example 3: Register and Start Containerd and Buildkitd services and set up NAT network

Register and Start Containerd and Buildkitd services and set up NAT network

PS C:\> Install-ContainerTools -RegisterServices

PARAMETERS

-BuildKitVersion

BuildKit version to install

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: Latest version
Accept pipeline input: False
Accept wildcard characters: False

-ContainerDVersion

Containerd version to install

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: Latest version
Accept pipeline input: False
Accept wildcard characters: False

-DownloadPath

Path to download files. Defaults to user's Downloads folder, $HOME\Downloads

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: $HOME\Downloads
Accept pipeline input: False
Accept wildcard characters: False

-Force

Force container tools uninstallation (if it exists) without any confirmation prompts

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-InstallPath

Path to Install files. Defaults to Program Files, `$Env:ProgramFiles`

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: $Env:ProgramFiles
Accept pipeline input: False
Accept wildcard characters: False

-NerdCTLVersion

nerdctl version to install

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: Latest version
Accept pipeline input: False
Accept wildcard characters: False

-RegisterServices

Register and Start Containerd and Buildkitd services and set up NAT network.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts for confirmation before running the cmdlet. For more information, see the following articles:

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet isn't run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

RELATED LINKS