Skip to content

Latest commit

 

History

History
221 lines (160 loc) · 4.42 KB

Install-ContainerTools.md

File metadata and controls

221 lines (160 loc) · 4.42 KB

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] [-OSArchitecture <string>] [-Force] [-Confirm] [-WhatIf] [<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

-Confirm

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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 install the tools even if they already exists at the specified path.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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

-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

-OSArchitecture

OS architecture to download files for. Default is $env:PROCESSOR_ARCHITECTURE

Type: String
Parameter Sets: Setup
Aliases:

Required: False
Position: Named
Default value:  $env:PROCESSOR_ARCHITECTURE
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: Setup
Aliases:

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

RELATED LINKS