Skip to content

Commit b673a2b

Browse files
committed
Merge branch 'main' of github.com:liquidweb/docker-machine-driver-liquidweb into main
2 parents 8ed8061 + 6a2e704 commit b673a2b

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,40 @@
11
# docker-machine-driver-liquidweb
22
Liquid Web Docker machine driver
3+
4+
## Installation
5+
6+
You can grab the driver precompiled for various platforms on this projects [releases page](https://github.com/liquidweb/docker-machine-driver-liquidweb/releases).
7+
8+
## Installing from source
9+
10+
To install from source code run `make` in the root of this repository. This will install `docker-machine-driver-liquidweb` into your `${GOPATH}/bin`.
11+
12+
## Why use this?
13+
14+
If you are a [Liquid Web](https://liquidweb.com) customer with a Cloud VPS who utilizes [docker](https://docker.com) or [docker-machine](https://docs.docker.com/machine/) this tool allows you to easily spin up Liquid Web Cloud VPS servers for the compute nodes to run your containers. Rather than having to use the [Liquid Web API](https://cart.liquidweb.com/storm/api/docs/bleed), [liquidweb-cli](https://github.com/liquidweb/liquidweb-cli), or our management portal to create servers, you can use the familar framework of docker-machine. Docker-machine makes it easier to manage multiple docker hosts from your local docker client.
15+
16+
## Usage
17+
18+
This is a [docker-machine](https://docs.docker.com/machine/) driver, so make sure you have docker and docker-machine installed as a prerequisite.
19+
20+
### Listing machines
21+
22+
```shell
23+
user@host $ docker-machine ls
24+
NAME ACTIVE DRIVER STATE URL SWARM DOCKER ERRORS
25+
docker01 - liquidweb Running tcp://69.167.152.19:2376 v20.10.2
26+
docker02 - liquidweb Running tcp://209.59.138.4:2376 v20.10.2
27+
docker03 - liquidweb Running tcp://67.227.190.28:2376 v20.10.2
28+
docker04 - liquidweb Running tcp://67.225.160.31:2376 v20.10.2
29+
docker05 - liquidweb Running tcp://67.227.198.22:2376 v20.10.2
30+
docker06 - liquidweb Running tcp://209.59.129.37:2376 v20.10.2
31+
user@host $
32+
```
33+
34+
### Starting/Stopping/Restarting machines
35+
36+
docker-machine allows you to perform basic actions on a compute resource. Below has an example of a graceful restart.
37+
38+
```shell
39+
docker-machine {restart|start|stop} docker01
40+
```

0 commit comments

Comments
 (0)