diff --git a/docs/source/guides/admin-guides/references/man8/makegocons.8.rst b/docs/source/guides/admin-guides/references/man8/makegocons.8.rst index 76eb7a5fc..6ceff8ae6 100644 --- a/docs/source/guides/admin-guides/references/man8/makegocons.8.rst +++ b/docs/source/guides/admin-guides/references/man8/makegocons.8.rst @@ -19,9 +19,7 @@ SYNOPSIS ******** -\ **makegocons**\ [\ **-V|-**\ **-verbose**\ ] [\ **-d|-**\ **-delete**\ ] [\ *noderange*\ ] - -\ **makeconservercf**\ [\ **-h|-**\ **-help|-v|-**\ **-version**\ ] +\ **makegocons**\ [\ **-V|-**\ **-verbose**\ ] [\ **-d|-**\ **-delete**\ ] [\ **-q|-**\ **-query**\ ] [\ *noderange*\ ] *********** @@ -46,17 +44,18 @@ In the case of a hierarchical cluster (i.e. one with service nodes) \ **makegoco which nodes will have their consoles accessed from the management node and which from a service node (based on the nodehm.conserver attribute). +To start goconserver on the specified service node, setup goconserver package on that service node, then set +the \ **console**\ column of \ **servicenode**\ table to \ **2**\ . + +To support diskless service node, a new column \ **consoleenabled**\ has been added in \ **nodehm**\ table, it is used by \ **makegocons**\ +command to save the current console state for the node. After reinstalling the service node, the console storage file which maintain +the console nodes for goconserver is lost, xCAT would register the console nodes into goconserver based on \ **consoleenabled**\ attribute +when restarting xcatd service. + For openbmc which uses ssh as the terminal session connection method, goconserver can help save the system resources as goconserver could handle the ssh connection within goroutine which is more light-weighted than the command process. -\ **Note:**\ goconserver is an experimental feature, it will not be installed with xcat and will only support the systemd based systems. -Download and setup the rpm or deb package manually. Release link: - - -.. code-block:: perl - - https://github.com/chenglch/goconserver/releases - +\ **Note:**\ goconserver only support the systemd based systems. It has been integrated with xCAT as a recommended package. ******* @@ -71,6 +70,12 @@ OPTIONS +\ **-q|-**\ **-query**\ + + List the console connection of the nodes. If noderange is not specified, all of the console nodes will be displayed. + + + \ **-v|-**\ **-version**\ Display version. @@ -141,6 +146,16 @@ EXAMPLES +4. To list console connection for node01. + + + .. code-block:: perl + + makegocons -q node01 + + + + ******** SEE ALSO diff --git a/xCAT-client/pods/man8/makegocons.8.pod b/xCAT-client/pods/man8/makegocons.8.pod index 504c9dd69..ca17bb122 100644 --- a/xCAT-client/pods/man8/makegocons.8.pod +++ b/xCAT-client/pods/man8/makegocons.8.pod @@ -4,9 +4,7 @@ B - Register or unregister the node in the goconserver service =head1 SYNOPSIS -B [B<-V|--verbose>] [B<-d|--delete>] [I] - -B [B<-h|--help|-v|--version>] +B [B<-V|--verbose>] [B<-d|--delete>] [B<-q|--query>] [I] =head1 DESCRIPTION @@ -28,13 +26,19 @@ In the case of a hierarchical cluster (i.e. one with service nodes) B column of B table to B<2>. + +To support diskless service node, a new column B has been added in B table, it is used by B +command to save the current console state for the node. After reinstalling the service node, the console storage file which maintain +the console nodes by goconserver is lost, xCAT would register the console nodes into goconserver based on B attribute +when restarting xcatd service. + For openbmc which uses ssh as the terminal session connection method, goconserver can help save the system resources as goconserver could handle the ssh connection within goroutine which is more light-weighted than the command process. -B goconserver is an experimental feature, it will not be installed with xcat and will only support the systemd based systems. -Download and setup the rpm or deb package manually. Release link: +B goconserver only support the systemd based systems. It has been integrated with xCAT as a recommended package. - https://github.com/chenglch/goconserver/releases =head1 OPTIONS @@ -44,6 +48,10 @@ Download and setup the rpm or deb package manually. Release link: Delete rather than add or refresh the nodes specified as a noderange. +=item B<-q|--query> + +List the console connection of the nodes. If noderange is not specified, all of the console nodes will be displayed. + =item B<-v|--version> Display version. @@ -90,6 +98,11 @@ To remove goconserver configuration for node01. makegocons -d node01 +=item 4. +To list console connection for node01. + + makegocons -q node01 + =back =head1 SEE ALSO