Skip to content

Commit e18d86d

Browse files
committed
[docs] floppy_content docs
1 parent 3ec48ec commit e18d86d

File tree

4 files changed

+60
-0
lines changed

4 files changed

+60
-0
lines changed

.web-docs/components/builder/iso/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,21 @@ In HCL2:
236236
your floppy disk includes drivers or if you just want to organize it's
237237
contents as a hierarchy. Wildcard characters (\*, ?, and \[\]) are allowed.
238238

239+
- `floppy_content` (map[string]string) - Key/Values to add to the floppy disk. The keys represent the paths, and
240+
the values contents. It can be used alongside `floppy_files` or
241+
`floppy_dirs`, which is useful to add large files without loading them
242+
into memory. If any paths are specified by both, the contents in
243+
`floppy_content` will take precedence.
244+
245+
HCL Example:
246+
247+
```hcl
248+
floppy_content = {
249+
"meta-data" = jsonencode(local.instance_data)
250+
"user-data" = templatefile("user-data", { packages = ["nginx"] })
251+
}
252+
```
253+
239254
- `floppy_label` (string) - The label to use for the floppy disk that
240255
is attached when the VM is booted. This is most useful for cloud-init,
241256
Kickstart or other early initialization tools, which can benefit from labelled floppy disks.

.web-docs/components/builder/pvm/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,21 @@ can also be supplied to override the typical auto-generated key:
8888
your floppy disk includes drivers or if you just want to organize it's
8989
contents as a hierarchy. Wildcard characters (\*, ?, and \[\]) are allowed.
9090

91+
- `floppy_content` (map[string]string) - Key/Values to add to the floppy disk. The keys represent the paths, and
92+
the values contents. It can be used alongside `floppy_files` or
93+
`floppy_dirs`, which is useful to add large files without loading them
94+
into memory. If any paths are specified by both, the contents in
95+
`floppy_content` will take precedence.
96+
97+
HCL Example:
98+
99+
```hcl
100+
floppy_content = {
101+
"meta-data" = jsonencode(local.instance_data)
102+
"user-data" = templatefile("user-data", { packages = ["nginx"] })
103+
}
104+
```
105+
91106
- `floppy_label` (string) - The label to use for the floppy disk that
92107
is attached when the VM is booted. This is most useful for cloud-init,
93108
Kickstart or other early initialization tools, which can benefit from labelled floppy disks.

docs/builders/iso.mdx

+15
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,21 @@ can also be supplied to override the typical auto-generated key:
124124
your floppy disk includes drivers or if you just want to organize it's
125125
contents as a hierarchy. Wildcard characters (\*, ?, and \[\]) are allowed.
126126

127+
- `floppy_content` (map[string]string) - Key/Values to add to the floppy disk. The keys represent the paths, and
128+
the values contents. It can be used alongside `floppy_files` or
129+
`floppy_dirs`, which is useful to add large files without loading them
130+
into memory. If any paths are specified by both, the contents in
131+
`floppy_content` will take precedence.
132+
133+
HCL Example:
134+
135+
```hcl
136+
floppy_content = {
137+
"meta-data" = jsonencode(local.instance_data)
138+
"user-data" = templatefile("user-data", { packages = ["nginx"] })
139+
}
140+
```
141+
127142
- `floppy_label` (string) - The label to use for the floppy disk that
128143
is attached when the VM is booted. This is most useful for cloud-init,
129144
Kickstart or other early initialization tools, which can benefit from labelled floppy disks.

docs/builders/pvm.mdx

+15
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,21 @@ can also be supplied to override the typical auto-generated key:
9898
your floppy disk includes drivers or if you just want to organize it's
9999
contents as a hierarchy. Wildcard characters (\*, ?, and \[\]) are allowed.
100100

101+
- `floppy_content` (map[string]string) - Key/Values to add to the floppy disk. The keys represent the paths, and
102+
the values contents. It can be used alongside `floppy_files` or
103+
`floppy_dirs`, which is useful to add large files without loading them
104+
into memory. If any paths are specified by both, the contents in
105+
`floppy_content` will take precedence.
106+
107+
HCL Example:
108+
109+
```hcl
110+
floppy_content = {
111+
"meta-data" = jsonencode(local.instance_data)
112+
"user-data" = templatefile("user-data", { packages = ["nginx"] })
113+
}
114+
```
115+
101116
- `floppy_label` (string) - The label to use for the floppy disk that
102117
is attached when the VM is booted. This is most useful for cloud-init,
103118
Kickstart or other early initialization tools, which can benefit from labelled floppy disks.

0 commit comments

Comments
 (0)