Provide guidance for Docker Compose user when hitting the CPU usage limit
Created by: jwayman
Describe the issue
There is a recommendation that was included as part of our requirements and was removed during a recent reorganization of the content.
The Docker Compose installation requires a minimum of 8 CPU cores (logical) on the host machine in order to complete successfully. If using the Docker for Windows app, the default CPU count is limited to 2 which will result in errors during installation. You can go into the Docker app Settings->Resources window to increase the CPU count to > 8 to resolve this issue.
The issue is described in the PR, but the basics are:
"We should not make hard requirement for CPU cores at all (we do the same for helm where we have a localDev flag that will remove all resources requirement)"
Where is the issue located?
docs/admin/deploy/docker-compose/index.md
Suggested resolution
From @michaellzc
either
we should remove this sentence and add a docker-compose overlay (that has zero resources requirement) for local-dev use
or ask users to run an one-off command
# this command set all `cpus` to `0`
cat docker-compose/docker-compose.yaml | yq '.services[].cpus = 0' > docker-compose/docker-compose.local-dev.yaml
docker-compose -f docker-compose/docker-compose.yaml -f docker-compose/docker-compose.local-dev.yaml up -d
this can start the entire stack without hitting CPU limit