summaryrefslogtreecommitdiffstats
path: root/docs/release/installation/requirements.rst
diff options
context:
space:
mode:
authorMartin Kulhavy <martin.kulhavy@nokia.com>2017-08-25 17:19:45 +0300
committerMartin Kulhavy <martin.kulhavy@nokia.com>2017-08-25 17:19:45 +0300
commit8d638a2bf2afed419767526edac2049f850801f7 (patch)
tree773b6a5e1c31b8973d586c9b1ac76dc6cf35b729 /docs/release/installation/requirements.rst
parent4b7bbc9613bf8cab6b918b5f97b1712d7a5226bf (diff)
Create new consolidated documentation for JOID
The current documentation contains many different versions, which overlap and partly contradict each other. This makes it very hard for people with no experience with JOID to deploy it for the first time. This commit tries to create a new docs structure, merging information currently spread across different files, while at the same time updating the information and adding new hints based on the experience deploying JOID in our lab. The new docs structure is inspired by and tries to follow the docs structure used for the APEX installer. As a next step after finalizing this transformation, the other overlapping docs directories shall be removed Change-Id: I7075ea48565a7bd509321a532f1173cffd24cdbc Signed-off-by: Martin Kulhavy <martin.kulhavy@nokia.com>
Diffstat (limited to 'docs/release/installation/requirements.rst')
-rw-r--r--docs/release/installation/requirements.rst48
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/release/installation/requirements.rst b/docs/release/installation/requirements.rst
new file mode 100644
index 00000000..a16b7a58
--- /dev/null
+++ b/docs/release/installation/requirements.rst
@@ -0,0 +1,48 @@
+.. _setup-requirements:
+
+Setup Requirements
+==================
+
+Network Requirements
+--------------------
+
+Minimum 2 Networks:
+
+- One for the administrative network with gateway to access the Internet
+- One for the OpenStack public network to access OpenStack instances via
+ floating IPs
+
+JOID supports multiple isolated networks for data as well as storage based on
+your network requirement for OpenStack.
+
+No DHCP server should be up and configured. Configure gateways only on eth0 and
+eth1 networks to access the network outside your lab.
+
+
+Jumphost Requirements
+---------------------
+
+The Jumphost requirements are outlined below:
+
+- OS: Ubuntu 16.04 LTS Server
+- Root access.
+- CPU cores: 16
+- Memory: 32GB
+- Hard Disk: 1× (min. 250 GB)
+- NIC: eth0 (admin, management), eth1 (external connectivity)
+
+Physical nodes requirements (bare metal deployment)
+---------------------------------------------------
+
+Besides Jumphost, a minimum of 5 physical servers for bare metal environment.
+
+- CPU cores: 16
+- Memory: 32GB
+- Hard Disk: 2× (500GB) prefer SSD
+- NIC: eth0 (Admin, Management), eth1 (external network)
+
+**NOTE**: Above configuration is minimum. For better performance and usage of
+the OpenStack, please consider higher specs for all nodes.
+
+Make sure all servers are connected to top of rack switch and configured
+accordingly.