Skip to content

Commit

Permalink
doc:reference: mention YAML spec version and expected file permissions
Browse files Browse the repository at this point in the history
(LP: 1999669 & LP: 1981646)
  • Loading branch information
slyon committed Jan 24, 2023
1 parent db608aa commit db04380
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions doc/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@

## YAML configuration
Netplan's configuration files use the
[YAML](<http://yaml.org/spec/1.1/current.html>) format. All
`/{lib,etc,run}/netplan/*.yaml` are considered.
[YAML (v1.1)](<http://yaml.org/spec/1.1/current.html>) format. All files in
`/{lib,etc,run}/netplan/*.yaml` are considered and are supposed to use
restrictive file permissions (`600` / `rw-------`), i.e. owner (root) read-write
only.

The top-level node in a netplan configuration file is a ``network:`` mapping
that contains ``version: 2`` (the YAML currently being used by curtin, MaaS,
Expand Down

0 comments on commit db04380

Please sign in to comment.