add expected value info

canonical · Jul 30, 2024 · d19a3c0 · d19a3c0
1 parent 037caa1
commit d19a3c0
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/controllers/cloudinit/scripts/00-install-microk8s.sh b/controllers/cloudinit/scripts/00-install-microk8s.sh
@@ -4,8 +4,9 @@
 #   $0 $microk8s_snap_args $disable_default_cni
 #
 # Arguments:
-#   $microk8s_snap_args   Arguments to pass to snap install
-#   $disable_default_cni  Boolean flag to disable the default CNI
+#   $microk8s_snap_args   Arguments to pass to snap install.
+#   $disable_default_cni  Boolean flag (true or false) to disable the default CNI.
+#                         Note: the boolean value should not be quoted.
 #
 # Assumptions:
 #   - snapd is installed