Containers-Toolkit 0.0.0-beta

CONTAINERS TOOLKIT POWERSHELL MODULE

Table of contents

1. Introduction
2. Prerequisites
3. Installation and Setup
4. Usage
5. Important Notes
6. FAQs
7. Contribution

Introduction

Containers-Toolkit is a Windows PowerShell module for downloading, installing, and configuring Containerd, Buildkit, nerdctl, and Windows CNI plugins for container networks. It also allows you to get a list of the container tools and their installation statuses.

Configurations done with these functions are default configurations that allow you to get started with interacting with the tools. Further configurations may be necessary.

You can find documentation for these functions here: Containers-Toolkit Documentation

Prerequisites

1. PowerShell: Minimum Version 7

2. HNS module

   To install the HNS module, follow the instructions here

   Reference:

   • HostNetworkingService
   • Container Network Management with Host Network Service (HNS)

Installation and Setup

Install Containers-Toolkit module from PowerShell Gallery

Install-Module -Name containers-toolkit -RequiredVersion "__NEW_VERSION__"

Download signed source files

1. Download source files

   Invoke-WebRequest -Uri "https://github.com/microsoft/containers-toolkit/releases/download/__NEW_VERSION__/containers-toolkit-__NEW_VERSION__.tar.gz" -OutFile "containers-toolkit.tar.gz"
   

2. Verify the signature

   $HASH_VALUE = "__HASH_VALUE__"
   (Get-FileHash -Algorithm SHA256 containers-toolkit.tar.gz).Hash -eq $HASH_VALUE
   

3. Expand the tar file

   $ModulePath = "$env:USERPROFILE\Documents\WindowsPowerShell\Modules"
   if (!(Test-Path -Path $ModulePath)) {
       New-Item -ItemType Directory -Path $ModulePath | Out-Null
   }
   tar.exe -xvf containers-toolkit.tar.gz -C $ModulePath
   Remove-Item -Path containers-toolkit.tar.gz -Force
   

4. Unblock the files

   Get-ChildItem -Path $ModulePath -Recurse | Unblock-File
   

Downloading the source code from Containers-Toolkit repository

To use the module, fork/clone the repository to your local machine and setup your development environment

Usage

Get the module details

Get-Help containers-toolkit

Get-Module -Name containers-toolkit -ListAvailable

Command reference

1. List of all available commands can be found in the Command reference section
2. Detailed command reference for each cmdlet can be found in the About section

List of available commands

Get-Command -Module containers-toolkit

Examples

1. Get help for Install-Containerd command

   Get-Help Install-Containerd
   

2. List container tools (Containerd, BuildKit, and nerdctl) install status

   Show-ContainerTools
   

3. Installs Containerd version 1.7.7 at 'C:\Test\Path\containerd' and adds 'C:\Test\Path\containerd' in the environment path.

   Install-Containerd -Version "1.7.7" -InstallPath 'C:\Test\Path\Containerd'
   

Important Notes

1. Requires elevated PowerShell to run some commands.

2. To use these tools (Containerd, BuildKit, and nerdctl), ensure that Containers and HyperV Windows features are enabled.

   To get the features to enable, use:

   Get-WindowsOptionalFeature -Online | `
       Where-Object { $_.FeatureName -like 'containers' -or $_.FeatureName -match "Microsoft-Hyper-V(-All)?$" } | `
       Select-Object FeatureName, Possible, State, RestartNeeded
   

   To enable a feature:

   Enable-WindowsOptionalFeature -Online -FeatureName '<Feature-Name-Here>' -All -NoRestart
   

3. Requires PowerShell modules HNS

FAQs

Please visit the FAQs.md to see the how to resolve common issues.

Contribution

Please look into the Contribution Guide to know how to develop and contribute.

Legal and Licensing

PowerShell is licensed under the MIT license.

Code of Conduct

Please see our Code of Conduct before participating in this project.

Security Policy

For any security issues, please see our Security Policy.

Attributions

This project builds on the work of others to create a PowerShell module.

Credits (in alphabetic order):

Container tools installed with this module

• Containerd
• BuildKit
• nerdctl
• Container networking plugins for Windows containers
• Container Network Interface - networking for Linux containers