doc/preseed: Add missing ceph public_network field in the preseed Y…

…AML file. * Add missing field in preseed YAML file. * Add more explanations on what resources the Ceph networks are conveying. Signed-off-by: Gabriel Mougard <[email protected]>
canonical · Nov 6, 2024 · 37a4966 · 37a4966
1 parent 61e114b
commit 37a4966
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/doc/how-to/add_machine.md b/doc/how-to/add_machine.md
@@ -28,5 +28,5 @@ The preseed YAML file must use the following syntax:
 
 ```{literalinclude} preseed.yaml
 :language: YAML
-:emphasize-lines: 1-3,6-8,11-12,19,29-33
+:emphasize-lines: 1-3,6-8,11-12,15-17,20,23-25,28-33,61-64,70,77-85
 ```
diff --git a/doc/how-to/initialise.md b/doc/how-to/initialise.md
@@ -155,5 +155,5 @@ The preseed YAML file must use the following syntax:
 
 ```{literalinclude} preseed.yaml
 :language: YAML
-:emphasize-lines: 1-3,6-8,11-12,19,29-33
+:emphasize-lines: 1-3,6-8,11-12,15-17,20,23-25,28-33,61-64,70,77-85
 ```
diff --git a/doc/how-to/preseed.yaml b/doc/how-to/preseed.yaml
@@ -60,10 +60,12 @@ systems:
 
 # `ceph` is optional and represents the Ceph global configuration
 # `cephfs: true` can be used to optionally set up a CephFS file system alongside Ceph distributed storage.
-# `internal_network: subnet` optionally specifies the internal cluster network for the Ceph cluster.
+# `internal_network: subnet` optionally specifies the internal cluster network for the Ceph cluster. This network handles OSD heartbeats, object replication, and recovery traffic.
+# `public_network: subnet` optionally specifies the public network for the Ceph cluster. This network conveys information regarding the management of your Ceph nodes. It is by default set to the MicroCloud lookup subnet.
 ceph:
   cephfs: true
   internal_network: 10.0.1.0/24
+  public_network: 10.0.0.0/24
 
 # `ovn` is optional and represents the OVN & uplink network configuration for LXD.
 ovn: