xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-06-03 03:50:08 +00:00
Code Issues Releases Wiki Activity

Merge pull request #4816 from chenglch/goconsmanpage

Browse Source 
Add makegocons -q in the man page
This commit is contained in:
Mark Gurevich 2018-02-28 09:12:30 -05:00 committed by GitHub
commit a931bc32d5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 45 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/source/guides/admin-guides/references/man8/makegocons.8.rst
View File

@ -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

25
xCAT-client/pods/man8/makegocons.8.pod
View File

@ -4,9 +4,7 @@ B<makegocons> - Register or unregister the node in the goconserver service
=head1 SYNOPSIS
B<makegocons> [B<-V|--verbose>] [B<-d|--delete>] [I<noderange>]
B<makeconservercf> [B<-h|--help|-v|--version>]
B<makegocons> [B<-V|--verbose>] [B<-d|--delete>] [B<-q|--query>] [I<noderange>]
=head1 DESCRIPTION
@ -28,13 +26,19 @@ In the case of a hierarchical cluster (i.e. one with service nodes) B<makegocons
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 B<console> column of B<servicenode> table to B<2>.
To support diskless service node, a new column B<consoleenabled> has been added in B<nodehm> table, it is used by B<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 by goconserver is lost, xCAT would register the console nodes into goconserver based on B<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.
B<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:
B<Note:> 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