|
|
|
@ -8,8 +8,7 @@ Gocage can handle multiple datastores, so you can have jails on HDD storage and
|
|
|
|
|
|
|
|
|
|
From v0.33b, due to multi ZFS pool support, gocage is no longer 100% compatible with iocage.
|
|
|
|
|
Zfs datasets now should be specified with the ZFS pool. e.g. :
|
|
|
|
|
<pre><code>
|
|
|
|
|
Config.Jail_zfs = 1
|
|
|
|
|
<pre><code>Config.Jail_zfs = 1
|
|
|
|
|
Config.Jail_zfs_dataset = myzfspool/poudriere
|
|
|
|
|
Config.Jail_zfs_mountpoint = none
|
|
|
|
|
</code></pre>
|
|
|
|
@ -17,25 +16,22 @@ Config.Jail_zfs_mountpoint = none
|
|
|
|
|
Create jails
|
|
|
|
|
------------
|
|
|
|
|
You need to specify release, and optional configuration:
|
|
|
|
|
<pre><code>
|
|
|
|
|
gocage create jail1 -r 13.2-RELEASE -p "Config.Ip4_addr='vnet0|192.168.1.91/24',Config.Ip6=none,Config.Boot=1"
|
|
|
|
|
<pre><code>gocage create jail1 -r 13.2-RELEASE -p "Config.Ip4_addr='vnet0|192.168.1.91/24',Config.Ip6=none,Config.Boot=1"
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
Create basejail. A basejail is a jail based on a release: system will be nullfs read-only mounted from the release directory. Main advantage is that release updates will immediately apply to jails based on this release. Another advantage is that jail system is mounted read-only, a plus from a security perspective:
|
|
|
|
|
<pre><code>
|
|
|
|
|
gocage create -b -r 14.0-RELEASE basejail1
|
|
|
|
|
<pre><code>gocage create -b -r 14.0-RELEASE basejail1
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
List jails
|
|
|
|
|
----------
|
|
|
|
|
`gocage list`
|
|
|
|
|
<pre><code>gocage list</code></pre>
|
|
|
|
|
|
|
|
|
|
### Specify fields to display
|
|
|
|
|
|
|
|
|
|
Use -o to specify which fields you want to display:
|
|
|
|
|
<pre><code>
|
|
|
|
|
gocage list -o JID,Name,Running,Config.Boot,Config.Comment
|
|
|
|
|
<pre><code>gocage list -o JID,Name,Running,Config.Boot,Config.Comment
|
|
|
|
|
+=====+==========+=========+=============+================+
|
|
|
|
|
| JID | Name | Running | Config.Boot | Config.Comment |
|
|
|
|
|
+=====+==========+=========+=============+================+
|
|
|
|
@ -49,7 +45,7 @@ gocage list -o JID,Name,Running,Config.Boot,Config.Comment
|
|
|
|
|
+-----+----------+---------+-------------+----------------+
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
See [cmd/struct.go](https://git.nosd.in/yo/gocage/src/branch/master/cmd/struct.go) for field names.
|
|
|
|
|
Use `gocage properties`to list available fields.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Filter jails
|
|
|
|
@ -57,8 +53,7 @@ Filter jails
|
|
|
|
|
|
|
|
|
|
### By name
|
|
|
|
|
Just add name on gocage list command :
|
|
|
|
|
<pre><code>
|
|
|
|
|
gocage list srv-bdd srv-web
|
|
|
|
|
<pre><code>gocage list srv-bdd srv-web
|
|
|
|
|
+=====+=========+=================+=======================+=========+
|
|
|
|
|
| JID | Name | Config.Release | Config.Ip4_addr | Running |
|
|
|
|
|
+=====+=========+=================+=======================+=========+
|
|
|
|
@ -66,12 +61,11 @@ gocage list srv-bdd srv-web
|
|
|
|
|
+-----+---------+-----------------+-----------------------+---------+
|
|
|
|
|
| 41 | srv-web | 13.0-RELEASE-p4 | vnet0|192.168.1.26/24 | true |
|
|
|
|
|
+-----+---------+-----------------+-----------------------+---------+
|
|
|
|
|
</pre></code>
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
### By field value
|
|
|
|
|
You can filter jails with -f option, followed by key=value. Suppose you want to see only active at boot jails:
|
|
|
|
|
<pre><code>
|
|
|
|
|
gocage list -f Config.Boot=1 -o JID,Name,Running,Config.Boot,Config.Comment
|
|
|
|
|
<pre><code>gocage list -f Config.Boot=1 -o JID,Name,Running,Config.Boot,Config.Comment
|
|
|
|
|
+=====+==========+=========+=============+================+
|
|
|
|
|
| JID | Name | Running | Config.Boot | Config.Comment |
|
|
|
|
|
+=====+==========+=========+=============+================+
|
|
|
|
@ -83,11 +77,10 @@ gocage list -f Config.Boot=1 -o JID,Name,Running,Config.Boot,Config.Comment
|
|
|
|
|
+-----+----------+---------+-------------+----------------+
|
|
|
|
|
| 22 | srv-dns1 | true | 1 | |
|
|
|
|
|
+-----+----------+---------+-------------+----------------+
|
|
|
|
|
</pre></code>
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
+=====+==========+=========+=============+
|
|
|
|
|
| JID | Name | Running | Config.Boot |
|
|
|
|
|
+=====+==========+=========+=============+
|
|
|
|
@ -97,13 +90,12 @@ gocage list -f Config.Boot=1,Running=true -o JID,Name,Running,Config.Boot
|
|
|
|
|
+-----+----------+---------+-------------+
|
|
|
|
|
| 22 | srv-dns1 | true | 1 |
|
|
|
|
|
+-----+----------+---------+-------------+
|
|
|
|
|
</pre></code>
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
Sort jails
|
|
|
|
|
----------
|
|
|
|
|
Use -s switch followed by sort criteria. Criteria is a field name, prefixed with + or - for sort order (increase/decrease):
|
|
|
|
|
<pre><code>
|
|
|
|
|
gocage list -f Config.Boot=1,Running=true -o JID,Name,Running,Config.Boot -s +JID
|
|
|
|
|
<pre><code>gocage list -f Config.Boot=1,Running=true -o JID,Name,Running,Config.Boot -s +JID
|
|
|
|
|
+=====+==========+=========+=============+
|
|
|
|
|
| JID | Name | Running | Config.Boot |
|
|
|
|
|
+=====+==========+=========+=============+
|
|
|
|
@ -113,12 +105,11 @@ gocage list -f Config.Boot=1,Running=true -o JID,Name,Running,Config.Boot -s +JI
|
|
|
|
|
+-----+----------+---------+-------------+
|
|
|
|
|
| 183 | test | true | 1 |
|
|
|
|
|
+-----+----------+---------+-------------+
|
|
|
|
|
</pre></code>
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
You can use up to 3 criteria, delimited with comma.
|
|
|
|
|
As an example, you want to list boot priorities of automatically starting jails:
|
|
|
|
|
<pre><code>
|
|
|
|
|
gocage list -o JID,Name,Config.Ip4_addr,Config.Priority,Config.Boot,Running -s -Config.Priority,-Config.Boot -f Running=true
|
|
|
|
|
<pre><code>gocage list -o JID,Name,Config.Ip4_addr,Config.Priority,Config.Boot,Running -s -Config.Priority,-Config.Boot -f Running=true
|
|
|
|
|
+=====+==============+=======================+=================+=============+=========+
|
|
|
|
|
| JID | Name | Config.Ip4_addr | Config.Priority | Config.Boot | Running |
|
|
|
|
|
+=====+==============+=======================+=================+=============+=========+
|
|
|
|
@ -130,27 +121,27 @@ gocage list -o JID,Name,Config.Ip4_addr,Config.Priority,Config.Boot,Running -s -
|
|
|
|
|
+-----+--------------+-----------------------+-----------------+-------------+---------+
|
|
|
|
|
| 4 | coincoin | vnet0|192.168.1.9/24 | 20 | 0 | true |
|
|
|
|
|
+-----+--------------+-----------------------+-----------------+-------------+---------+
|
|
|
|
|
</pre></code>
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Stop jails
|
|
|
|
|
----------
|
|
|
|
|
`gocage stop test`
|
|
|
|
|
<pre><code>gocage stop test</code></pre>
|
|
|
|
|
|
|
|
|
|
Update jails
|
|
|
|
|
----------
|
|
|
|
|
To update jail patch version, use gocage update :
|
|
|
|
|
`gocage update test`
|
|
|
|
|
<pre><code>gocage update test</code></pre>
|
|
|
|
|
|
|
|
|
|
Update basejails/releases
|
|
|
|
|
----------
|
|
|
|
|
To update basejails, you need to update the release they are base on. Specify release with -r, and the datastore storing concerned release with -d :
|
|
|
|
|
`gocage update -d fastgocage -r 14.1-RELEASE`
|
|
|
|
|
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>
|
|
|
|
|
|
|
|
|
|
Upgrade jails
|
|
|
|
|
----------
|
|
|
|
|
To upgrade jail to newer release, use gocage upgrade :
|
|
|
|
|
`gocage upgrade -r 13.2-RELEASE test`
|
|
|
|
|
<pre><code>gocage upgrade -r 13.2-RELEASE test</code></pre>
|
|
|
|
|
|
|
|
|
|
A pre-upgrade snapshot wil be made so you can rollback if needed.
|
|
|
|
|
|
|
|
|
@ -160,33 +151,32 @@ Upgrading basejails currently needs to be done manually, for each jail.
|
|
|
|
|
The idea is to stop the jail, change the content of its fstab file to point to the new release, then start jail.
|
|
|
|
|
If one change the fstab while the jail is running, its system directories won't be unmounted at stop time and this will provoke stop errors.
|
|
|
|
|
To minimize downtime, the change could be scripted:
|
|
|
|
|
`gocage stop jail1
|
|
|
|
|
<pre><code>gocage stop jail1
|
|
|
|
|
sed -i .bak 's/14.0-RELEASE/14.1-RELEASE/' /iocage/jails/jail1/fstab
|
|
|
|
|
# Avoid race-condition by waiting for the update in fstab
|
|
|
|
|
until grep -q 14.1-RELEASE /iocage/jails/jail1/fstab; do sleep 0.2; done
|
|
|
|
|
gocage start jail1`
|
|
|
|
|
gocage start jail1
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
You can now update ports.
|
|
|
|
|
|
|
|
|
|
Delete jails
|
|
|
|
|
----------
|
|
|
|
|
`gocage destroy test`
|
|
|
|
|
<pre><code>gocage destroy test</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Multi datastore
|
|
|
|
|
----------
|
|
|
|
|
A datastore is a ZFS dataset mounted. It should be declared in gocage.conf.yml, specifying its ZFS mountpoint :
|
|
|
|
|
<pre><code>
|
|
|
|
|
datastore:
|
|
|
|
|
<pre><code>datastore:
|
|
|
|
|
- /iocage
|
|
|
|
|
- /fastiocage
|
|
|
|
|
</pre></code>
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
In gocage commands, datastore name is the mountpoint without its "/" prefix.
|
|
|
|
|
|
|
|
|
|
### List datastores
|
|
|
|
|
<pre><code>
|
|
|
|
|
gocage datastore list
|
|
|
|
|
<pre><code>gocage datastore list
|
|
|
|
|
+============+=============+============+===========+==========+============+
|
|
|
|
|
| Name | Mountpoint | ZFSDataset | Available | Used | Referenced |
|
|
|
|
|
+============+=============+============+===========+==========+============+
|
|
|
|
@ -194,23 +184,21 @@ gocage datastore list
|
|
|
|
|
+------------+-------------+------------+-----------+----------+------------+
|
|
|
|
|
| fastiocage | /fastiocage | ssd/iocage | 1.5 TB | 65.3 KB | 34.6 KB |
|
|
|
|
|
+------------+-------------+------------+-----------+----------+------------+
|
|
|
|
|
</pre></code>
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
### Filter datastores
|
|
|
|
|
As with jails and snapshots, you can filter by name:
|
|
|
|
|
<pre><code>
|
|
|
|
|
gocage datastore list iocage
|
|
|
|
|
<pre><code>gocage datastore list iocage
|
|
|
|
|
+============+=============+============+===========+==========+============+
|
|
|
|
|
| Name | Mountpoint | ZFSDataset | Available | Used | Referenced |
|
|
|
|
|
+============+=============+============+===========+==========+============+
|
|
|
|
|
| iocage | /iocage | hdd/iocage | 1.6 TB | 414.9 GB | 27.5 KB |
|
|
|
|
|
+------------+-------------+------------+-----------+----------+------------+
|
|
|
|
|
</pre></code>
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
### Sort datastores
|
|
|
|
|
You can sort datastores:
|
|
|
|
|
<pre><code>
|
|
|
|
|
gocage datastore list -s -Available
|
|
|
|
|
<pre><code>gocage datastore list -s -Available
|
|
|
|
|
+============+=============+============+===========+==========+============+
|
|
|
|
|
| Name | Mountpoint | ZFSDataset | Available | Used | Referenced |
|
|
|
|
|
+============+=============+============+===========+==========+============+
|
|
|
|
@ -218,9 +206,9 @@ gocage datastore list -s -Available
|
|
|
|
|
+------------+-------------+------------+-----------+----------+------------+
|
|
|
|
|
| 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.
|
|
|
|
|
Use `gocage properties`to list available fields.
|
|
|
|
|
|
|
|
|
|
Migrating jails
|
|
|
|
|
----------
|
|
|
|
@ -233,26 +221,23 @@ Be aware the moment you migrate a jail to another datastore than /iocage default
|
|
|
|
|
Then you need to disable iocage service, and enable gocage so the jails will start automatically at boot.
|
|
|
|
|
Also make sure, if you don't destroy source jail, that it won't have the "boot" property set or you will have the 2 jails up at boot.
|
|
|
|
|
|
|
|
|
|
<pre><code>
|
|
|
|
|
gocage migrate -d fastiocage srv-random
|
|
|
|
|
<pre><code>gocage migrate -d fastiocage srv-random
|
|
|
|
|
Snapshot data/iocage/jails/srv-random: Done
|
|
|
|
|
Snapshot data/iocage/jails/srv-random/root: Done
|
|
|
|
|
Migrate jail config dataset to fastdata/iocage/jails/srv-random: Done
|
|
|
|
|
Migrate jail filesystem dataset to fastdata/iocage/jails/srv-random/root: Done
|
|
|
|
|
</pre></code>
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Fetch
|
|
|
|
|
----------
|
|
|
|
|
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:
|
|
|
|
|
<pre><code>
|
|
|
|
|
gocage fetch -r 12.3 -d iocage -f file:/iocage/download
|
|
|
|
|
</pre></code>
|
|
|
|
|
<pre><code>gocage fetch -r 12.3 -d iocage -f file:/iocage/download
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TODO
|
|
|
|
|
----------
|
|
|
|
|
gocage create from templates
|
|
|
|
|
gocage init
|
|
|
|
|
create default pool with defaults.json
|
|
|
|
|
|
|
|
|
|