Table of contents

1. Introduction
2. Usage
   • Importing the module
   • Command reference
3. TODO
4. Contribution
5. References

Introduction

ContainerToolsForWindows is a Windows PowerShell module for downloading, installing, and setting up default configs for Containerd, Buildkit, Windows CNI plugin, and Nerdctl.

Usage

Importing the module

Option 1

You can manually import this module using:

Import-Module -Name <absolute-path>\ContainerToolsForWindows.psd1 -Force

Option 2

---

Option 2a:

1. Aternatively, you can add it to the Windows PowerShell module path. To get the possible module paths, use:

   $env:PSModulePath

2. Move the folder to any of the paths from the above PS command

Option 2b:

1. Add the location of the module directory to $env:PSModulePath

   $env:PSModulePath += "$env:PSModulePath;<path-to-module-directory>"

2. Reload the terminal or open a new terminal

---

3. Import the module

   Import-Module -Name ContainerToolsForWindows -Force

4. Get the module details

   Get-Module -Name ContainerToolsForWindows

Command reference

1. Command reference
2. Detailed command reference can be found in the About section

TODO

• Rename this module: The current name for this module might cause confusion with repo named windows-containers-tools
• Update README.md (Documentation)
• Update ContainerToolsForWindows/ContainerToolsForWindows.Format.ps1xml (Documentation)
• Update ContainerToolsForWindows/en-US/about_ContainerToolsForWindows.help.txt (Documentation)
• Publish module to PSGallery
• Dev install: (Hacks) Add functions in Containerd and Buildkit to build from source files. (Is this really necessary? May be an overkill)
• Use latest version in download
• Add Pester test
• Pipeline configuration
• Rootless installation

Contribution

Similar Projects

• Install-ContainerdRuntime
• containerd-installer
• Install MCR on Windows Servers
• Stevedore

References

• Containerd
• Buildkit
• Nerdctl
• Container networking plugins for Windows containers