starlingx/docs
Code Issues Proposed changes

Update SCTP_AUTOLOAD feature details (dsR10)

Browse Source 
A new Service Parameter is introduced to configure SCTP Module loading behaviour.
Add documentation to disable SCTP autoload in Kernel.

Story: 2011335
Task: 52096

Change-Id: If64e464eec1819dcfb160b103887287ee2a628be
Signed-off-by: Elisamara Aoki Gonçalves <elisamaraaoki.goncalves@windriver.com>
This commit is contained in:
Elisamara Aoki Gonçalves
2025-04-28 21:40:29 +00:00
parent 227b9c41a2
commit 4735996c7a
2 changed files with 106 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
doc/source/system_configuration/kubernetes/disable-sctp-autoload-in-the-kernel-e16de9f1204f.rst Normal file
View File

@@ -0,0 +1,97 @@
.. WARNING: Add no lines of text between the label immediately following
.. and the title.
.. _disable-sctp-autoload-in-the-kernel-e16de9f1204f:
===================================
Disable SCTP Autoload in the Kernel
===================================
The |SCTP| module is autoloaded in the |prod| kernel by default. Thus, Service
Parameter ``sctp_autoload`` is defaulted to "enabled".
To disable |SCTP| in the kernel of all hosts in the system, set the system
service parameter sctp_autoload to "disabled" and apply the service-parameter
change, using the following commands, executed on the active controller.
.. code-block:: none
~(keystone_admin)]$ system service-parameter-modify platform config sctp_autoload=disabled
~(keystone_admin)]$ system service-parameter-apply platform
To persist the service parameter change, all hosts need to be locked and
unlocked, using the following commands for each host depending on the deployed
configuration.
For |AIO-SX| deployments.
.. code-block:: none
~(keystone_admin)$ system host-lock controller-0
~(keystone_admin)$ system host-unlock controller-0
For |AIO-DX| and Standard deployments, after controller-1 is locked/unlocked
swact controller-0 to make controller-1 the active node. The next set of
commands are executed on controller-0 node.
.. code-block:: none
~(keystone_admin)$ system host-lock controller-1
~(keystone_admin)$ system host-unlock controller-1
~(keystone_admin)$ system host-swact controller-0
On controller-1, after controller-0 is locked/unlocked swact controller-1 to go
back to controller-0 as the active node. The next set of commands are executed
on controller-1 node.
.. code-block:: none
~(keystone_admin)$ system host-lock controller-0
~(keystone_admin)$ system host-unlock controller-0
~(keystone_admin)$ system host-swact controller-1
For each worker node in the configuration, execute the commands from
controller-0.
.. code-block:: none
~(keystone_admin)$ system host-lock worker-0
~(keystone_admin)$ system host-unlock worker-0
To verify if |SCTP| modules are unloaded for a host, ssh into a host after
lock/unlock and check the output of the following commands.
.. code-block:: none
~(keystone_admin)$ sysadmin@controller-0:~$ lsmod | grep sctp
The output must be empty if |SCTP| is unloaded.
To check if this configuration persists for a host across reboots, the command below should give an empty response.
.. code-block:: none
~(keystone_admin)$ sysadmin@controller-0:~$ ls /etc/modules-load.d/ | grep sctp
To Enable |SCTP| Autoload in the Kernel.
.. code-block:: none
~(keystone_admin)]$ system service-parameter-modify platform config sctp_autoload=enabled
~(keystone_admin)]$ system service-parameter-apply platform
To enable the |SCTP| module autoload in the kernel, execute the above command
on the active controller and repeat the host lock/unlock process for every
host.
.. code-block:: none
~(keystone_admin)$ system host-lock controller-0
~(keystone_admin)$ system host-unlock controller-0
To verify if the |SCTP| module autoloads for a host.
.. code-block:: none
~(keystone_admin)$ ls /etc/modules-load.d/ | grep sctp
sctp.conf

9
doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst
View File

@@ -215,3 +215,12 @@ Customize Crash Dump Manager
:maxdepth: 1
customize-crashdumpmanager-46e0d32891a0
-----------------------------------
Disable SCTP Autoload in the Kernel
-----------------------------------
.. toctree::
:maxdepth: 1
disable-sctp-autoload-in-the-kernel-e16de9f1204f