diff --git a/INSTALL.md b/INSTALL.md index bcd87a8e7d..b9ee659fac 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -117,6 +117,15 @@ To complete a deployment to OpenShift, you will obviously need access to an Open You will also need to have the `oc` command in your PATH. The `install.yml` playbook will call out to `oc` when logging into, and creating objects on the cluster. +The default resource requests per-pod requires: + +> Memory: 6GB +> CPU: 3 cores + +This can be tuned by overriding the variables found in [/installer/openshift/defaults/main.yml](/installer/openshift/defaults/main.yml). Special care should be taken when doing this as undersized instances will experience crashes and resource exhaustion. + +For more detail on how resource requests are formed see: [https://docs.openshift.com/container-platform/latest/dev_guide/compute_resources.html#dev-compute-resources](https://docs.openshift.com/container-platform/latest/dev_guide/compute_resources.html#dev-compute-resources) + #### Deploying to Minishift Install Minishift by following the [installation guide](https://docs.openshift.org/latest/minishift/getting-started/installing.html). @@ -289,6 +298,15 @@ A Kubernetes deployment will require you to have access to a Kubernetes cluster The installation program will reference `kubectl` directly. `helm` is only necessary if you are letting the installer configure PostgreSQL for you. +The default resource requests per-pod requires: + +> Memory: 6GB +> CPU: 3 cores + +This can be tuned by overriding the variables found in [/installer/kubernetes/defaults/main.yml](/installer/kubernetes[/defaults/main.yml). Special care should be taken when doing this as undersized instances will experience crashes and resource exhaustion. + +For more detail on how resource requests are formed see: [https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/) + ### Pre-build steps Before starting the build process, review the [inventory](./installer/inventory) file, and uncomment and provide values for the following variables found in the `[all:vars]` section uncommenting when necessary. Make sure the openshift and standalone docker sections are commented out: