From cf2da529eef3d7bcd5ce22bec627ce870488c3c7 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Tue, 11 Aug 2015 14:08:42 -0400 Subject: [PATCH] Set up the basic skeleton for the large cluster support documentation --- .../large_clusters/databases/index.rst | 30 ++++++++++--------- .../admin-guides/large_clusters/index.rst | 17 +++++++++-- .../service_nodes/define_service_nodes.rst | 2 ++ .../service_nodes/provision_service_nodes.rst | 11 +++++++ .../service_nodes/service_nodes101.rst | 3 ++ .../admin-guides/large_clusters/tips.rst | 5 ++++ 6 files changed, 52 insertions(+), 16 deletions(-) create mode 100644 source/guides/admin-guides/large_clusters/service_nodes/define_service_nodes.rst create mode 100644 source/guides/admin-guides/large_clusters/service_nodes/provision_service_nodes.rst create mode 100644 source/guides/admin-guides/large_clusters/service_nodes/service_nodes101.rst create mode 100644 source/guides/admin-guides/large_clusters/tips.rst diff --git a/source/guides/admin-guides/large_clusters/databases/index.rst b/source/guides/admin-guides/large_clusters/databases/index.rst index f89770eac..615b9ebf5 100644 --- a/source/guides/admin-guides/large_clusters/databases/index.rst +++ b/source/guides/admin-guides/large_clusters/databases/index.rst @@ -1,24 +1,24 @@ -Databases -========= +Configure a Database +==================== -xCAT Supports the following databases to be used by xCAT on the Management node +xCAT requires a database to hold persistent information and currently supports the following: -* SQLite -* MySQL/MariaDB -* PostgreSQL -* DB2 + * SQLite + * MySQL/MariaDB + * PostgreSQL + * DB2 SQLite ------ -SQLite database is the default database used by xCAT and is initialized when xCAT is installed on the management node. +The SQLite database (https://www.sqlite.org/) is the default database used by xCAT and is initialized when xCAT is installed on the management node. +SQLite is a small, light-weight, daemon-less database that requires very little configuration and maintenance. This database is sufficient for smarll to moderately sized systems (typeically < 1000 nodes). -SQLite is a small, light-weight, daemon-less database that requires no configuration or maintenance. This database is sufficient for small to moderate size systems ( < 1000 nodes ) +xCAT Hierarchy (Service Nodes) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -**The SQLite database can NOT be used for xCAT hierarchy support because service nodes requires remote access to the database and SQLite does NOT support remote access.** - -For xCAT hierarchy, you will need to use one of the following alternate databases: +The SQLite datacase **CAN NOT** be used when using xCAT hierarchy support because the xCAT service nodes require remote access to the database. This is one reason you would need to configure one of the alternative databases listed below: MySQL/MariaDB ------------- @@ -28,7 +28,8 @@ MySQL/MariaDB mysql_install.rst mysql_configure.rst - + mysql_using.rst + mysql_remove.rst PostgreSQL @@ -39,4 +40,5 @@ PostgreSQL postgres_install.rst postgres_configure.rst - postgres_tips.rst + postgres_using.rst + postgres_remove.rst diff --git a/source/guides/admin-guides/large_clusters/index.rst b/source/guides/admin-guides/large_clusters/index.rst index c3c0633e4..4a0acb99c 100644 --- a/source/guides/admin-guides/large_clusters/index.rst +++ b/source/guides/admin-guides/large_clusters/index.rst @@ -1,7 +1,20 @@ -Managing Large Clusters -======================= +Large Clusters +============== + +When managing large clusters, it is recommended to have more than one node (Management Node, "MN") handling the installation and management of all the compute nodes. These additional "helper" nodes are called **Service Nodes** ("SN"). The Management Node can delegate all management operational needs for a compute node to the Service Node responsible for that compute node. There can be one or more Service Nodes configured to install/manage a group of compute nodes. + +The following configurations are supported by xCAT: + + * Each Service Node installs/manages a specific set of compute nodes + * Having a pool of Service Nodes in which any can respond to an installation request from a compute node + * A hybrid of the above, where each specific set of compute nodes have 2 or more Service Nodes in a pool + .. toctree:: :maxdepth: 2 + service_nodes/service_nodes101.rst databases/index.rst + service_nodes/define_service_nodes.rst + service_nodes/provision_service_nodes.rst + tips.rst diff --git a/source/guides/admin-guides/large_clusters/service_nodes/define_service_nodes.rst b/source/guides/admin-guides/large_clusters/service_nodes/define_service_nodes.rst new file mode 100644 index 000000000..d3b33911b --- /dev/null +++ b/source/guides/admin-guides/large_clusters/service_nodes/define_service_nodes.rst @@ -0,0 +1,2 @@ +Define Service Nodes +==================== diff --git a/source/guides/admin-guides/large_clusters/service_nodes/provision_service_nodes.rst b/source/guides/admin-guides/large_clusters/service_nodes/provision_service_nodes.rst new file mode 100644 index 000000000..b3cb3b497 --- /dev/null +++ b/source/guides/admin-guides/large_clusters/service_nodes/provision_service_nodes.rst @@ -0,0 +1,11 @@ +Provision Service Nodes +======================= + +Diskful +------- + +Diskless +-------- + +Verfication +----------- diff --git a/source/guides/admin-guides/large_clusters/service_nodes/service_nodes101.rst b/source/guides/admin-guides/large_clusters/service_nodes/service_nodes101.rst new file mode 100644 index 000000000..c97b510f2 --- /dev/null +++ b/source/guides/admin-guides/large_clusters/service_nodes/service_nodes101.rst @@ -0,0 +1,3 @@ +Service Nodes 101 +================= + diff --git a/source/guides/admin-guides/large_clusters/tips.rst b/source/guides/admin-guides/large_clusters/tips.rst new file mode 100644 index 000000000..680808ba0 --- /dev/null +++ b/source/guides/admin-guides/large_clusters/tips.rst @@ -0,0 +1,5 @@ +Tips/Tuning/Suggestions +======================= + +TODO: Content from: https://sourceforge.net/p/xcat/wiki/Hints_and_Tips_for_Large_Scale_Clusters/ +