README updates and created a TODO list

This commit is contained in:
Christer Edwards
2018-04-07 16:58:11 -06:00
parent ad1452f59d
commit 69e8067b59
2 changed files with 86 additions and 48 deletions

View File

@@ -15,7 +15,8 @@ would very much like to keep things flexible enough to not *require* ZFS. To
bootstrap a release use the `bbsd-bootstrap` command.
```shell
bbsd-bootstrap activate bastille 11.1-RELEASE
pebbles ~ # bbsd-bootstrap activate bastille 11.1-RELEASE
pebbles ~ #
```
This command creates the directory structure, fetches the specified release,
@@ -30,6 +31,7 @@ have everything it needs to create a jail.
drwxr-xr-x 8 root wheel 8B Mar 31 08:35 jails
drwxr-xr-x 2 root wheel 8B Mar 30 20:50 logs
drwxr-xr-x 3 root wheel 3B Mar 17 15:37 releases
pebbles ~ #
```
### bbsd-create
@@ -42,7 +44,9 @@ things:
- FreeBSD release (ie; 11.1-RELEASE)
```shell
bbsd-create unbound0 https://github.com/bastillebsd/local_unbound.git 11.1-RELEASE
pebbles ~ # bbsd-create unbound0 https://github.com/bastillebsd/local_unbound.git 11.1-RELEASE
...[snip]...
pebbles ~ #
```
This command will create a 11.1-based basejail, and pre-populate the root
@@ -61,26 +65,38 @@ ZFS-snapshots of pre-created profiles.
To start a jail you can use the `bbsd-start` command.
```shell
bbsd-start unbound0
pebbles ~ # bbsd-start unbound0
unbound0: created
pebbles ~ #
```
This command can also take a space-separated list of jails to start.
```shell
bbsd-start unbound0 unbound1 unbound2
pebbles ~ # bbsd-start unbound0 unbound1 unbound2
unbound0: created
unbound1: created
unbound2: created
pebbles ~ #
```
### bbsd-stop
To stop a jail you can use the `bbsd-stop` command.
```shell
bbsd-stop unbound0
ishmael ~ # bbsd-stop unbound0
unbound0: removed
pebbles ~ #
```
This command can also take a space-separated list of jails to stop.
```shell
bbsd-stop unbound0 unbound1 unbound2
pebbles ~ # bbsd-stop unbound0 unbound1 unbound2
unbound0: removed
unbound1: removed
unbound2: removed
pebbles ~ #
```
### bbsd-restart
@@ -93,7 +109,7 @@ to manage my jails. It started out as a simple for-loop and have now evolved
into something a _little_ more mature.
```shell
bbsd-cmd ALL 'sockstat -4'
pebbles ~ # bbsd-cmd ALL 'sockstat -4'
```
This command will execute the "$2" argument (note the use of quotes to
@@ -115,6 +131,8 @@ system.
unbound2 10.0.0.30 unbound2 /usr/local/bastille/jails/unbound2/root
beastie 10.0.0.79 beastie /usr/local/bastille/jails/beastie/root
xmakaba 10.0.0.137 xmakaba /usr/local/bastille/jails/xmakaba/root
pebbles ~ #
pebbles ~ #
pebbles ~ # bbsd-cmd unbound 'sockstat -4'
Targeting specified containers.
unbound0
@@ -165,7 +183,8 @@ password-less.
```shell
pebbles ~ # bbsd-login beastie
root@beastie:~ #
root@beastie:~ # exit
pebbles ~ #
```
### bbsd-destroy
@@ -176,7 +195,9 @@ of a fail-safe. I just need to make the script a little more mature to make
sure it handles the file system deletions properly.
```shell
bbsd-destroy unbound0 /usr/local/bastille/jails/unbound0
pebbles ~ # bbsd-destroy unbound0 /usr/local/bastille/jails/unbound0
Jail destroyed. RIP.
pebbles ~ #
```
### bbsd-top
@@ -194,7 +215,8 @@ This command requires a path argument and then creates a bunch of directories
at that path. For example.
```shell
bbsd-init-repo ~/Projects/www_nginx.git
pebbles ~ # bbsd-init-repo ~/Projects/www_nginx.git
pebbles ~ #
```
This would create the required template structure in the pre-existing directory

16
TODO Normal file
View File

@@ -0,0 +1,16 @@
# TODO
This is just a place to throw down the ideas of things I need to fix and or
improve. In no particular order.
+ Consolidate the commands into a single `bastille` cmd.
+ Modular design for imported `bastille` functionality (ie; pkg, cmd, sysrc)
+ ZFS or UFS support
+ `bastille create` needs to support `fetch` fallback
+ `bastille create` needs to support branches
+ `bastille bootstrap` needs a complete review
+ New commands: `sysrc`, `fstab`, `jls`, `git`, `update`, `upgrade`
+ Support for multi-jail templating (create, snapshot, deploy)
+ jail.conf validation support in `create`
+ Dynamic config support for templating
+