mirror of https://github.com/docker/compose.git
Merge pull request #647 from docker/update-install-doc
Update install doc
This commit is contained in:
commit
55edd156aa
19
INSTALL.md
19
INSTALL.md
|
@ -1,6 +1,6 @@
|
||||||
# Mac and Windows installation
|
# Mac and Windows installation
|
||||||
|
|
||||||
The ACI integration is built into Docker Desktop **Edge**.
|
The Compose CLI is built into Docker Desktop Edge and Stable.
|
||||||
You can download it from these links:
|
You can download it from these links:
|
||||||
- [macOS](https://hub.docker.com/editions/community/docker-ce-desktop-mac)
|
- [macOS](https://hub.docker.com/editions/community/docker-ce-desktop-mac)
|
||||||
- [Windows](https://hub.docker.com/editions/community/docker-ce-desktop-windows)
|
- [Windows](https://hub.docker.com/editions/community/docker-ce-desktop-windows)
|
||||||
|
@ -16,7 +16,7 @@ with a fresh install of Ubuntu 20.04.
|
||||||
|
|
||||||
## Install script
|
## Install script
|
||||||
|
|
||||||
You can install the new CLI using the install script:
|
You can install the Compose CLI using the install script:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
curl -L https://raw.githubusercontent.com/docker/compose-cli/main/scripts/install_linux.sh | sh
|
curl -L https://raw.githubusercontent.com/docker/compose-cli/main/scripts/install_linux.sh | sh
|
||||||
|
@ -24,12 +24,13 @@ curl -L https://raw.githubusercontent.com/docker/compose-cli/main/scripts/instal
|
||||||
|
|
||||||
## Manual install
|
## Manual install
|
||||||
|
|
||||||
You can download the Docker ACI Integration CLI from [latest release](https://github.com/docker/compose-cli/releases/latest).
|
You can download the Compose CLI from [latest release](https://github.com/docker/compose-cli/releases/latest).
|
||||||
|
|
||||||
You will then need to make it executable:
|
You will then need to extract it and make it executable:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
chmod +x docker-aci
|
$ tar xzf docker-linux-amd64.tar.gz
|
||||||
|
$ chmod +x docker/docker
|
||||||
```
|
```
|
||||||
|
|
||||||
To enable using the local Docker Engine and to use existing Docker contexts, you
|
To enable using the local Docker Engine and to use existing Docker contexts, you
|
||||||
|
@ -61,14 +62,14 @@ You can verify that this is working by checking that the new CLI works with the
|
||||||
default context:
|
default context:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ ./docker-aci --context default ps
|
$ ./docker/docker --context default ps
|
||||||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
||||||
$ echo $?
|
$ echo $?
|
||||||
0
|
0
|
||||||
```
|
```
|
||||||
|
|
||||||
To make this CLI with ACI integration your default Docker CLI, you must move it
|
To make the Compose CLI your default Docker CLI, you must move it to a directory
|
||||||
to a directory in your `PATH` with higher priority than the existing Docker CLI.
|
in your `PATH` with higher priority than the existing Docker CLI.
|
||||||
|
|
||||||
Again on a fresh Ubuntu 20.04:
|
Again on a fresh Ubuntu 20.04:
|
||||||
|
|
||||||
|
@ -77,7 +78,7 @@ $ which docker
|
||||||
/usr/bin/docker
|
/usr/bin/docker
|
||||||
$ echo $PATH
|
$ echo $PATH
|
||||||
/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin
|
/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin
|
||||||
$ sudo mv docker-aci /usr/local/bin/docker
|
$ sudo mv docker/docker /usr/local/bin/docker
|
||||||
$ which docker
|
$ which docker
|
||||||
/usr/local/bin/docker
|
/usr/local/bin/docker
|
||||||
$ docker version
|
$ docker version
|
||||||
|
|
|
@ -1,97 +0,0 @@
|
||||||
# Installing the Docker ACI Integration CLI on Linux (Beta)
|
|
||||||
|
|
||||||
This CLI adds support for running and managing containers on Azure Container
|
|
||||||
Instances (ACI).
|
|
||||||
|
|
||||||
> :warning: **This CLI is in beta**: The installation process, commands, and
|
|
||||||
> flags will change in future releases.
|
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
* [Docker 19.03 or later](https://docs.docker.com/get-docker/)
|
|
||||||
|
|
||||||
## Install script
|
|
||||||
|
|
||||||
You can install the new CLI using the install script:
|
|
||||||
|
|
||||||
```console
|
|
||||||
curl -L https://github.com/docker/aci-integration-beta/releases/download/v0.1.4/install.sh | sh
|
|
||||||
```
|
|
||||||
|
|
||||||
## Manual install
|
|
||||||
|
|
||||||
You can download the Docker ACI Integration CLI using the following command:
|
|
||||||
|
|
||||||
```console
|
|
||||||
curl -Lo docker-aci https://github.com/docker/aci-integration-beta/releases/download/v0.1.4/docker-linux-amd64
|
|
||||||
```
|
|
||||||
|
|
||||||
You will then need to make it executable:
|
|
||||||
|
|
||||||
```console
|
|
||||||
chmod +x docker-aci
|
|
||||||
```
|
|
||||||
|
|
||||||
To enable using the local Docker Engine and to use existing Docker contexts, you
|
|
||||||
will need to have the existing Docker CLI as `com.docker.cli` somewhere in your
|
|
||||||
`PATH`. You can do this by creating a symbolic link from the existing Docker
|
|
||||||
CLI.
|
|
||||||
|
|
||||||
```console
|
|
||||||
ln -s /path/to/existing/docker /directory/in/PATH/com.docker.cli
|
|
||||||
```
|
|
||||||
|
|
||||||
> **Note**: The `PATH` environment variable is a colon separated list of
|
|
||||||
> directories with priority from left to right. You can view it using
|
|
||||||
> `echo $PATH`. You can find the path to the existing Docker CLI using
|
|
||||||
> `which docker`. You may need root permissions to make this link.
|
|
||||||
|
|
||||||
On a fresh install of Ubuntu 20.04 with Docker Engine
|
|
||||||
[already installed](https://docs.docker.com/engine/install/ubuntu/):
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ echo $PATH
|
|
||||||
/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin
|
|
||||||
$ which docker
|
|
||||||
/usr/bin/docker
|
|
||||||
$ sudo ln -s /usr/bin/docker /usr/local/bin/com.docker.cli
|
|
||||||
```
|
|
||||||
|
|
||||||
You can verify that this is working by checking that the new CLI works with the
|
|
||||||
default context:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ ./docker-aci --context default ps
|
|
||||||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
|
||||||
$ echo $?
|
|
||||||
0
|
|
||||||
```
|
|
||||||
|
|
||||||
To make this CLI with ACI integration your default Docker CLI, you must move it
|
|
||||||
to a directory in your `PATH` with higher priority than the existing Docker CLI.
|
|
||||||
|
|
||||||
Again on a fresh Ubuntu 20.04:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ which docker
|
|
||||||
/usr/bin/docker
|
|
||||||
$ echo $PATH
|
|
||||||
/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin
|
|
||||||
$ sudo mv docker-aci /usr/local/bin/docker
|
|
||||||
$ which docker
|
|
||||||
/usr/local/bin/docker
|
|
||||||
$ docker version
|
|
||||||
...
|
|
||||||
Cloud integration 0.1.6
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
## Uninstall
|
|
||||||
|
|
||||||
To remove this CLI, you need to remove the binary you downloaded and
|
|
||||||
`com.docker.cli` from your `PATH`. If you installed using the script, this can
|
|
||||||
be done as follows:
|
|
||||||
|
|
||||||
```console
|
|
||||||
sudo rm /usr/local/bin/docker /usr/local/bin/com.docker.cli
|
|
||||||
```
|
|
Loading…
Reference in New Issue