Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/OneGet/MicrosoftDockerProvider

Provider to search, save and install Docker
https://github.com/OneGet/MicrosoftDockerProvider

Last synced: 4 months ago
JSON representation

Provider to search, save and install Docker

Awesome Lists containing this project

README 

        
## IMPORTANT - THIS PROVIDER IS NOW DEPRECATED

As of May 23rd 2023 the backing service for this provider has been shutdown. You can find alternative options at Windows Container Documentation - Setup Environment.



For more information on the deprecation  please see the following blog posts:

[Updates to the Windows Container Runtime support](https://techcommunity.microsoft.com/t5/containers/updates-to-the-windows-container-runtime-support/ba-p/2788799)

[Reminder - Updates to Windows Container Runtime Support](https://techcommunity.microsoft.com/t5/containers/reminder-updates-to-windows-container-runtime-support/ba-p/3620989)



In the near future this repo will be marked archived. 



#### Preserving the original  readme contents:



---



### Introduction

#### Install a Docker image from the online Package repository



The Docker installer for Windows is now available in an online package repository.  They can be found and installed using the Docker provider of PackageManagement (a.k.a. OneGet) PowerShell module.  **The provider needs to be installed before using it.** The following PowerShell cmdlets can be used to install the provider.



##### Step 1: Install the OneGet docker provider



1. `Import-Module -Name DockerMsftProvider -Force`

2. `Import-Packageprovider -Name DockerMsftProvider -Force`



##### Step 2: Install Docker

*New installation:*  

`Install-Package -Name docker -ProviderName DockerMsftProvider -Verbose`  



*Upgrade to the latest version of docker:*  

`Install-Package -Name docker -ProviderName DockerMsftProvider -Verbose -Update`



Once the provider is installed and imported, you can search, download, or install Docker using OneGet PowerShell cmdlets:

* Find-Package

* Save-Package

* Install-Package

* Uninstall-Package

* Get-Package



#### Register a source



##### Register an URL to be used with DockerMsftProvider

	Register-PackageSource -ProviderName DockerMsftProvider -Name AlternateSource -Location https://contoso.com/metaData.json



##### Enlist all the registered sources

	Get-PackageSource -ProviderName DockerMsftProvider



#### Search a Docker installer 



##### Example 1: Find the latest version of all available Docker installers. 

	Find-Package -providerName DockerMsftProvider

   

##### Example 2: Search by version, according to -RequiredVersion, -MinimumVersion, and -MaximumVersion requirements. With -AllVersions parameter, all available versions of Docker installers are returned. Without it, only the latest version is returned.

    Find-Package -providerName DockerMsftProvider -AllVersions



#### Install docker



##### Example 1: Install the latest version of docker to the local machine.

	Install-Package -Name docker -ProviderName DockerMsftProvider -Verbose



##### Example 2: Install docker with pipeline result from the search cmdlets.	

	Find-Package -ProviderName DockerMsftProvider | Install-Package -Verbose



#### Download Docker

You can download and save Docker installer without installation, using Save-Package. This cmdlet accepts pipeline result from the search cmdlets. If you have multiple sources, please provide the source for download.



##### Example 1: Download and save Docker installer to a directory that matches the wildcard path. The latest version will be saved if you do not specify the version requirements.	

	Save-Package -ProviderName DockerMsftProvider -Name Docker -Path .\temp -MinimumVersion 1.2.3



##### Example 2: Download and save Docker installer from the search cmdlets.

	Find-package -ProviderName DockerMsftProvider | Save-Package -Path .



#### Get docker



##### Example 1: Inventory docker installation on the local machine.

	 Get-Package -ProviderName DockerMsftProvider



#### Uninstall docker

Uninstalls Docker from the local machine.



##### Example 1: Uninstall docker from the local machine.

	Uninstall-Package -ProviderName DockerMsftProvider -Name dOcKeR -Verbose



#### Update docker

Updates current installation of docker with the requested version



##### Example 1: Update docker

	Install-Package -Name docker -ProviderName DockerMsftProvider -Verbose -Update



### Manual Steps

    Once docker is installed, you will need to restart the machine

    After the machine is restarted, docker service needs to be in the running state

	

	After you have installed the required KB (KB3176936 or higher) you will need to restart the machine 



### Version

1.0.0.8



### Version History



#### 0.1.0.0

	Initial release



#### 0.1.0.1

	Bug fixes



#### 0.1.0.2

	Bug fixes



#### 0.1.0.3

	Bug fixes



#### 1.0.0.0

	Public release



#### 1.0.0.1

	Added OS version check instead of KB check



#### 1.0.0.2

	Updated the restart message after install

	Update the logging while uninstall

	

#### 1.0.0.6

	Fixed a bug in how dockerd was being registered as a service



#### 1.0.0.7

	Fixed a bug where system env vars would be mangled when installing/uninstalling Docker on top of another.

	Fixed readme instruction formatting for easier copy/paste/execute



#### 1.0.0.8

	Fixed a bug where installation of Docker fails over a slow network connection.

	Added more helpful error text towards failed installation attempts on Windows 10 client machines.



### Dependencies

* 1. Nuget binaries

* 2. Update: KB3176936 or later needs to be installed on your machine



### Not supported scenarios

* 1. We use BITs for downloading purposes. Currently the following scenarios are not supported by BITs:

	* 1.1. Behind a proxy

	* 1.2. Powershell Direct

	* 1.3. SSH remoting

	* Note: Please use WinRM based Powershell Remoting.