From 25141161e57d55b3517ae03b891ac63c3886e7b8 Mon Sep 17 00:00:00 2001 From: chenglch Date: Tue, 5 Dec 2017 11:48:34 +0800 Subject: [PATCH 1/2] Add man page for makegocons This is the guide about how to make goconserver as a replacement for conserver to help slove the issues reported for conserver, like: #4043, #3543. For openbmc, the solution of goconserver is much light-weighted than the conserver which could help save the system resource. In addition, sshpass is not needed for openbmc with goconserver. Implement: #4337 --- .../references/man8/makegocons.8.rst | 151 ++++++++++++++++++ xCAT-client/pods/man8/makegocons.8.pod | 98 ++++++++++++ 2 files changed, 249 insertions(+) create mode 100644 docs/source/guides/admin-guides/references/man8/makegocons.8.rst create mode 100644 xCAT-client/pods/man8/makegocons.8.pod diff --git a/docs/source/guides/admin-guides/references/man8/makegocons.8.rst b/docs/source/guides/admin-guides/references/man8/makegocons.8.rst new file mode 100644 index 000000000..48db64c1f --- /dev/null +++ b/docs/source/guides/admin-guides/references/man8/makegocons.8.rst @@ -0,0 +1,151 @@ + +############ +makegocons.8 +############ + +.. highlight:: perl + + +**** +NAME +**** + + +\ **makegocons**\ - Register or unregister the node in the goconserver service + + +******** +SYNOPSIS +******** + + +\ **makegocons**\ [\ **-V|-**\ **-verbose**\ ] [\ **-d|-**\ **-delete**\ ] [\ *noderange*\ ] + +\ **makeconservercf**\ [\ **-h|-**\ **-help|-v|-**\ **-version**\ ] + + +*********** +DESCRIPTION +*********** + + +The \ **makegocons**\ command will start the goconserver service if it is not started, then +send the rest request to create or delete the session resource in the goconserver service. The session +information including the session command or ssh connection parameters (for openbmc) is generated by xcat +based on the records in the related tables (e.g. nodehm, ipmi, ppc, openbmc). + +By default \ **makegocons**\ will register the session for all of the nodes in xcat. + +If a \ *noderange*\ is specified, only the session in the specified scope will be affected, goconserver +service will not be restarted and the the other session will not be disconnected. This is the advantage +of goconserver compare with the conserver service with \ **makeconservercf**\ . + +If \ **-d**\ is specified, \ **makegocons**\ will remove the session in the goconserver service. + +In the case of a hierarchical cluster (i.e. one with service nodes) \ **makegocons**\ will determine +which nodes will have their consoles accessed from the management node and which from a service node +(based on the nodehm.conserver attribute). + +For openbmc which use ssh as the terminal session connection method, goconserver can help save the system +resource as goconserver could handle the ssh connection within goruntine which is much light-weighted than the command process. + +\ **Note:**\ goconserver is a experimental feature, it will not be installed with xcat and only support the systemd based systems. +Please download and setup the rpm or deb package manually. Release link: + + +.. code-block:: perl + + https://github.com/chenglch/goconserver/releases + + + +******* +OPTIONS +******* + + + +\ **-d|-**\ **-delete**\ + + Delete rather than add or refresh the nodes specified as a noderange. + + + +\ **-v|-**\ **-version**\ + + Display version. + + + +\ **-V|-**\ **-verbose**\ + + Verbose mode. + + + +\ **-h|-**\ **-help**\ + + Display usage message. + + + + +************ +RETURN VALUE +************ + + + +0. The command completed successfully. + + + +1. An error has occurred. + + + + +******** +EXAMPLES +******** + + + +1. To create goconserver configuration for all the nodes. + + + .. code-block:: perl + + makegocons + + + + +2. To create goconserver configuration for nodes node01-node10. + + + .. code-block:: perl + + makegocons node01-node10 + + + + +3. To remove goconserver configuration for node01. + + + .. code-block:: perl + + makegocons -d node01 + + + + + +******** +SEE ALSO +******** + + +rcons(1)|rcons.1 + diff --git a/xCAT-client/pods/man8/makegocons.8.pod b/xCAT-client/pods/man8/makegocons.8.pod new file mode 100644 index 000000000..f3950fbd1 --- /dev/null +++ b/xCAT-client/pods/man8/makegocons.8.pod @@ -0,0 +1,98 @@ +=head1 NAME + +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>] + + +=head1 DESCRIPTION + +The B command will start the goconserver service if it is not started, then +send the rest request to create or delete the session resource in the goconserver service. The session +information including the session command or ssh connection parameters (for openbmc) is generated by xcat +based on the records in the related tables (e.g. nodehm, ipmi, ppc, openbmc). + +By default B will register the session for all of the nodes in xcat. + +If a I is specified, only the session in the specified scope will be affected, goconserver +service will not be restarted and the the other session will not be disconnected. This is the advantage +of goconserver compare with the conserver service with B. + +If B<-d> is specified, B will remove the session in the goconserver service. + +In the case of a hierarchical cluster (i.e. one with service nodes) B will determine +which nodes will have their consoles accessed from the management node and which from a service node +(based on the nodehm.conserver attribute). + +For openbmc which use ssh as the terminal session connection method, goconserver can help save the system +resource as goconserver could handle the ssh connection within goruntine which is much light-weighted than the command process. + +B goconserver is a experimental feature, it will not be installed with xcat and only support the systemd based systems. +Please download and setup the rpm or deb package manually. Release link: + + https://github.com/chenglch/goconserver/releases + +=head1 OPTIONS + +=over 10 + +=item B<-d|--delete> + +Delete rather than add or refresh the nodes specified as a noderange. + +=item B<-v|--version> + +Display version. + +=item B<-V|--verbose> + +Verbose mode. + +=item B<-h|--help> + +Display usage message. + +=back + + +=head1 RETURN VALUE + +=over 2 + +=item 0. +The command completed successfully. + +=item 1. +An error has occurred. + +=back + +=head1 EXAMPLES + +=over 2 + +=item 1. +To create goconserver configuration for all the nodes. + + makegocons + +=item 2. +To create goconserver configuration for nodes node01-node10. + + makegocons node01-node10 + +=item 3. +To remove goconserver configuration for node01. + + makegocons -d node01 + +=back + +=head1 SEE ALSO + +L + From 2361f1c5e9a2bf4c70cbd79fc02428f8332b2036 Mon Sep 17 00:00:00 2001 From: chenglch Date: Wed, 6 Dec 2017 10:59:47 +0800 Subject: [PATCH 2/2] Fix the typo in the man page of makegocons --- .../admin-guides/references/man8/makegocons.8.rst | 14 +++++++------- xCAT-client/pods/man8/makegocons.8.pod | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) 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 48db64c1f..76eb7a5fc 100644 --- a/docs/source/guides/admin-guides/references/man8/makegocons.8.rst +++ b/docs/source/guides/admin-guides/references/man8/makegocons.8.rst @@ -30,15 +30,15 @@ DESCRIPTION The \ **makegocons**\ command will start the goconserver service if it is not started, then -send the rest request to create or delete the session resource in the goconserver service. The session +send the REST request to create or delete the session resource in the goconserver service. The session information including the session command or ssh connection parameters (for openbmc) is generated by xcat based on the records in the related tables (e.g. nodehm, ipmi, ppc, openbmc). By default \ **makegocons**\ will register the session for all of the nodes in xcat. If a \ *noderange*\ is specified, only the session in the specified scope will be affected, goconserver -service will not be restarted and the the other session will not be disconnected. This is the advantage -of goconserver compare with the conserver service with \ **makeconservercf**\ . +service will not be restarted and the other session will not be disconnected. This is the advantage +of goconserver over the conserver service with \ **makeconservercf**\ . If \ **-d**\ is specified, \ **makegocons**\ will remove the session in the goconserver service. @@ -46,11 +46,11 @@ 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). -For openbmc which use ssh as the terminal session connection method, goconserver can help save the system -resource as goconserver could handle the ssh connection within goruntine which is much light-weighted than the command process. +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 a experimental feature, it will not be installed with xcat and only support the systemd based systems. -Please download and setup the rpm or deb package manually. Release link: +\ **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 diff --git a/xCAT-client/pods/man8/makegocons.8.pod b/xCAT-client/pods/man8/makegocons.8.pod index f3950fbd1..504c9dd69 100644 --- a/xCAT-client/pods/man8/makegocons.8.pod +++ b/xCAT-client/pods/man8/makegocons.8.pod @@ -12,15 +12,15 @@ B [B<-h|--help|-v|--version>] =head1 DESCRIPTION The B command will start the goconserver service if it is not started, then -send the rest request to create or delete the session resource in the goconserver service. The session +send the REST request to create or delete the session resource in the goconserver service. The session information including the session command or ssh connection parameters (for openbmc) is generated by xcat based on the records in the related tables (e.g. nodehm, ipmi, ppc, openbmc). By default B will register the session for all of the nodes in xcat. If a I is specified, only the session in the specified scope will be affected, goconserver -service will not be restarted and the the other session will not be disconnected. This is the advantage -of goconserver compare with the conserver service with B. +service will not be restarted and the other session will not be disconnected. This is the advantage +of goconserver over the conserver service with B. If B<-d> is specified, B will remove the session in the goconserver service. @@ -28,11 +28,11 @@ In the case of a hierarchical cluster (i.e. one with service nodes) B goconserver is a experimental feature, it will not be installed with xcat and only support the systemd based systems. -Please download and setup the rpm or deb package manually. Release link: +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: https://github.com/chenglch/goconserver/releases