mirror of
https://github.com/xcat2/xcat-core.git
synced 2025-05-30 09:36:41 +00:00
Refine the doc skeleton
Move the subitems from install->Advanced topics to customized_image Add the subimtes for Advacned_topics Add the subitems for discovery Add subitems for developers
This commit is contained in:
wangxiaopeng
parent
d4a3f34e84
commit
d273fc8289
2
source/advanced/change_mn_ip.rst
Normal file
2
source/advanced/change_mn_ip.rst
Normal file
@ -0,0 +1,2 @@
|
||||
Changing the Hostname or IP for Management Node
|
||||
===============================================
|
||||
2
source/advanced/change_node_ip.rst
Normal file
2
source/advanced/change_node_ip.rst
Normal file
@ -0,0 +1,2 @@
|
||||
Chaning the Hostname or IP for Compute Node
|
||||
===========================================
|
||||
@ -1,5 +1,5 @@
|
||||
High Available Management Node
|
||||
==============================
|
||||
Highly Available Management Node
|
||||
================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
2
source/advanced/hierarchy_cluster.rst
Normal file
2
source/advanced/hierarchy_cluster.rst
Normal file
@ -0,0 +1,2 @@
|
||||
Setting Up a Linux Hierarchical Cluster
|
||||
=======================================
|
||||
2
source/advanced/ib.rst
Normal file
2
source/advanced/ib.rst
Normal file
@ -0,0 +1,2 @@
|
||||
Managing the Mellanox Infiniband Network
|
||||
========================================
|
||||
@ -4,7 +4,21 @@ Advanced Topics
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
restapi/index.rst
|
||||
mixed_cluster.rst
|
||||
hierarchy_cluster.rst
|
||||
hamn/index.rst
|
||||
change_mn_ip.rst
|
||||
change_node_ip.rst
|
||||
xcat_security.rst
|
||||
kit.rst
|
||||
ib.rst
|
||||
confluent/index.rst
|
||||
docker/index.rst
|
||||
hamn/index.rst
|
||||
mixed_cluster.rst
|
||||
ipv6_support.rst
|
||||
xcat_port.rst
|
||||
sysclone.rst
|
||||
switch_mgmt.rst
|
||||
vlan.rst
|
||||
zone.rst
|
||||
softlayer.rst
|
||||
|
||||
2
source/advanced/ipv6_support.rst
Normal file
2
source/advanced/ipv6_support.rst
Normal file
@ -0,0 +1,2 @@
|
||||
Configuring IPv6 in xCAT Cluster
|
||||
================================
|
||||
2
source/advanced/kit.rst
Normal file
2
source/advanced/kit.rst
Normal file
@ -0,0 +1,2 @@
|
||||
Using Software KITs
|
||||
===================
|
||||
8
source/advanced/restapi/index.rst
Normal file
8
source/advanced/restapi/index.rst
Normal file
@ -0,0 +1,8 @@
|
||||
xCAT Web Services REST API
|
||||
==========================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
set_up_ws.rst
|
||||
restapi.rst
|
||||
@ -1,2 +1,2 @@
|
||||
Hardware Discovery
|
||||
REST API Reference
|
||||
==================
|
||||
2
source/advanced/restapi/set_up_ws.rst
Normal file
2
source/advanced/restapi/set_up_ws.rst
Normal file
@ -0,0 +1,2 @@
|
||||
Set Up Web Service for REST API
|
||||
===============================
|
||||
2
source/advanced/softlayer.rst
Normal file
2
source/advanced/softlayer.rst
Normal file
@ -0,0 +1,2 @@
|
||||
Using xCAT in SoftLayer
|
||||
=======================
|
||||
2
source/advanced/switch_mgmt.rst
Normal file
2
source/advanced/switch_mgmt.rst
Normal file
@ -0,0 +1,2 @@
|
||||
Managing Ethernet Switches
|
||||
==========================
|
||||
2
source/advanced/sysclone.rst
Normal file
2
source/advanced/sysclone.rst
Normal file
@ -0,0 +1,2 @@
|
||||
Using System Clone to Deploy Diskful Node
|
||||
=========================================
|
||||
2
source/advanced/vlan.rst
Normal file
2
source/advanced/vlan.rst
Normal file
@ -0,0 +1,2 @@
|
||||
VLAN Configuration
|
||||
==================
|
||||
2
source/advanced/xcat_port.rst
Normal file
2
source/advanced/xcat_port.rst
Normal file
@ -0,0 +1,2 @@
|
||||
xCAT Port Usage
|
||||
===============
|
||||
2
source/advanced/xcat_security.rst
Normal file
2
source/advanced/xcat_security.rst
Normal file
@ -0,0 +1,2 @@
|
||||
xCAT 2 Security
|
||||
===============
|
||||
2
source/advanced/zone.rst
Normal file
2
source/advanced/zone.rst
Normal file
@ -0,0 +1,2 @@
|
||||
Setting Up Management Zones
|
||||
===========================
|
||||
2
source/developers/debug_xcat.rst
Normal file
2
source/developers/debug_xcat.rst
Normal file
@ -0,0 +1,2 @@
|
||||
Debug xCAT Problems
|
||||
===================
|
||||
2
source/developers/developer_guide.rst
Normal file
2
source/developers/developer_guide.rst
Normal file
@ -0,0 +1,2 @@
|
||||
Developer Guide
|
||||
===============
|
||||
@ -7,6 +7,8 @@ This page is for developers interested in working with xCAT.
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
developer_guide.rst
|
||||
programming_tips.rst
|
||||
debug_xcat.rst
|
||||
license/index.rst
|
||||
git/index.rst
|
||||
mini-design/index.rst
|
||||
|
||||
@ -1,14 +0,0 @@
|
||||
Mini-design for xCAT Debug Mode
|
||||
===============================
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
|
||||
+--------+----------+
|
||||
| Name | Age |
|
||||
+========+==========+
|
||||
| Wang | 20 |
|
||||
+--------+----------+
|
||||
| Zhao | 18 |
|
||||
+--------+----------+
|
||||
@ -1,2 +0,0 @@
|
||||
Mini-design for Docker Swarm Support
|
||||
====================================
|
||||
@ -1,49 +0,0 @@
|
||||
Mini-design for Docker Support
|
||||
==============================
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
Docker technology is very hot recently, xCAT plans to support it as a way to deploy applictions.
|
||||
|
||||
Interface
|
||||
---------
|
||||
|
||||
General Command Line
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Will add several new commands to support docker.
|
||||
|
||||
* docker create
|
||||
|
||||
* Create only
|
||||
* Start after creating
|
||||
|
||||
* docker stop
|
||||
|
||||
Stop the docker container
|
||||
|
||||
* docker remove
|
||||
|
||||
Rest API
|
||||
^^^^^^^^
|
||||
|
||||
Add xCAT Rest API to support docker.
|
||||
|
||||
* docker create
|
||||
|
||||
URI - /xcatws/<node>/start
|
||||
|
||||
::
|
||||
#curl
|
||||
#wget
|
||||
|
||||
Add a Table
|
||||
^^^^^^^^^^^
|
||||
+-----------+------------+-------------+
|
||||
|Operation |Params |Result |
|
||||
+===========+============+=============+
|
||||
|GET |node |on/off |
|
||||
+-----------+------------+-------------+
|
||||
|PUT |node |on/off |
|
||||
+-----------+------------+-------------+
|
||||
@ -1,24 +0,0 @@
|
||||
Mini-Design
|
||||
===========
|
||||
|
||||
The **Design Document** for certain feature.
|
||||
|
||||
**NOTE**
|
||||
|
||||
*The documents displayed in this page are not official guides for user to reference. They are just design documents that describe how to implement certain feature. And sometimes they are not updated with the current implementation.*
|
||||
|
||||
2.11
|
||||
----
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
2.11/docker.rst
|
||||
2.11/docker-swarm.rst
|
||||
|
||||
2.10
|
||||
----
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
2.10/xcatdebugmode.rst
|
||||
2
source/developers/programming_tips.rst
Normal file
2
source/developers/programming_tips.rst
Normal file
@ -0,0 +1,2 @@
|
||||
Programming Tips
|
||||
================
|
||||
@ -2,6 +2,3 @@ Select or Create an osimage Definition
|
||||
======================================
|
||||
Run copycds to create image
|
||||
|
||||
Customize the osimage definitions
|
||||
=================================
|
||||
|
||||
|
||||
@ -0,0 +1,2 @@
|
||||
Manually Define Nodes
|
||||
=====================
|
||||
@ -0,0 +1,2 @@
|
||||
Manually Discover Nodes
|
||||
=======================
|
||||
@ -0,0 +1,2 @@
|
||||
MTMS-based Discovery
|
||||
====================
|
||||
@ -0,0 +1,2 @@
|
||||
Sequential-based Discovery
|
||||
==========================
|
||||
@ -0,0 +1,2 @@
|
||||
Switch-based Discovery
|
||||
======================
|
||||
@ -1,4 +1,12 @@
|
||||
.. ========================
|
||||
.. Using common shared file
|
||||
.. ========================
|
||||
.. include:: ../../common/discovery.rst
|
||||
Hardware Discoveriy & Define Node
|
||||
=================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
manually_define.rst
|
||||
mtms_discovery.rst
|
||||
switch_discovery.rst
|
||||
seq_discovery.rst
|
||||
manually_discovery.rst
|
||||
|
||||
|
||||
@ -0,0 +1 @@
|
||||
.. include:: ../../common/discover/manually_define.rst
|
||||
@ -0,0 +1 @@
|
||||
.. include:: ../../common/discover/manually_discovery.rst
|
||||
@ -0,0 +1 @@
|
||||
.. include:: ../../common/discover/mtms_discovery.rst
|
||||
@ -0,0 +1 @@
|
||||
.. include:: ../../common/discover/seq_discovery.rst
|
||||
@ -0,0 +1 @@
|
||||
.. include:: ../../common/discover/switch_discovery.rst
|
||||
@ -1,15 +0,0 @@
|
||||
Advanced Topics
|
||||
===============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
raid_cfg.rst
|
||||
driver_update_disk.rst
|
||||
cfg_partition.rst
|
||||
pre_post_script.rst
|
||||
syncfile.rst
|
||||
additional_pkg.rst
|
||||
cfg_second_adapter.rst
|
||||
|
||||
|
||||
@ -0,0 +1,16 @@
|
||||
Customize osimage (Optional)
|
||||
============================
|
||||
Optional means all the subitems in this page are not necessary to finish an OS deployment. If you are new to xCAT, you can just jump to `Initialize the Compute for Deployment`.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
raid_cfg.rst
|
||||
driver_update_disk.rst
|
||||
cfg_partition.rst
|
||||
pre_post_script.rst
|
||||
syncfile.rst
|
||||
additional_pkg.rst
|
||||
cfg_second_adapter.rst
|
||||
|
||||
|
||||
@ -4,7 +4,6 @@ Diskful Installation
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
image_mgmt.rst
|
||||
advanced_topics/index.rst
|
||||
copy_image.rst
|
||||
customize_image/index.rst
|
||||
deploy_os.rst
|
||||
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
Advanced Topics
|
||||
===============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
driver_update_disk.rst
|
||||
pre_post_script.rst
|
||||
syncfile.rst
|
||||
additional_pkg.rst
|
||||
cfg_second_adapter.rst
|
||||
enable_kdump.rst
|
||||
|
||||
@ -0,0 +1,2 @@
|
||||
|
||||
.. include:: ../../common/deployment/create_img.rst
|
||||
@ -0,0 +1,15 @@
|
||||
Customize osimage (Optional)
|
||||
============================
|
||||
Optional means all the subitems in this page are not necessary to finish an OS deployment. If you are new to xCAT, you can just jump
|
||||
to `Initialize the Compute for Deployment`.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
driver_update_disk.rst
|
||||
pre_post_script.rst
|
||||
syncfile.rst
|
||||
additional_pkg.rst
|
||||
cfg_second_adapter.rst
|
||||
enable_kdump.rst
|
||||
|
||||
@ -1,3 +1 @@
|
||||
|
||||
.. include:: ../../common/deployment/create_img.rst
|
||||
.. include:: ../../common/deployment/generate_img.rst
|
||||
@ -4,7 +4,7 @@ Diskless Installation
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
image_mgmt.rst
|
||||
advanced_topics/index.rst
|
||||
copy_image.rst
|
||||
customize_image/index.rst
|
||||
gen_image.rst
|
||||
deploy_os.rst
|
||||
|
||||
|
||||
@ -1,4 +1 @@
|
||||
.. ========================
|
||||
.. Using common shared file
|
||||
.. ========================
|
||||
.. include:: ../../common/kvm/manage_vm.rst
|
||||
|
||||
@ -1,4 +0,0 @@
|
||||
.. ========================
|
||||
.. Using common shared file
|
||||
.. ========================
|
||||
.. include:: ../../common/discovery.rst
|
||||
@ -1,3 +0,0 @@
|
||||
.. ========================
|
||||
.. Using common shared file
|
||||
.. ========================
|
||||
@ -1,3 +0,0 @@
|
||||
.. ========================
|
||||
.. Using common shared file
|
||||
.. ========================
|
||||
Binary file not shown.
@ -23,8 +23,8 @@ Content
|
||||
overview/index.rst
|
||||
guides/install-guides/index.rst
|
||||
guides/admin-guides/index.rst
|
||||
developers/index.rst
|
||||
advanced/index.rst
|
||||
developers/index.rst
|
||||
help.rst
|
||||
|
||||
|
||||
|
||||
@ -11,3 +11,4 @@ xCAT is known for exceptional scaling, wide variety of supported hardware, opera
|
||||
features.rst
|
||||
support_list.rst
|
||||
architecture.rst
|
||||
setup_cluster_process.rst
|
||||
|
||||
2
source/overview/setup_cluster_process.rst
Normal file
2
source/overview/setup_cluster_process.rst
Normal file
@ -0,0 +1,2 @@
|
||||
Brief Steps to Set Up an xCAT Cluster
|
||||
=====================================
|
||||
Loading…
x
Reference in New Issue
Block a user