doc: add type documentation

coreos · Aug 29, 2023 · 5ed3d39 · 5ed3d39
1 parent 586a029
commit 5ed3d39
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 7 deletions.
diff --git a/config/fcos/v1_6_exp/schema.go b/config/fcos/v1_6_exp/schema.go
@@ -22,13 +22,13 @@ type Config struct {
 	base.Config `yaml:",inline"`
 	BootDevice  BootDevice `yaml:"boot_device"`
 	Grub        Grub       `yaml:"grub"`
+	Selinux     Selinux    `yaml:"selinux"`
 }
 
 type BootDevice struct {
-	Layout  *string          `yaml:"layout"`
-	Luks    BootDeviceLuks   `yaml:"luks"`
-	Mirror  BootDeviceMirror `yaml:"mirror"`
-	Selinux Selinux          `yaml:"selinux"`
+	Layout *string          `yaml:"layout"`
+	Luks   BootDeviceLuks   `yaml:"luks"`
+	Mirror BootDeviceMirror `yaml:"mirror"`
 }
 
 type BootDeviceLuks struct {
@@ -52,7 +52,6 @@ type GrubUser struct {
 }
 
 type Selinux struct {
-	State *string `yaml:"state"`
-	Mode  *string `yaml:"mode"`
-	Path  *string `yaml:"path"`
+	State *bool `yaml:"state"`
+	Mode  *bool `yaml:"mode"`
 }
diff --git a/docs/config-fcos-v1_6-exp.md b/docs/config-fcos-v1_6-exp.md
@@ -224,3 +224,6 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
   * **_users_** (list of objects): the list of GRUB superusers.
     * **name** (string): the user name.
     * **password_hash** (string): the PBKDF2 password hash, generated with `grub2-mkpasswd-pbkdf2`.
+* **_selinux_** (object): describes the desired GRUB bootloader configuration.
+  * **state** (boolean): SELinux defines the security state by being `enabled` or `disabled`. When enabled, SElinux operates in two modes.
+  * **mode** (boolean): The two modes available are `enforcing`, which enforces security policies and `permissive`, which only logs policy violations.