From 7497784d5e741e273f2643b1db4868cfec545dfa Mon Sep 17 00:00:00 2001
From: kurokobo <2920259+kurokobo@users.noreply.github.com>
Date: Sat, 26 Feb 2022 23:24:08 +0900
Subject: [PATCH] feat: add hardware requirements

---
 README.md     | 20 +++++++++++++++++---
 base/awx.yaml |  2 +-
 base/pv.yaml  |  2 +-
 3 files changed, 19 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index b5b007c..69021fa 100644
--- a/README.md
+++ b/README.md
@@ -13,8 +13,9 @@ An example implementation of AWX on single node K3s using AWX Operator, with eas
 
 - [Environment](#environment)
 - [References](#references)
+- [Requirements](#requirements)
 - [Procedure](#procedure)
-  - [Prepare CentOS 8 host](#prepare-centos-8-host)
+  - [Prepare CentOS Stream 8 host](#prepare-centos-stream-8-host)
   - [Install K3s](#install-k3s)
   - [Install AWX Operator](#install-awx-operator)
   - [Prepare required files](#prepare-required-files)
@@ -44,9 +45,21 @@ An example implementation of AWX on single node K3s using AWX Operator, with eas
 - [INSTALL.md on ansible/awx](https://github.com/ansible/awx/blob/20.0.0/INSTALL.md) @20.0.0
 - [README.md on ansible/awx-operator](https://github.com/ansible/awx-operator/blob/0.17.0/README.md) @0.17.0
 
+## Requirements
+
+- **Computing resources**
+  - **2 CPUs and 4 GiB RAM minimum**.
+  - It's recommended to add more CPUs and RAM (like 4 CPUs and 8 GiB RAM or more) to avoid performance issue and job scheduling issue.
+  - The files in this repository are configured to ignore resource requirements which specified by AWX Operator by default.
+- **Storage resources**
+  - At least **10 GiB for `/var/lib/rancher`** and **10 GiB for `/data`** are safe for fresh install.
+  - **Both will be grown during lifetime** and **actual consumption highly depends on your environment and your usecase**, so you should to pay attention to the consumption and add more capacity if required.
+  - `/var/lib/rancher` will be created and consumed by K3s and related data like container images and overlayfs.
+  - `/data` will be created in this guide and used to store AWX-related databases and files.
+
 ## Procedure
 
-### Prepare CentOS 8 host
+### Prepare CentOS Stream 8 host
 
 Disable Firewalld. This is [recommended by K3s](https://rancher.com/docs/k3s/latest/en/advanced/#additional-preparation-for-red-hat-centos-enterprise-linux).
 
@@ -153,11 +166,12 @@ Modify two `password`s in `base/kustomization.yaml`.
 ...
 ```
 
-Prepare directories for Persistent Volumes defined in `base/pv.yaml`.
+Prepare directories for Persistent Volumes defined in `base/pv.yaml`. These directories will be used to store your databases and project files.
 
 ```bash
 sudo mkdir -p /data/postgres
 sudo mkdir -p /data/projects
+sudo chmod 755 /data/postgres
 sudo chown 1000:0 /data/projects
 ```
 
diff --git a/base/awx.yaml b/base/awx.yaml
index a1d27e9..0e23fb3 100644
--- a/base/awx.yaml
+++ b/base/awx.yaml
@@ -22,7 +22,7 @@ spec:
   postgres_storage_class: awx-postgres-volume
   postgres_storage_requirements:
     requests:
-      storage: 2Gi
+      storage: 8Gi
 
   projects_persistence: true
   projects_existing_claim: awx-projects-claim
diff --git a/base/pv.yaml b/base/pv.yaml
index a1bbfd2..a2d7411 100644
--- a/base/pv.yaml
+++ b/base/pv.yaml
@@ -8,7 +8,7 @@ spec:
     - ReadWriteOnce
   persistentVolumeReclaimPolicy: Retain
   capacity:
-    storage: 2Gi
+    storage: 8Gi
   storageClassName: awx-postgres-volume
   hostPath:
     path: /data/postgres