diff --git a/docs/source/advanced/change_mn_ip.rst b/docs/source/advanced/change_mn_ip.rst deleted file mode 100644 index d02fd709a..000000000 --- a/docs/source/advanced/change_mn_ip.rst +++ /dev/null @@ -1,2 +0,0 @@ -Changing the Hostname or IP for Management Node -=============================================== diff --git a/docs/source/advanced/change_node_ip.rst b/docs/source/advanced/change_node_ip.rst deleted file mode 100644 index 969f644bb..000000000 --- a/docs/source/advanced/change_node_ip.rst +++ /dev/null @@ -1,2 +0,0 @@ -Chaning the Hostname or IP for Compute Node -=========================================== diff --git a/docs/source/advanced/ipv6_support.rst b/docs/source/advanced/cluster_maintenance/compute_node/changing_hostname_ip.rst similarity index 50% rename from docs/source/advanced/ipv6_support.rst rename to docs/source/advanced/cluster_maintenance/compute_node/changing_hostname_ip.rst index 82ead6440..04ea388d7 100644 --- a/docs/source/advanced/ipv6_support.rst +++ b/docs/source/advanced/cluster_maintenance/compute_node/changing_hostname_ip.rst @@ -1,2 +1,2 @@ -Configuring IPv6 in xCAT Cluster +Changing the hostname/IP address ================================ diff --git a/docs/source/advanced/cluster_maintenance/compute_node/index.rst b/docs/source/advanced/cluster_maintenance/compute_node/index.rst new file mode 100644 index 000000000..6199699e6 --- /dev/null +++ b/docs/source/advanced/cluster_maintenance/compute_node/index.rst @@ -0,0 +1,7 @@ +Compute Node +============ + +.. toctree:: + :maxdepth: 2 + + changing_hostname_ip.rst diff --git a/docs/source/advanced/cluster_maintenance/index.rst b/docs/source/advanced/cluster_maintenance/index.rst new file mode 100644 index 000000000..6419d475e --- /dev/null +++ b/docs/source/advanced/cluster_maintenance/index.rst @@ -0,0 +1,9 @@ +Cluster Maintenance +=================== + +.. toctree:: + :maxdepth: 2 + + compute_node/index.rst + mgmt_node/index.rst + sw_fw_inventory.rst diff --git a/docs/source/advanced/cluster_maintenance/mgmt_node/changing_hostname_ip.rst b/docs/source/advanced/cluster_maintenance/mgmt_node/changing_hostname_ip.rst new file mode 100644 index 000000000..0716dc9e1 --- /dev/null +++ b/docs/source/advanced/cluster_maintenance/mgmt_node/changing_hostname_ip.rst @@ -0,0 +1,4 @@ +Changing the hostname/IP address +================================ + +There may be times when it is required to change the hostname or IP address of the xCAT management nodes. This document helps to outline the steps required to ensure successfully changing this attribute on the management node. diff --git a/docs/source/advanced/cluster_maintenance/mgmt_node/index.rst b/docs/source/advanced/cluster_maintenance/mgmt_node/index.rst new file mode 100644 index 000000000..2cda13bd9 --- /dev/null +++ b/docs/source/advanced/cluster_maintenance/mgmt_node/index.rst @@ -0,0 +1,7 @@ +Management Node +=============== + +.. toctree:: + :maxdepth: 2 + + changing_hostname_ip.rst diff --git a/docs/source/advanced/firmware_inventory.rst b/docs/source/advanced/cluster_maintenance/sw_fw_inventory.rst similarity index 100% rename from docs/source/advanced/firmware_inventory.rst rename to docs/source/advanced/cluster_maintenance/sw_fw_inventory.rst diff --git a/docs/source/advanced/cuda.rst b/docs/source/advanced/gpu/cuda.rst similarity index 100% rename from docs/source/advanced/cuda.rst rename to docs/source/advanced/gpu/cuda.rst diff --git a/docs/source/advanced/gpu/index.rst b/docs/source/advanced/gpu/index.rst new file mode 100644 index 000000000..1c4468d70 --- /dev/null +++ b/docs/source/advanced/gpu/index.rst @@ -0,0 +1,7 @@ +GPUs +==== + +.. toctree:: + :maxdepth: 2 + + cuda.rst diff --git a/docs/source/advanced/hamn/high_available_management_node.rst b/docs/source/advanced/hamn/high_available_management_node.rst index 33359eaf5..eb1299a6f 100644 --- a/docs/source/advanced/hamn/high_available_management_node.rst +++ b/docs/source/advanced/hamn/high_available_management_node.rst @@ -1,22 +1,17 @@ -======== Overview ======== - The xCAT management node plays an important role in the cluster, if the management node is down for whatever reason, the administrators will lose the management capability for the whole cluster, until the management node is back up and running. In some configuration, like the Linux nfs-based statelite in a non-hierarchy cluster, the compute nodes may not be able to run at all without the management node. So, it is important to consider the high availability for the management node. The goal of the HAMN(High Availability Management Node) configuration is, when the primary xCAT management node fails, the standby management node can take over the role of the management node, either through automatic failover or through manual procedure performed by the administrator, and thus avoid long periods of time during which your cluster does not have active cluster management function available. -============================ Configuration considerations ============================ - xCAT provides several configuration options for the HAMN, you can select one of the option based on your failover requirements and hardware configuration, the following configuration considerations should be able to help you to make the decision. -****************************** Data synchronization mechanism -****************************** +------------------------------ The data synchronization is important for any high availability configuration. When the xCAT management node failover occurs, the xCAT data needs to be exactly the same before failover, and some of the operating system configuration should also be synchronized between the two management nodes. To be specific, the following data should be synchronized between the two management nodes to make the xCAT HAMN work: @@ -35,9 +30,8 @@ Warning: Running database through network file system has a lot of potential pro **3\. Mirroring**: each of the management node has its own copy of the xCAT data, and the two copies of data are syncronized through mirroring mechanism. DRBD is used widely in the high availability configuration scenarios, to provide data replication by mirroring a whole block device via network. If we put all the important data for xCAT onto the DRBD devices, then it could assure the data is synchronized between the two management nodes. Some parallel file system also provides capability to mirror data through network. -************************************* -Manual failover VS automatic failover -************************************* +Manual vs. Automatic Failover +----------------------------- When the primary management node fails, the backup management node could automatically take over, or the administrator has to perform some manual procedure to finish the failover. In general, the automatic failover takes less time to detect the failure and perform and failover, comparing with the manual failover, but the automatic failover requires more complex configuration. We could not say the automatic failover is better than the manual failover in all cases, the following factors should be considered when deciding the manual failover or automatic failover: @@ -55,7 +49,6 @@ The configuration for the high availability applications is usually complex, it The automatic failover brings in several high availability applications, after the initial configuration is done, additional maintenance effort will be needed. For example, taking care of the high availability applications during cluster update, the updates for the high availability applications themselves, trouble shooting any problems with the high availability applications. A simple question may be able to help you to decide: could you get technical support if some of the high availability applications run into problems? All software has bugs ... -===================== Configuration Options ===================== diff --git a/docs/source/advanced/hamn/index.rst b/docs/source/advanced/hamn/index.rst index 9e4e10e6b..3bcf0a6b3 100644 --- a/docs/source/advanced/hamn/index.rst +++ b/docs/source/advanced/hamn/index.rst @@ -1,5 +1,7 @@ -Highly Available Management Node -================================ +High Avaiability +================ + +The following pages describes ways to configure the xCAT Management Node for High Availbility. .. toctree:: :maxdepth: 2 diff --git a/docs/source/advanced/hierarchy_cluster.rst b/docs/source/advanced/hierarchy/hierarchy_cluster.rst similarity index 100% rename from docs/source/advanced/hierarchy_cluster.rst rename to docs/source/advanced/hierarchy/hierarchy_cluster.rst diff --git a/docs/source/advanced/hierarchy/index.rst b/docs/source/advanced/hierarchy/index.rst new file mode 100644 index 000000000..1f0a6b2e8 --- /dev/null +++ b/docs/source/advanced/hierarchy/index.rst @@ -0,0 +1,7 @@ +Hierarchical Clusters +===================== + +.. toctree:: + :maxdepth: 2 + + introduction.rst diff --git a/docs/source/advanced/hierarchy/introduction.rst b/docs/source/advanced/hierarchy/introduction.rst new file mode 100644 index 000000000..00d01e5d0 --- /dev/null +++ b/docs/source/advanced/hierarchy/introduction.rst @@ -0,0 +1,10 @@ +Introduction +============ + +In supporting large clusters, it is desirable to have more than a single management node handling the installation and management of compute nodes. + +In xCAT, these additional nodes are referred to as *Service Nodes (SN)*. The management node can delegate all management operations for a compute node to the Service node that is managing them. You can have one of more service nodes configured to install and manage a group of compute nodes. + + +Service Nodes +------------- diff --git a/docs/source/advanced/ib.rst b/docs/source/advanced/ib.rst deleted file mode 100644 index bbd3f2ef0..000000000 --- a/docs/source/advanced/ib.rst +++ /dev/null @@ -1,2 +0,0 @@ -Managing the Mellanox Infiniband Network -======================================== diff --git a/docs/source/advanced/index.rst b/docs/source/advanced/index.rst index 3a5321c26..a511442d7 100644 --- a/docs/source/advanced/index.rst +++ b/docs/source/advanced/index.rst @@ -4,24 +4,22 @@ Advanced Topics .. toctree:: :maxdepth: 2 - restapi/index.rst - mixed_cluster/index.rst - hierarchy_cluster.rst + confluent/index.rst + cluster_maintenance/index.rst + docker/index.rst + gpu/index.rst hamn/index.rst + hierarchy/index.rst + mixed_cluster/index.rst + networks/index.rst change_mn_ip.rst change_node_ip.rst - xcat_security.rst + ports/xcat_ports.rst + raid/index.rst + security/index.rst + softlayer/index.rst kit/index.rst - ib.rst - confluent/index.rst - docker/index.rst - ipv6_support.rst - xcat_port.rst - sysclone.rst - switch_mgmt.rst - vlan.rst - zone.rst - softlayer.rst - firmware_inventory.rst - configraid.rst - cuda.rst + switches/index.rst + sysclone/index.rst + webservices/index.rst + zones/index.rst diff --git a/docs/source/advanced/networks/index.rst b/docs/source/advanced/networks/index.rst new file mode 100644 index 000000000..4ac978fa4 --- /dev/null +++ b/docs/source/advanced/networks/index.rst @@ -0,0 +1,9 @@ +Networks +======== + +.. toctree:: + :maxdepth: 2 + + infiniband/index.rst + ipv6/index.rst + vlan/index.rst diff --git a/docs/source/advanced/networks/infiniband/driver_and_installation.rst b/docs/source/advanced/networks/infiniband/driver_and_installation.rst new file mode 100644 index 000000000..64afd2e61 --- /dev/null +++ b/docs/source/advanced/networks/infiniband/driver_and_installation.rst @@ -0,0 +1,2 @@ +IB Driver Preparation and Installation +====================================== diff --git a/docs/source/advanced/networks/infiniband/firmware_updates.rst b/docs/source/advanced/networks/infiniband/firmware_updates.rst new file mode 100644 index 000000000..b8d3e298b --- /dev/null +++ b/docs/source/advanced/networks/infiniband/firmware_updates.rst @@ -0,0 +1,2 @@ +Firmware Updates +================ diff --git a/docs/source/advanced/networks/infiniband/index.rst b/docs/source/advanced/networks/infiniband/index.rst new file mode 100644 index 000000000..0de9e2243 --- /dev/null +++ b/docs/source/advanced/networks/infiniband/index.rst @@ -0,0 +1,11 @@ +Infiniband (Mellanox) +===================== + +.. toctree:: + :maxdepth: 2 + + driver_and_installation.rst + network_configuration.rst + switch_configuration.rst + ufm_configuration.rst + firmware_updates.rst diff --git a/docs/source/advanced/networks/infiniband/network_configuration.rst b/docs/source/advanced/networks/infiniband/network_configuration.rst new file mode 100644 index 000000000..3fa97b26a --- /dev/null +++ b/docs/source/advanced/networks/infiniband/network_configuration.rst @@ -0,0 +1,2 @@ +IB Network Configuration +======================== diff --git a/docs/source/advanced/networks/infiniband/switch_configuration.rst b/docs/source/advanced/networks/infiniband/switch_configuration.rst new file mode 100644 index 000000000..9cb975ec8 --- /dev/null +++ b/docs/source/advanced/networks/infiniband/switch_configuration.rst @@ -0,0 +1,2 @@ +IB Switch Configuration +======================= diff --git a/docs/source/advanced/networks/infiniband/ufm_configuration.rst b/docs/source/advanced/networks/infiniband/ufm_configuration.rst new file mode 100644 index 000000000..0f4eb6e16 --- /dev/null +++ b/docs/source/advanced/networks/infiniband/ufm_configuration.rst @@ -0,0 +1,2 @@ +UFM Configuration +================= diff --git a/docs/source/advanced/networks/ipv6/index.rst b/docs/source/advanced/networks/ipv6/index.rst new file mode 100644 index 000000000..6e4c286a0 --- /dev/null +++ b/docs/source/advanced/networks/ipv6/index.rst @@ -0,0 +1,7 @@ +IPv6 +==== + +.. toctree:: + :maxdepth: 2 + + ipv6_support.rst diff --git a/docs/source/advanced/networks/ipv6/ipv6_support.rst b/docs/source/advanced/networks/ipv6/ipv6_support.rst new file mode 100644 index 000000000..dcd805c1f --- /dev/null +++ b/docs/source/advanced/networks/ipv6/ipv6_support.rst @@ -0,0 +1,2 @@ +Configuring IPv6 +================ diff --git a/docs/source/advanced/networks/vlan/index.rst b/docs/source/advanced/networks/vlan/index.rst new file mode 100644 index 000000000..a6df75aa6 --- /dev/null +++ b/docs/source/advanced/networks/vlan/index.rst @@ -0,0 +1,7 @@ +VLANs +===== + +.. toctree:: + :maxdepth: 2 + + vlan.rst diff --git a/docs/source/advanced/vlan.rst b/docs/source/advanced/networks/vlan/vlan.rst similarity index 100% rename from docs/source/advanced/vlan.rst rename to docs/source/advanced/networks/vlan/vlan.rst diff --git a/docs/source/advanced/ports/xcat_ports.rst b/docs/source/advanced/ports/xcat_ports.rst new file mode 100644 index 000000000..c6cc7dfe7 --- /dev/null +++ b/docs/source/advanced/ports/xcat_ports.rst @@ -0,0 +1,4 @@ +Port Usage +========== + +TODO: http://sourceforge.net/p/xcat/wiki/XCAT_Port_Usage/?version=4 diff --git a/docs/source/advanced/configraid.rst b/docs/source/advanced/raid/hardware_raid.rst similarity index 98% rename from docs/source/advanced/configraid.rst rename to docs/source/advanced/raid/hardware_raid.rst index 042113ebc..d9da8fbc7 100644 --- a/docs/source/advanced/configraid.rst +++ b/docs/source/advanced/raid/hardware_raid.rst @@ -1,5 +1,5 @@ -Configuring hardware RAID in xCAT cluster -========================================= +Hardware RAID +============= Overview -------- diff --git a/docs/source/advanced/raid/index.rst b/docs/source/advanced/raid/index.rst new file mode 100644 index 000000000..1cc047c88 --- /dev/null +++ b/docs/source/advanced/raid/index.rst @@ -0,0 +1,7 @@ +RAID +==== + +.. toctree:: + :maxdepth: 2 + + hardware_raid.rst diff --git a/docs/source/advanced/restapi/restapi.rst b/docs/source/advanced/restapi/restapi.rst deleted file mode 100644 index c28bacd72..000000000 --- a/docs/source/advanced/restapi/restapi.rst +++ /dev/null @@ -1,2 +0,0 @@ -REST API Reference -================== diff --git a/docs/source/advanced/security/index.rst b/docs/source/advanced/security/index.rst new file mode 100644 index 000000000..dfa8440d9 --- /dev/null +++ b/docs/source/advanced/security/index.rst @@ -0,0 +1,8 @@ +Security +======== + +TODO, organize/rewrite from http://sourceforge.net/p/xcat/wiki/XCAT_2_Security/ + +.. toctree:: + :maxdepth: 2 + diff --git a/docs/source/advanced/softlayer/index.rst b/docs/source/advanced/softlayer/index.rst new file mode 100644 index 000000000..5b25dab7f --- /dev/null +++ b/docs/source/advanced/softlayer/index.rst @@ -0,0 +1,7 @@ +SoftLayer +========= + +.. toctree:: + :maxdepth: 2 + + softlayer.rst diff --git a/docs/source/advanced/softlayer.rst b/docs/source/advanced/softlayer/softlayer.rst similarity index 100% rename from docs/source/advanced/softlayer.rst rename to docs/source/advanced/softlayer/softlayer.rst diff --git a/docs/source/advanced/switch_mgmt.rst b/docs/source/advanced/switch_mgmt.rst deleted file mode 100644 index c4c2617bc..000000000 --- a/docs/source/advanced/switch_mgmt.rst +++ /dev/null @@ -1,2 +0,0 @@ -Managing Ethernet Switches -========================== diff --git a/docs/source/advanced/switches/ethernet_switches.rst b/docs/source/advanced/switches/ethernet_switches.rst new file mode 100644 index 000000000..1c9a8d361 --- /dev/null +++ b/docs/source/advanced/switches/ethernet_switches.rst @@ -0,0 +1,2 @@ +Ethernet Switches +================= diff --git a/docs/source/advanced/switches/index.rst b/docs/source/advanced/switches/index.rst new file mode 100644 index 000000000..74d3b9cf9 --- /dev/null +++ b/docs/source/advanced/switches/index.rst @@ -0,0 +1,7 @@ +Switch Management +================= + +.. toctree:: + :maxdepth: 2 + + ethernet_switches.rst diff --git a/docs/source/advanced/sysclone/index.rst b/docs/source/advanced/sysclone/index.rst new file mode 100644 index 000000000..60466a9fc --- /dev/null +++ b/docs/source/advanced/sysclone/index.rst @@ -0,0 +1,7 @@ +System Clone (sysclone) +======================= + +.. toctree:: + :maxdepth: 2 + + sysclone.rst diff --git a/docs/source/advanced/sysclone.rst b/docs/source/advanced/sysclone/sysclone.rst similarity index 100% rename from docs/source/advanced/sysclone.rst rename to docs/source/advanced/sysclone/sysclone.rst diff --git a/docs/source/advanced/restapi/index.rst b/docs/source/advanced/webservices/index.rst similarity index 53% rename from docs/source/advanced/restapi/index.rst rename to docs/source/advanced/webservices/index.rst index 6724c604d..15ef626fd 100644 --- a/docs/source/advanced/restapi/index.rst +++ b/docs/source/advanced/webservices/index.rst @@ -1,5 +1,5 @@ -xCAT Web Services REST API -========================== +Web Services +============ .. toctree:: :maxdepth: 2 diff --git a/docs/source/advanced/webservices/restapi.rst b/docs/source/advanced/webservices/restapi.rst new file mode 100644 index 000000000..f029a016b --- /dev/null +++ b/docs/source/advanced/webservices/restapi.rst @@ -0,0 +1,2 @@ +RESTful APIs +============ diff --git a/docs/source/advanced/restapi/set_up_ws.rst b/docs/source/advanced/webservices/set_up_ws.rst similarity index 98% rename from docs/source/advanced/restapi/set_up_ws.rst rename to docs/source/advanced/webservices/set_up_ws.rst index 44945876b..40c11ce16 100644 --- a/docs/source/advanced/restapi/set_up_ws.rst +++ b/docs/source/advanced/webservices/set_up_ws.rst @@ -1,7 +1,7 @@ -Set Up Web Service for REST API -=============================== +Configure Web Services +====================== -The following steps describe how to setup the WEB Service to use the REST API +The following steps describe how to setup the Web Service to use the REST API Enable the HTTPS service for REST API ------------------------------------- diff --git a/docs/source/advanced/xcat_security.rst b/docs/source/advanced/xcat_security.rst deleted file mode 100644 index 04d904fe1..000000000 --- a/docs/source/advanced/xcat_security.rst +++ /dev/null @@ -1,2 +0,0 @@ -xCAT 2 Security -=============== diff --git a/docs/source/advanced/zones/change_zones.rst b/docs/source/advanced/zones/change_zones.rst new file mode 100644 index 000000000..27ac5e5e7 --- /dev/null +++ b/docs/source/advanced/zones/change_zones.rst @@ -0,0 +1,2 @@ +Change Zones +============ diff --git a/docs/source/advanced/xcat_port.rst b/docs/source/advanced/zones/configure_zones.rst similarity index 50% rename from docs/source/advanced/xcat_port.rst rename to docs/source/advanced/zones/configure_zones.rst index 5952d1531..a74e9ae20 100644 --- a/docs/source/advanced/xcat_port.rst +++ b/docs/source/advanced/zones/configure_zones.rst @@ -1,2 +1,2 @@ -xCAT Port Usage +Configure Zones =============== diff --git a/docs/source/advanced/zones/create_zones.rst b/docs/source/advanced/zones/create_zones.rst new file mode 100644 index 000000000..fefb6011e --- /dev/null +++ b/docs/source/advanced/zones/create_zones.rst @@ -0,0 +1,2 @@ +Create Zones +============ diff --git a/docs/source/advanced/zones/index.rst b/docs/source/advanced/zones/index.rst new file mode 100644 index 000000000..20a65445f --- /dev/null +++ b/docs/source/advanced/zones/index.rst @@ -0,0 +1,11 @@ +Zones +===== + +.. toctree:: + :maxdepth: 2 + + overview.rst + configure_zones.rst + create_zones.rst + change_zones.rst + remove_zones.rst diff --git a/docs/source/advanced/zones/overview.rst b/docs/source/advanced/zones/overview.rst new file mode 100644 index 000000000..d0407f88d --- /dev/null +++ b/docs/source/advanced/zones/overview.rst @@ -0,0 +1,4 @@ +Overview +======== + +xCAT supports the concept of zones within a single xCAT cluster managed by one (1) Management Node. The nodes in the cluster can be divided up into multiple zones that have different ssh keys managed separately. diff --git a/docs/source/advanced/zones/remove_zones.rst b/docs/source/advanced/zones/remove_zones.rst new file mode 100644 index 000000000..40910fb47 --- /dev/null +++ b/docs/source/advanced/zones/remove_zones.rst @@ -0,0 +1,2 @@ +Remove Zones +============