Skip to content

Commit b409564

Browse files
committed
Add docker-machine setup; Fix typo
1 parent c7bf1c8 commit b409564

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,34 @@ The Public API will run on `$(docker-machine ip):8082`
209209

210210
#### To run the entire platform
211211

212+
1. Dedicate appropriate resources to your Docker environment. We've found
213+
that for the full stack to run efficiently, you need approximately:
214+
215+
* 4 CPUs
216+
* 6 GB RAM
217+
* 80 GB Disk space
218+
219+
Assuming you are using Docker Machine to provision your Docker
220+
environment, you can check you current settings with (ignore the
221+
second `Memory`):
222+
223+
$ docker-machine inspect | grep 'CPU\|Memory\|DiskSize'
224+
"CPU": 4,
225+
"Memory": 6144,
226+
"DiskSize": 81920,
227+
"Memory": 0,
228+
229+
If your settings are _below_ these suggestions, you should create a new
230+
Docker VM. The following will create a _machine_ named `hmda-platform`
231+
with the appropriate resources:
232+
233+
$ docker-machine create \
234+
--driver virtualbox \
235+
--virtualbox-disk-size 81920 \
236+
--virtualbox-cpu-count 4 \
237+
--virtualbox-memory 6144 \
238+
hmda-platform
239+
212240
1. Clone [hmda-platform-ui](https://github.com/cfpb/hmda-platform-ui) and
213241
[hmda-platform-auth](https://github.com/cfpb/hmda-platform-auth) into the same
214242
directory as hmda-platform.
@@ -237,7 +265,7 @@ The Public API will run on `$(docker-machine ip):8082`
237265

238266
This will bring up all the HMDA Platform services. The first run may take several minutes.
239267

240-
1. Discover you Docker host's IP
268+
1. Discover your Docker host's IP
241269

242270
echo $DOCKER_HOST
243271

0 commit comments

Comments
 (0)