From af9368827a7a3db36b74a22cb498504f5e59faf4 Mon Sep 17 00:00:00 2001 From: wangxiaopeng Date: Thu, 13 Aug 2015 22:32:05 -0400 Subject: [PATCH] Refine the doc skeleton in the Basic Concept part Since it has been discussed with Victor, I check it in directly --- .../network_service/index.rst | 4 +-- .../basic_concepts/xcat_db/index.rst | 25 +++++++++++++------ .../basic_concepts/xcat_object/group.rst | 2 ++ .../basic_concepts/xcat_object/index.rst | 17 ++++++------- .../basic_concepts/xcat_object/node.rst | 5 ++++ .../basic_concepts/xcat_object/osimage.rst | 2 ++ 6 files changed, 35 insertions(+), 20 deletions(-) create mode 100644 source/guides/admin-guides/basic_concepts/xcat_object/group.rst create mode 100644 source/guides/admin-guides/basic_concepts/xcat_object/node.rst create mode 100644 source/guides/admin-guides/basic_concepts/xcat_object/osimage.rst diff --git a/source/guides/admin-guides/basic_concepts/network_planning/network_service/index.rst b/source/guides/admin-guides/basic_concepts/network_planning/network_service/index.rst index 54dd662bd..734496736 100644 --- a/source/guides/admin-guides/basic_concepts/network_planning/network_service/index.rst +++ b/source/guides/admin-guides/basic_concepts/network_planning/network_service/index.rst @@ -1,2 +1,2 @@ -Network Services which are used in xCAT -================================== +Network Services +================ diff --git a/source/guides/admin-guides/basic_concepts/xcat_db/index.rst b/source/guides/admin-guides/basic_concepts/xcat_db/index.rst index a202a8c9f..d3d4212fd 100644 --- a/source/guides/admin-guides/basic_concepts/xcat_db/index.rst +++ b/source/guides/admin-guides/basic_concepts/xcat_db/index.rst @@ -1,11 +1,20 @@ -xCAT Database -============= +Database +======== -Definition of xCAT DB ---------------------- +xCAT stores all the persistent data used to manage clusters in a database. -How to Manipulate xCAT DB -------------------------- +As the administrator, you can use a set of table oriented commands to modify the data (**recommended**), or directly modify the table using the ``tabedit`` command. -How to Use Regular Expression in xCAT DB ----------------------------------------- +For a more indepth overview see the manpage for xcatdb: ``man xcatdb`` + +Commands +-------- + +Object Definitions +------------------ + +Node Groups +----------- + +Regular Expressions +------------------- diff --git a/source/guides/admin-guides/basic_concepts/xcat_object/group.rst b/source/guides/admin-guides/basic_concepts/xcat_object/group.rst new file mode 100644 index 000000000..acb591df6 --- /dev/null +++ b/source/guides/admin-guides/basic_concepts/xcat_object/group.rst @@ -0,0 +1,2 @@ +``group`` +========= diff --git a/source/guides/admin-guides/basic_concepts/xcat_object/index.rst b/source/guides/admin-guides/basic_concepts/xcat_object/index.rst index a9eb888ce..df5d96fd2 100644 --- a/source/guides/admin-guides/basic_concepts/xcat_object/index.rst +++ b/source/guides/admin-guides/basic_concepts/xcat_object/index.rst @@ -1,12 +1,9 @@ -xCAT Object -=========== +Objects +======= -Node Object ------------ -Node Range +.. toctree:: + :maxdepth: 2 -OSimage Object --------------- - -Group Object ------------- + node.rst + osimage.rst + group.rst diff --git a/source/guides/admin-guides/basic_concepts/xcat_object/node.rst b/source/guides/admin-guides/basic_concepts/xcat_object/node.rst new file mode 100644 index 000000000..267f86f31 --- /dev/null +++ b/source/guides/admin-guides/basic_concepts/xcat_object/node.rst @@ -0,0 +1,5 @@ +``node`` +======== + +Node Range +---------- diff --git a/source/guides/admin-guides/basic_concepts/xcat_object/osimage.rst b/source/guides/admin-guides/basic_concepts/xcat_object/osimage.rst new file mode 100644 index 000000000..c4549b949 --- /dev/null +++ b/source/guides/admin-guides/basic_concepts/xcat_object/osimage.rst @@ -0,0 +1,2 @@ +``osimage`` +===========