Mirrors/BastilleBSD_bastille
1
0
Fork 1
mirror of https://github.com/BastilleBSD/bastille.git synced 2025-12-11 17:39:52 +01:00
Code Issues Packages Projects Releases Wiki Activity

start creating man pages

Browse Source
This commit is contained in:
tschettervictor
2025-12-04 18:59:35 -07:00
parent 174b02dc48
commit 34696eaa29
5 changed files with 383 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files

95
usr/local/share/man/man1/bastille-bootstrap.1 Normal file
View File

@@ -0,0 +1,95 @@
.Dd 2025/12/04
.Dt bastille-bootstrap 1
.Os
.Sh NAME
.Nm bastille bootstrap
.Nd bootstrap a release or template(s)
.Sh SYNOPSIS
.Nm bastille bootstrap -h
.Nm bastille bootstrap
.Op Fl px
.Ar RELEASE Op update|arch
.Nm bastille bootstrap
.Op Fl x
.Ar TEMPLATE
.Sh DESCRIPTION
.Nm bastille bootstrap
will bootstrap a release for to use when creating jails. It will
also fetch and verify templates if a url is given as an arguement.
.Bl -tag -width Ds
.It bootstrap Oo Fl px Oc Ar RELEASE Op update|ARCH
.Bl -tag -width Ds
.It Fl p , Fl -pkgbase
Bootstrap a release using PkgBase package sets. By default Bastille
will use legacy distribution sets to bootstrap a release. For FreeBSD
version 16.x and above, PkgBase is the default.
.It Fl x , Fl -debug
Enable debug mode.
.It update
This will update the release using
.Nm bastille update RELEASE
after bootstrapping it.
.It ARCH
Specify an architecture when bootstrapping a release. This is usually
not needed, as Bastille detects this automatically for most
use cases.
.El
.It bootstrap Oo Fl x Oc Ar TEMPLATE
.Bl -tag -width Ds
.It Fl x , Fl -debug
Enable debug mode.
.El
.El
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl h , Fl -help
Print usage information.
.El
.Sh EXAMPLES
.Bl -tag -width Ds
.It Bootstrap 15.0-RELEASE:
.Nm bastille bootstrap 15.0-RELEASE
.It Bootstrap official BastilleBSD templates:
.Nm bastille bootstrap https://github.com/BastilleBSD/templates
.It Bootstrap 15.0-RELEASE using PkgBase:
.Nm bastille bootstrap -p 15.0-RELEASE
.El
.Sh SEE ALSO
.Xr bastille.conf 1
.Xr bastille-bootstrap 1
.Xr bastille-clone 1
.Xr bastille-cmd 1
.Xr bastille-config 1
.Xr bastille-console 1
.Xr bastille-convert 1
.Xr bastille-cp 1
.Xr bastille-create 1
.Xr bastille-destroy 1
.Xr bastille-edit 1
.Xr bastille-etcupdate 1
.Xr bastille-export 1
.Xr bastille-htop 1
.Xr bastille-import 1
.Xr bastille-jcp 1
.Xr bastille-limits 1
.Xr bastille-list 1
.Xr bastille-migrate 1
.Xr bastille-mount 1
.Xr bastille-network 1
.Xr bastille-pkg 1
.Xr bastille-rcp 1
.Xr bastille-rdr 1
.Xr bastille-rename 1
.Xr bastille-restart 1
.Xr bastille-service 1
.Xr bastille-setup 1
.Xr bastille-start 1
.Xr bastille-stop 1
.Xr bastille-sysrc 1
.Xr bastille-tags 1
.Xr bastille-top 1
.Xr bastille-umount 1
.Xr bastille-update 1
.Xr bastille-upgrade
.Xr bastille-verify 1
.Xr bastille-zfs 1

153
usr/local/share/man/man1/bastille.1 Normal file
View File

@@ -0,0 +1,153 @@
.Dd 2025/08/27
.Dt bastille 1
.Os
.Sh NAME
.Nm bastille
.Nd Open-source jail automation and management tool
.Sh SYNOPSIS
.Nm bastille
.Op Fl vh
.Op Fl c Ar file
.Ar command
.Op option(s)
.Ar TARGET
.Ar ARGS
.Sh DESCRIPTION
Bastille is an open-source system for automating deployment
and management of containerized applications on FreeBSD
using the jail framework.
.Sh OPTIONS
The following options are supported by
.Nm :
.Bl -tag -width Ds
.It Fl c Ar file , Fl -config Ar file
Specify a non-default config file to use. Must be placed
inside the Bastille config directory.
.It Fl h , Fl -help
Display usage information.
.It Fl v , Fl -version
Print version information.
.El
.Sh SUBCOMMANDS
The following commands are supported by
.Nm :
.Bl -tag -width Ds
.It Nm bootstrap
Bootstrap a FreeBSD release for jail base.
.It Nm clone
Clone an existing jail.
.It Nm cmd
Execute arbitrary command on targeted jail(s).
.It Nm config
Get, set or remove a config value for the targeted jail(s).
.It Nm console
Console into a jail.
.It Nm convert
Convert thin jail to thick jail, or convert a jail to a custom release.
.It Nm cp
cp(1) files from host to targeted jail(s).
.It Nm create
Create a jail.
.It Nm destroy
Destroy a jail or release
.It Nm edit
Edit jail configuration files (advanced).
.It Nm export
Exports a jail.
.It Nm help
Help about any command.
.It Nm htop
Interactive process viewer (requires htop).
.It Nm import
Import a jail.
.It Nm jcp
cp(1) files from a jail to jail(s).
.It Nm limits
Apply resources limits to targeted container(s). See rctl(8).
.It Nm list
List jails, releases, templates and more...
.It Nm migrate
Migrate targeted jail(s) to a remote system.
.It Nm mount
Mount a volume inside targeted jail(s).
.It Nm network
Add or remove interfaces from targeted jail(s).
.It Nm pkg
Manipulate binary packages within targeted container(s). See pkg(8).
.It Nm rcp
cp(1) files from a jail to host.
.It Nm rdr
Redirect host port to container port.
.It Nm rename
Rename a jail.
.It Nm restart
Restart a running container.
.It Nm service
Manage services within targeted jail(s).
.It Nm setup
Attempt to auto-configure network, firewall and storage and more...
.It Nm start
Start stopped jail(s).
.It Nm stop
Stop running jail(s).
.It Nm sysrc
Safely edit rc files within targeted jail(s).
.It Nm tags
Add or remove tags to targeted jail(s).
.It Nm template
Apply file templates to targeted jail(s).
.It Nm top
Display and update information about the top(1) cpu processes.
.It Nm umount
Unmount a volume from targeted jail(s).
.It Nm update
Update a jail or release.
.It Nm upgrade
Upgrade a jail to new X.Y-RELEASE.
.It Nm verify
Compare release against a "known good" index.
.It Nm zfs
Manage (get|set) zfs attributes on targeted jail(s).
.El
.Sh SEE ALSO
.Xr bastille.conf 1
.Xr bastille-bootstrap 1
.Xr bastille-clone 1
.Xr bastille-cmd 1
.Xr bastille-config 1
.Xr bastille-console 1
.Xr bastille-convert 1
.Xr bastille-cp 1
.Xr bastille-create 1
.Xr bastille-destroy 1
.Xr bastille-edit 1
.Xr bastille-etcupdate 1
.Xr bastille-export 1
.Xr bastille-htop 1
.Xr bastille-import 1
.Xr bastille-jcp 1
.Xr bastille-limits 1
.Xr bastille-list 1
.Xr bastille-migrate 1
.Xr bastille-mount 1
.Xr bastille-network 1
.Xr bastille-pkg 1
.Xr bastille-rcp 1
.Xr bastille-rdr 1
.Xr bastille-rename 1
.Xr bastille-restart 1
.Xr bastille-service 1
.Xr bastille-setup 1
.Xr bastille-start 1
.Xr bastille-stop 1
.Xr bastille-sysrc 1
.Xr bastille-tags 1
.Xr bastille-top 1
.Xr bastille-umount 1
.Xr bastille-update 1
.Xr bastille-upgrade
.Xr bastille-verify 1
.Xr bastille-zfs 1
.Sh BUGS
Please report any bugs on Github
.Nm https://github.com/BastilleBSD/bastille/issues

133
usr/local/share/man/man1/bastille.conf.1 Normal file
View File

@@ -0,0 +1,133 @@
.Dd 2025/12/04
.Dt bastille.conf 1
.Os
.Sh NAME
.Nm bastille.conf
.Nd configuration file for Bastille
.SH SYNOPSIS
.Nm /usr/local/etc/bastille/bastille.conf
.Sh DESCRIPTION
Bastille has most options preconfigured with sane defaults. These
can be adjusted to fit your environment.
.Sh DEFAULT PATH CONFIGURATION
.Bl -tag -width Ds
.It Nm bastille_prefix
This is the main Bastille prefix. All Bastille directories, excluding
.Nm bastille_logsdir
will start with this prefix.
.Pp
If zfs is enabled, this will become the mount point of the zfs dataset.
.Pp
The following directories, excluding
.Nm bastille_logsdir
will be prefixed by
.Nm basatille_prefix .
If zfs is enabled, they will inherit the mount point of
.Nm bastille_prefix .
.It Nm bastille_backupsdir
Bastille will store backups and exports here.
.It Nm bastille_cachedir
Bastille will store cache here.
.It Nm bastille_jailsdir
Bastille will store jails here.
.It Nm bastille_releasesdir
Bastille will store releases here.
.It Nm bastille_templatesdir
Bastille will store templates here.
.It Nm bastille_logsdir
Bastille will store jail console logs here.
.El
.Sh FIREWALL CONFIGURATION
.Bl -tag -width Ds
.It Nm bastille_pf_conf
Path to the pf firewall configuration file.
.El
.Sh SHARE DIRECTORY CONFIGURATION
.Bl -tag -width Ds
.It Nm bastille_sharedir
This is the path where Bastille expects sub-commands to live at.
.El
.Sh BOOTSTRAP CONFIGURATION
.Bl -tag -width Ds
.It Nm bastille_bootstrap_archives
This is a whitespace-separated list of distribution sets to fetch
when bootstrapping a legacy (non-pkgbase) release.
.It Nm bastille_pkgbase_packages
This is a whitespace-separated list of package sets to install
when bootstrapping a release using PkgBase.
.It Nm bastille_url_freebsd
Url from which to fetch legacy distributions sets when bootstrapping
a FreeBSD release.
.It Nm bastille_url_hardenedbsd
Url from which to fetch legacy distributions sets when bootstrapping
a HardenedBSD release.
.It Nm bastille_url_midnightbsd
Url from which to fetch legacy distributions sets when bootstrapping
a MidnightBSD release.
.El
.Sh TIMEZONE CONFIGURATION
.Bl -tag -width Ds
.It Nm bastille_tzdata
Set the timezone to apply to newly created jails.
.El
.Sh RESOLV.CONF CONFIGURATION
.Bl -tag -width Ds
.It Nm bastille_resolv_conf
This file is copied into newly created jails to allow them
to reach DNS.
.El
.Sh ZFS CONFIGURATION
.Bl -tag -width Ds
.It Nm bastille_zfs_enable
Whether to enable or disable zfs support.
.It Nm bastille_zfs_zpool
Which zpool to use when zfs is enabled.
.It Nm bastille_zfs_prefix
Which dataset to use when zfs is enabled. Do not include the zpool
here.
.It Nm bastille_zfs_options
Zfs options to use when creating any and all datasets for any and all
supported actions.
.Sh SEE ALSO
.Xr bastille.conf 1
.Xr bastille-bootstrap 1
.Xr bastille-clone 1
.Xr bastille-cmd 1
.Xr bastille-config 1
.Xr bastille-console 1
.Xr bastille-convert 1
.Xr bastille-cp 1
.Xr bastille-create 1
.Xr bastille-destroy 1
.Xr bastille-edit 1
.Xr bastille-etcupdate 1
.Xr bastille-export 1
.Xr bastille-htop 1
.Xr bastille-import 1
.Xr bastille-jcp 1
.Xr bastille-limits 1
.Xr bastille-list 1
.Xr bastille-migrate 1
.Xr bastille-mount 1
.Xr bastille-network 1
.Xr bastille-pkg 1
.Xr bastille-rcp 1
.Xr bastille-rdr 1
.Xr bastille-rename 1
.Xr bastille-restart 1
.Xr bastille-service 1
.Xr bastille-setup 1
.Xr bastille-start 1
.Xr bastille-stop 1
.Xr bastille-sysrc 1
.Xr bastille-tags 1
.Xr bastille-top 1
.Xr bastille-umount 1
.Xr bastille-update 1
.Xr bastille-upgrade
.Xr bastille-verify 1
.Xr bastille-zfs 1

120
usr/local/share/man/man8/bastille.8
View File

@@ -1,120 +0,0 @@
.Dd 2025/08/27
.Dt bastille 8
.Os FreeBSD
.Sh NAME
bastille - Bastille is an open-source system for automating deployment
\ and management of containerized applications on FreeBSD.
.Sh SYNOPSIS
.Nm bastille
.Ar command
.Ar TARGET
.Op arg
.Sh DESCRIPTION
.Nm To start all containers during boot use:
.Pp
sysrc bastille_enable=YES
.Pp
.Nm The following modules are available:
.Pp
.Bl -tag -width -indent
.It bootstrap
Bootstrap a FreeBSD release for container base.
.It clone
Clone an existing container.
.It cmd
Execute arbitrary command on targeted container(s).
.It console
Console into a running container.
.It convert
Convert a thin container into a thick container.
.It cp
cp(1) files from host to targeted container(s).
.It create
Create a new thin container or a thick container if -T|--thick option specified.
.It destroy
Destroy a stopped container or a FreeBSD release.
.It edit
Edit container configuration files (advanced).
.It export
Exports a container archive or image.
.It help
Help about any command
.It htop
Interactive process viewer (requires htop).
.It import
Import a container archive or image.
.It list
List containers, releases, templates, logs, limits or backups.
.It limits
Apply resources limits to targeted container(s). See rctl(8).
.It pkg
Manipulate binary packages within targeted container(s). See pkg(8).
.It restart
Restart a running container.
.It rdr
Redirect host port to container port.
.It service
Manage services within targeted container(s).
.It start
Start a stopped container.
.It stop
Stop a running container.
.It sysrc
Safely edit rc files within targeted container(s).
.It tags
Add tags to targeted container(s).
.It template
Apply file templates to targeted container(s).
.It top
Display and update information about the top(1) cpu processes.
.It update
Update container base -pX release.
.It upgrade
Upgrade container release to X.Y-RELEASE.
.It verify
Compare release against a "known good" index.
.It zfs
Manage (get|set) zfs attributes on targeted container(s).
.El
.Pp
.Sh FILES
.Bl -tag -width "/Users/joeuser/Library/really_long_file_name" -compact
.It Pa /usr/local/bin/bastille
Bastille executable
.El
.Pp
.Sh BUGS
Please report any bugs on Github
.Nm https://github.com/BastilleBSD/bastille/issues
.Pp
.Sh EXAMPLE
bastille bootstrap 12.1-RELEASE
.Pp
bastille create myjail 12.1-RELEASE 10.0.0.1 em0
.Pp
.Nm To create a container with VNET and DHCP use
.Pp
bastille create -V myjail 12.1-RELEASE 0.0.0.0 em0
.Sh HISTORY
.Nm Features added in 0.6.20200412:
.Pp
.Bl -tag -width -indent
.It clone
Clone an existing container.
.It import (updated)
Support for iocage and ezjail import
.Pp
.El
.Nm Features added in 0.6.20200202:
.Pp
.Bl -tag -width -indent
.It convert
Convert a thin container into a thick container.
.It export
Exports a container archive or image.
.It import
Import a container archive or image.
.It limits
Apply resources limits to targeted container(s). See rctl(8).
.It rdr
Redirect host port to container port.