Mise à jour de 'README.md'

This commit is contained in:
yo 2021-12-19 17:04:27 +01:00
parent 6cef2918b4
commit 754a937eb8

126
README.md
View File

@ -1,66 +1,86 @@
# gocage GoCage
=======
Jail management tool for FreeBSD, written in Go. Jail management tool for FreeBSD, written in Go.
Support iocage jails, so they can coexist. Support iocage jails, so they can coexist.
Gocage is meant to be a complete jail management tool with network, snapshots, jail cloning support and a web interface. Gocage is meant to be a complete jail management tool with network, snapshots, jail cloning support and a web interface. This is the hypothetic future.
# List jails At present time, it list and stops jails.
Nothing fancy, use
`gocage list` List jails
----------
Nothing fancy, just use
`gocage list`
### Specify fields to display
## Specify fields to display
Use -o to specify which fields you want to display: Use -o to specify which fields you want to display:
`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 | +=====+==========+=========+=============+================+
+=====+==========+=========+=============+================+ | JID | Name | Running | Config.Boot | Config.Comment |
| 183 | test | true | 1 | none | +=====+==========+=========+=============+================+
+-----+----------+---------+-------------+----------------+ | 183 | test | true | 1 | none |
| 29 | srv-irc | true | 1 | | +-----+----------+---------+-------------+----------------+
+-----+----------+---------+-------------+----------------+ | 29 | srv-irc | true | 1 | |
| | srv-web | false | 0 | | +-----+----------+---------+-------------+----------------+
+-----+----------+---------+-------------+----------------+ | | srv-web | false | 0 | |
| 22 | srv-dns1 | true | 1 | | +-----+----------+---------+-------------+----------------+
+-----+----------+---------+-------------+----------------+ | 22 | srv-dns1 | true | 1 | |
` +-----+----------+---------+-------------+----------------+
</code></pre>
Filter jails
----------
## Filter jails
### By name ### By name
Just add name on gocage list command : Just add name on gocage list command :
gocage list srv-bdd srv-web <pre><code>
+=====+=========+=================+=======================+=========+ gocage list srv-bdd srv-web
| JID | Name | Config.Release | Config.Ip4_addr | Running | +=====+=========+=================+=======================+=========+
+=====+=========+=================+=======================+=========+ | JID | Name | Config.Release | Config.Ip4_addr | Running |
| 98 | srv-db | 13.0-RELEASE-p5 | vnet0|192.168.1.56/24 | true | +=====+=========+=================+=======================+=========+
+-----+---------+-----------------+-----------------------+---------+ | 98 | srv-db | 13.0-RELEASE-p5 | vnet0|192.168.1.56/24 | true |
| 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>
### 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:
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 | +=====+==========+=========+=============+================+
+=====+==========+=========+=============+================+ | JID | Name | Running | Config.Boot | Config.Comment |
| 183 | test | true | 1 | none | +=====+==========+=========+=============+================+
+-----+----------+---------+-------------+----------------+ | 183 | test | true | 1 | none |
| 29 | srv-irc | true | 1 | | +-----+----------+---------+-------------+----------------+
+-----+----------+---------+-------------+----------------+ | 29 | srv-irc | true | 1 | |
| | srv-db | false | 1 | none | +-----+----------+---------+-------------+----------------+
+-----+----------+---------+-------------+----------------+ | | srv-db | false | 1 | none |
| 22 | srv-dns1 | true | 1 | | +-----+----------+---------+-------------+----------------+
+-----+----------+---------+-------------+----------------+ | 22 | srv-dns1 | true | 1 | |
+-----+----------+---------+-------------+----------------+
Now, only active at boot and running : </pre></code>
gocage list -f Config.Boot=1,Running=true -o JID,Name,Running,Config.Boot
+=====+==========+=========+=============+ Now, only active at boot and running :
| JID | Name | Running | Config.Boot | <pre><code>
+=====+==========+=========+=============+ gocage list -f Config.Boot=1,Running=true -o JID,Name,Running,Config.Boot
| 183 | test | true | 1 | +=====+==========+=========+=============+
+-----+----------+---------+-------------+ | JID | Name | Running | Config.Boot |
| 29 | srv-irc | true | 1 | +=====+==========+=========+=============+
+-----+----------+---------+-------------+ | 183 | test | true | 1 |
| 22 | srv-dns1 | true | 1 | +-----+----------+---------+-------------+
+-----+----------+---------+-------------+ | 29 | srv-irc | true | 1 |
+-----+----------+---------+-------------+
| 22 | srv-dns1 | true | 1 |
+-----+----------+---------+-------------+
</pre></code>
Stop jails
----------
`gocage stop test`