Add docstring for Node.config()

fabric-testbed · Sep 7, 2023 · ce62687 · ce62687
1 parent 9985c7a
commit ce62687
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/fabrictestbed_extensions/fablib/node.py b/fabrictestbed_extensions/fablib/node.py
@@ -2990,6 +2990,25 @@ def set_run_update_commands(self, run_update_commands: bool = True):
         self.set_fablib_data(fablib_data)
 
     def config(self, log_dir="."):
+        """
+        Run configuration tasks for this node.
+
+        Configuration tasks include:
+
+            - Setting hostname.
+
+            - Configuring interfaces.
+
+            - Configuring routes.
+
+            - Running post-boot tasks added by
+              ``add_post_boot_execute()``,
+              ``add_post_boot_upload_file()``, and
+              ``add_post_boot_upload_directory()``.
+
+            - Running post-update commands added by
+              ``add_post_update_command()``.
+        """
         self.execute(f"sudo hostnamectl set-hostname '{self.get_name()}'", quiet=True)
 
         for iface in self.get_interfaces():