Jika/oc2r
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update fs readme.

Browse Source
This commit is contained in:
Florian Nücke
2021-05-24 04:57:05 +02:00
parent dc52493f99
commit be32489d5f
1 changed files with 8 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
src/main/resources/data/oc2/file_systems/README.md
View File

@@ -1,7 +1,7 @@
It is possible to provide additional read-only data to virtual machines using data packs.
For this to work, a descriptor file must be placed in the `file_systems` directory. The descriptor must be a JSON file
with a name ending in `.fs.json`. The file must have the following format:
For this to work, a descriptor file must be placed in the `file_systems` directory. The descriptor must be a JSON file.
The file must have the following format:
```json
{
@@ -10,24 +10,16 @@ with a name ending in `.fs.json`. The file must have the following format:
}
```
For example, to provide additional files for the layered 9pFS exposed to virtual machines, the type must be `virtio-9p`
and the extra field `location` must be provided, containing a resource location pointing to the root of the path to
For example, to provide additional files for the layered 9pFS exposed to virtual machines, the type must be `layer` and
the extra field `location` must be provided, containing a resource location pointing to the ZIP containing the layer to
expose. Example:
```json
{
"type": "virtio-9p",
"location": "oc2:file_systems/scripts"
"type": "layer",
"location": "oc2:file_systems/scripts.zip"
}
```
All files in paths exposed this way will be flagged non-executable by default. To mark a file executable, place
a `.mcmeta` file with the following content next to:
```json
{
"attributes": {
"is_executable": true
}
}
```
An optional `order` field of type integer may be provided to control the order in which layers are used. This allows
overriding files in other layers, if necessary.