Skip to content

Commit bb1fa83

Browse files
committed
Merge branch 'main' of github.com:liquidweb/docker-machine-driver-liquidweb into main
2 parents ad5edc6 + 670fcd3 commit bb1fa83

File tree

1 file changed

+74
-1
lines changed

1 file changed

+74
-1
lines changed

README.md

Lines changed: 74 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,83 @@ docker06 - liquidweb Running tcp://209.59.129.37:2376 v20
3131
user@host $
3232
```
3333

34+
### Set Liquid Web API Credentials
35+
36+
```shell
37+
export LW_USERNAME='username'
38+
export LW_PASSWORD='password'
39+
```
40+
41+
These alternatively can be given as an argument to `docker-machine` (`--lw-username` and `--lw-password`)
42+
3443
### Starting/Stopping/Restarting machines
3544

36-
docker-machine allows you to perform basic actions on a compute resource. Below has an example of a graceful restart.
45+
docker-machine allows you to perform basic actions on a compute resource. For example starting, stopping, and restarting is all supported. See `docker-machine help` for more options.
3746

3847
```shell
3948
docker-machine {restart|start|stop} docker01
4049
```
50+
51+
### Spinning up a new compute node
52+
53+
Create a new compute node with template `UBUNTU_2004_UNMANAGED` (overriding the default)
54+
55+
```shell
56+
user@host $ docker-machine create docker04 --driver liquidweb --lw-template UBUNTU_2004_UNMANAGED --lw-zone-id 12
57+
Running pre-create checks...
58+
(docker04) Generating a random root password...
59+
Creating machine...
60+
(docker04) Creating liquidweb machine instance...
61+
(docker04) Created liquidweb instance with uniq_id [KRGV3V]
62+
(docker04) Waiting for machine to become ready..
63+
(docker04) node [KRGV3V] has become ready
64+
(docker04) Machine has become ready..
65+
(docker04) Discovered IP address [50.28.32.147] for uniq_id [KRGV3V]
66+
Waiting for machine to be running, this may take a few minutes...
67+
Detecting operating system of created instance...
68+
Waiting for SSH to be available...
69+
Detecting the provisioner...
70+
Provisioning with ubuntu(systemd)...
71+
Installing Docker...
72+
Copying certs to the local machine directory...
73+
Copying certs to the remote machine...
74+
Setting Docker configuration on the remote daemon...
75+
Error creating machine: Error running provisioning: Unable to verify the Docker daemon is listening: Maximum number of retries (10) exceeded
76+
user@host $
77+
```
78+
79+
If you get an error like above, you can retry the docker installation:
80+
81+
```shell
82+
user@host $ docker-machine provision docker04
83+
Waiting for SSH to be available...
84+
Detecting the provisioner...
85+
Installing Docker...
86+
Copying certs to the local machine directory...
87+
Copying certs to the remote machine...
88+
Setting Docker configuration on the remote daemon...
89+
user@host $
90+
```
91+
92+
Once successful, you should see the node status as `READY`:
93+
94+
```shell
95+
user@host $ docker-machine ls
96+
NAME ACTIVE DRIVER STATE URL SWARM DOCKER ERRORS
97+
docker01 - liquidweb Running tcp://50.28.52.211:2376 v20.10.3
98+
docker04 - liquidweb Running tcp://50.28.32.147:2376 v20.10.3
99+
user@host $
100+
```
101+
102+
### Deleting a compute node
103+
104+
```shell
105+
user@host $ docker-machine rm docker05
106+
About to remove docker05
107+
WARNING: This action will delete both local reference and remote instance.
108+
Are you sure? (y/n): y
109+
(docker05) removing liquidweb compute node [DTHPDU]...
110+
Successfully removed docker05
111+
user@host $
112+
113+
```

0 commit comments

Comments
 (0)