yo/gocage
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Update README

Browse Source
This commit is contained in:
yo 2024-09-22 19:39:42 +02:00
parent b72c432a47
commit 1e2f937cb5
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -26,7 +26,7 @@ Create basejail. A basejail is a jail based on a release: system will be nullfs
List jails List jails
---------- ----------
<pre><code>gocage list<code></pre> <pre><code>gocage list</code></pre>
### Specify fields to display ### Specify fields to display
@ -61,7 +61,7 @@ Just add name on gocage list command :
+-----+---------+-----------------+-----------------------+---------+ +-----+---------+-----------------+-----------------------+---------+
| 41 | srv-web | 13.0-RELEASE-p4 | vnet0|192.168.1.26/24 | true | | 41 | srv-web | 13.0-RELEASE-p4 | vnet0|192.168.1.26/24 | true |
+-----+---------+-----------------+-----------------------+---------+ +-----+---------+-----------------+-----------------------+---------+
</pre></code> </code></pre>
### By field value ### By field value
You can filter jails with -f option, followed by key=value. Suppose you want to see only active at boot jails: You can filter jails with -f option, followed by key=value. Suppose you want to see only active at boot jails:
@ -77,7 +77,7 @@ You can filter jails with -f option, followed by key=value. Suppose you want to
+-----+----------+---------+-------------+----------------+ +-----+----------+---------+-------------+----------------+
| 22 | srv-dns1 | true | 1 | | | 22 | srv-dns1 | true | 1 | |
+-----+----------+---------+-------------+----------------+ +-----+----------+---------+-------------+----------------+
</pre></code> </code></pre>
Now, only active at boot and running : Now, only active at boot and running :
<pre><code>gocage list -f Config.Boot=1,Running=true -o JID,Name,Running,Config.Boot <pre><code>gocage list -f Config.Boot=1,Running=true -o JID,Name,Running,Config.Boot
@ -90,7 +90,7 @@ Now, only active at boot and running :
+-----+----------+---------+-------------+ +-----+----------+---------+-------------+
| 22 | srv-dns1 | true | 1 | | 22 | srv-dns1 | true | 1 |
+-----+----------+---------+-------------+ +-----+----------+---------+-------------+
</pre></code> </code></pre>
Sort jails Sort jails
---------- ----------
@ -105,7 +105,7 @@ Use -s switch followed by sort criteria. Criteria is a field name, prefixed with
+-----+----------+---------+-------------+ +-----+----------+---------+-------------+
| 183 | test | true | 1 | | 183 | test | true | 1 |
+-----+----------+---------+-------------+ +-----+----------+---------+-------------+
</pre></code> </code></pre>
You can use up to 3 criteria, delimited with comma. You can use up to 3 criteria, delimited with comma.
As an example, you want to list boot priorities of automatically starting jails: As an example, you want to list boot priorities of automatically starting jails:
@ -121,27 +121,27 @@ As an example, you want to list boot priorities of automatically starting jails:
+-----+--------------+-----------------------+-----------------+-------------+---------+ +-----+--------------+-----------------------+-----------------+-------------+---------+
| 4 | coincoin | vnet0|192.168.1.9/24 | 20 | 0 | true | | 4 | coincoin | vnet0|192.168.1.9/24 | 20 | 0 | true |
+-----+--------------+-----------------------+-----------------+-------------+---------+ +-----+--------------+-----------------------+-----------------+-------------+---------+
</pre></code> </code></pre>
Stop jails Stop jails
---------- ----------
<pre><code>gocage stop test<code></pre> <pre><code>gocage stop test</code></pre>
Update jails Update jails
---------- ----------
To update jail patch version, use gocage update : To update jail patch version, use gocage update :
<pre><code>gocage update test<code></pre> <pre><code>gocage update test</code></pre>
Update basejails/releases Update basejails/releases
---------- ----------
To update basejails, you need to update the release they are based on. Specify release with -r, and the datastore storing concerned release with -d : To update basejails, you need to update the release they are based on. Specify release with -r, and the datastore storing concerned release with -d :
<pre><code>gocage update -d fastgocage -r 14.1-RELEASE<code></pre> <pre><code>gocage update -d fastgocage -r 14.1-RELEASE</code></pre>
Upgrade jails Upgrade jails
---------- ----------
To upgrade jail to newer release, use gocage upgrade : To upgrade jail to newer release, use gocage upgrade :
<pre><code>gocage upgrade -r 13.2-RELEASE test<code></pre> <pre><code>gocage upgrade -r 13.2-RELEASE test</code></pre>
A pre-upgrade snapshot wil be made so you can rollback if needed. A pre-upgrade snapshot wil be made so you can rollback if needed.
@ -162,7 +162,7 @@ You can now update ports.
Delete jails Delete jails
---------- ----------
<pre><code>gocage destroy test<code></pre> <pre><code>gocage destroy test</code></pre>
Multi datastore Multi datastore
@ -171,7 +171,7 @@ A datastore is a ZFS dataset mounted. It should be declared in gocage.conf.yml,
<pre><code>datastore: <pre><code>datastore:
- /iocage - /iocage
- /fastiocage - /fastiocage
</pre></code> </code></pre>
In gocage commands, datastore name is the mountpoint without its "/" prefix. In gocage commands, datastore name is the mountpoint without its "/" prefix.
@ -184,7 +184,7 @@ In gocage commands, datastore name is the mountpoint without its "/" prefix.
+------------+-------------+------------+-----------+----------+------------+ +------------+-------------+------------+-----------+----------+------------+
| fastiocage | /fastiocage | ssd/iocage | 1.5 TB | 65.3 KB | 34.6 KB | | fastiocage | /fastiocage | ssd/iocage | 1.5 TB | 65.3 KB | 34.6 KB |
+------------+-------------+------------+-----------+----------+------------+ +------------+-------------+------------+-----------+----------+------------+
</pre></code> </code></pre>
### Filter datastores ### Filter datastores
As with jails and snapshots, you can filter by name: As with jails and snapshots, you can filter by name:
@ -194,7 +194,7 @@ As with jails and snapshots, you can filter by name:
+============+=============+============+===========+==========+============+ +============+=============+============+===========+==========+============+
| iocage | /iocage | hdd/iocage | 1.6 TB | 414.9 GB | 27.5 KB | | iocage | /iocage | hdd/iocage | 1.6 TB | 414.9 GB | 27.5 KB |
+------------+-------------+------------+-----------+----------+------------+ +------------+-------------+------------+-----------+----------+------------+
</pre></code> </code></pre>
### Sort datastores ### Sort datastores
You can sort datastores: You can sort datastores:
@ -206,7 +206,7 @@ You can sort datastores:
+------------+-------------+------------+-----------+----------+------------+ +------------+-------------+------------+-----------+----------+------------+
| fastiocage | /fastiocage | ssd/iocage | 1.5 TB | 65.3 KB | 34.6 KB | | fastiocage | /fastiocage | ssd/iocage | 1.5 TB | 65.3 KB | 34.6 KB |
+------------+-------------+------------+-----------+----------+------------+ +------------+-------------+------------+-----------+----------+------------+
</pre></code> </code></pre>
See [cmd/struct.go](https://git.nosd.in/yo/gocage/src/branch/master/cmd/struct.go) for field names. See [cmd/struct.go](https://git.nosd.in/yo/gocage/src/branch/master/cmd/struct.go) for field names.
@ -226,7 +226,7 @@ Snapshot data/iocage/jails/srv-random: Done
Snapshot data/iocage/jails/srv-random/root: Done Snapshot data/iocage/jails/srv-random/root: Done
Migrate jail config dataset to fastdata/iocage/jails/srv-random: Done Migrate jail config dataset to fastdata/iocage/jails/srv-random: Done
Migrate jail filesystem dataset to fastdata/iocage/jails/srv-random/root: Done Migrate jail filesystem dataset to fastdata/iocage/jails/srv-random/root: Done
</pre></code> </code></pre>
Fetch Fetch
@ -234,7 +234,7 @@ Fetch
Files can be fetched from custom repository, or from local directory with "from" option. Files can be fetched from custom repository, or from local directory with "from" option.
For example if you destroyed releases/12.3-RELEASE and still have the downloaded files in /iocage/download/12.3-RELEASE: For example if you destroyed releases/12.3-RELEASE and still have the downloaded files in /iocage/download/12.3-RELEASE:
<pre><code>gocage fetch -r 12.3 -d iocage -f file:/iocage/download <pre><code>gocage fetch -r 12.3 -d iocage -f file:/iocage/download
</pre></code> </code></pre>
TODO TODO