misc doc updates

This commit is contained in:
Zane C. B-H 2021-10-13 04:58:35 -05:00
parent 95eb74f7b3
commit 45b7a8a633
4 changed files with 80 additions and 30 deletions

View File

@ -1,5 +1,21 @@
Changes
lib/Rex/Virtualization/CBSD.pm
lib/Rex/Virtualization/CBSD/cbsd_base_dir.pm
lib/Rex/Virtualization/CBSD/disk_list.pm
lib/Rex/Virtualization/CBSD/freejname.pm
lib/Rex/Virtualization/CBSD/info.pm
lib/Rex/Virtualization/CBSD/list.pm
lib/Rex/Virtualization/CBSD/nic_list.pm
lib/Rex/Virtualization/CBSD/pause.pm
lib/Rex/Virtualization/CBSD/pci_list.pm
lib/Rex/Virtualization/CBSD/remove.pm
lib/Rex/Virtualization/CBSD/restart.pm
lib/Rex/Virtualization/CBSD/set.pm
lib/Rex/Virtualization/CBSD/start.pm
lib/Rex/Virtualization/CBSD/stop.pm
lib/Rex/Virtualization/CBSD/vm_os_profiles.pm
lib/Rex/Virtualization/CBSD/vm_os_profiles_hash.pm
lib/Rex/Virtualization/CBSD/vm_os_types.pm
Makefile.PL
MANIFEST This list of files
README

View File

@ -4,42 +4,52 @@ use warnings;
use ExtUtils::MakeMaker;
my %WriteMakefileArgs = (
NAME => 'Rex::Virtualization::CBSD',
AUTHOR => q{Zane C. Bowers-HAdley <vvelox@vvelox.net>},
VERSION_FROM => 'lib/Rex/Virtualization/CBSD.pm',
ABSTRACT_FROM => 'lib/Rex/Virtualization/CBSD.pm',
LICENSE => 'artistic_2',
MIN_PERL_VERSION => '5.006',
CONFIGURE_REQUIRES => {
'ExtUtils::MakeMaker' => '0',
},
TEST_REQUIRES => {
'Test::More' => '0',
},
PREREQ_PM => {
'Term::ANSIColor'=>'0',
'Rex'=>'1.9.0',
},
dist => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', },
clean => { FILES => 'Rex-Virtualization-CBSD-*' },
NAME => 'Rex::Virtualization::CBSD',
AUTHOR => q{Zane C. Bowers-HAdley <vvelox@vvelox.net>},
VERSION_FROM => 'lib/Rex/Virtualization/CBSD.pm',
ABSTRACT_FROM => 'lib/Rex/Virtualization/CBSD.pm',
LICENSE => 'artistic_2',
MIN_PERL_VERSION => '5.006',
CONFIGURE_REQUIRES => {
'ExtUtils::MakeMaker' => '0',
},
TEST_REQUIRES => {
'Test::More' => '0',
},
PREREQ_PM => {
'Term::ANSIColor' => '0',
'Rex' => '1.9.0',
},
dist => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', },
clean => { FILES => 'Rex-Virtualization-CBSD-*' },
META_MERGE => {
"meta-spec" => { version => 2 },
resources => {
repository => {
type => 'git',
url => 'https://github.com/VVelox/Rex-Virtualization-CBSD.git',
web => 'https://github.com/VVelox/Rex-Virtualization-CBSD',
},
},
},
);
# Compatibility with old versions of ExtUtils::MakeMaker
unless (eval { ExtUtils::MakeMaker->VERSION('6.64'); 1 }) {
my $test_requires = delete $WriteMakefileArgs{TEST_REQUIRES} || {};
@{$WriteMakefileArgs{PREREQ_PM}}{keys %$test_requires} = values %$test_requires;
unless ( eval { ExtUtils::MakeMaker->VERSION('6.64'); 1 } ) {
my $test_requires = delete $WriteMakefileArgs{TEST_REQUIRES} || {};
@{ $WriteMakefileArgs{PREREQ_PM} }{ keys %$test_requires } = values %$test_requires;
}
unless (eval { ExtUtils::MakeMaker->VERSION('6.55_03'); 1 }) {
my $build_requires = delete $WriteMakefileArgs{BUILD_REQUIRES} || {};
@{$WriteMakefileArgs{PREREQ_PM}}{keys %$build_requires} = values %$build_requires;
unless ( eval { ExtUtils::MakeMaker->VERSION('6.55_03'); 1 } ) {
my $build_requires = delete $WriteMakefileArgs{BUILD_REQUIRES} || {};
@{ $WriteMakefileArgs{PREREQ_PM} }{ keys %$build_requires } = values %$build_requires;
}
delete $WriteMakefileArgs{CONFIGURE_REQUIRES}
unless eval { ExtUtils::MakeMaker->VERSION('6.52'); 1 };
unless eval { ExtUtils::MakeMaker->VERSION('6.52'); 1 };
delete $WriteMakefileArgs{MIN_PERL_VERSION}
unless eval { ExtUtils::MakeMaker->VERSION('6.48'); 1 };
unless eval { ExtUtils::MakeMaker->VERSION('6.48'); 1 };
delete $WriteMakefileArgs{LICENSE}
unless eval { ExtUtils::MakeMaker->VERSION('6.31'); 1 };
unless eval { ExtUtils::MakeMaker->VERSION('6.31'); 1 };
WriteMakefile(%WriteMakefileArgs);

View File

@ -42,6 +42,8 @@ You can also look for information at:
Search CPAN
https://metacpan.org/release/Rex-Virtualization-CBSD
Repository
https://github.com/VVelox/Rex-Virtualization-CBSD
LICENSE AND COPYRIGHT

View File

@ -193,7 +193,7 @@ The keys are as below.
driver - The driver in use. As of currently either vtnet or e1000.
type - Needs documented.
type - Not currently used.
parent - Either the name of the parent NIC, example 'bridge1', or set to 'auto'.
@ -203,9 +203,10 @@ The keys are as below.
mtu - The MTU of NIC. '0' if default.
persistent - 0/1 - If it should exist when the VM is not in use. '0' is the default.
persistent - 0/1 - 1 mean persistent nic (no managed by CBSD)
ratelimit - Rate limit for the interface. '0' is the default, not in use.
ratelimit - Rate limit for the interface. '0' is the default.
{tx}/{rx} (outgoing/incoming limit), {rxtx} - shared(rx+tx) limit, one value
This dies upon failure.
@ -307,6 +308,23 @@ This dies upon failure.
warn('Failed to restart the VM foo... '.$error);
}
=head2 set
This sets various settings for a VM via the use of...
cbsd bset jname=$vm ...
One argument is equired and that is the VM name.
This will die upon failure. Please note the CBSD currently does
not consider non-existent variables such as 'foofoo' to be a failure
and silently ignores those.
# set the the VM foo to boot from net with a resolution of 800x600
vm 'set' => 'foo',
vm_boot => 'net',
bhyve_vnc_resolution => '800x600';
=head2 start
This starts a VM. This is done via the command...
@ -425,6 +443,10 @@ L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=Rex-Virtualization-CBSD>
L<http://annocpan.org/dist/Rex-Virtualization-CBSD>
=item * Repository
L<https://github.com/VVelox/Rex-Virtualization-CBSD>
=item * CPAN Ratings
L<https://cpanratings.perl.org/d/Rex-Virtualization-CBSD>