Skip to content

Commit 99edf6c

Browse files
sonicajUser Bugclerk
authored and
User Bugclerk
committed
Add doc for plugin manifest explaining devfs_ruleset
(cherry picked from commit 49e6280)
1 parent 467154f commit 99edf6c

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

doc/source/plugins.rst

+45
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,48 @@ installed to a FreeNAS system, then the note of the plugin is changed:
7979

8080
The process for upgrading and updating plugins is exactly the same as
8181
normal jails. See :ref:`Updating Jails` or :ref:`Upgrading Jails` .
82+
83+
84+
**Plugin Manifest Example**
85+
86+
87+
Following is an example of a plugin manifest:
88+
89+
.. sourcecode:: json
90+
91+
{
92+
"name": "default_jail_name_here",
93+
"release": "11.3-RELEASE",
94+
"artifact": "https://github.com/git_path_to_plugin_repo",
95+
"official": false,
96+
"properties": {
97+
"nat": 1,
98+
"nat_forwards": "tcp(7878:7878)"
99+
},
100+
"devfs_ruleset": {
101+
"paths": {"bpf*": null},
102+
"includes": []
103+
},
104+
"pkgs": [
105+
],
106+
"packagesite": "http://pkg.FreeBSD.org/${ABI}/latest",
107+
"fingerprints": {
108+
"iocage-plugins": [
109+
{
110+
"function": "sha256",
111+
"fingerprint": "b0170035af3acc5f3f3ae1859dc717101b4e6c1d0a794ad554928ca0cbb2f438"
112+
}
113+
]
114+
},
115+
"revision": "0"
116+
}
117+
118+
* **devfs_ruleset**: It should be a valid dictionary object where "paths" must be specified. Value of "paths" is a
119+
dictionary where keys are the path to be added and the value is the mode to be used. `null` translates to `unhide`.
120+
For any include specified, please refer to the following example which shows how each path specified is added as
121+
iocage dynamically generates a devfs ruleset and how an include is added to the ruleset:
122+
123+
.. sourcecode:: shell
124+
125+
devfs rule -s ruleset_number add path bpf* unhide
126+
devfs rule -s ruleset_number add include include_value

0 commit comments

Comments
 (0)