Update release(7):

- Add a "CLOUD HOSTING MACHINE IMAGES" section,
   documenting the CLOUDWARE and WITH_CLOUDWARE
   make(1) environment variables.

 - Document the vm-cloudware and list-cloudware
   targets.

 - Add release/Makefile.vm, release/tools/*.conf
   and release/tools/vmimage.subr to FILES.

Sponsored by:	The FreeBSD Foundation
This commit is contained in:
Glen Barber 2015-01-16 17:07:35 +00:00
parent 99e908c904
commit b513fff0b2
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/projects/release-vmimage/; revision=277252

View File

@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd October 2, 2014
.Dd January 16, 2015
.Dt RELEASE 7
.Os
.Sh NAME
@ -406,6 +406,47 @@ See
for valid format values
.Pq requires version 20140927 or later .
.El
.Sh CLOUD HOSTING MACHINE IMAGES
The
.Fx
release build tools support building virtual machine images for various
cloud hosting providers, each with their own specific configuration to
include support for each hosting provider by default.
.Pp
The following
.Xr make 1
environment variables are supported:
.Pp
.Bl -tag -width Ev
.It Va CLOUDWARE
Set to a list of one or more cloud hosting providers, enclosed in quotes.
Requires
.Va WITH_CLOUDWARE
to also be set.
.It Va WITH_CLOUDWARE
Set to a non-empty value to enable building virtual machine images
for various cloud hosting providers.
Requires
.Va CLOUDWARE
to also be set.
.El
.Pp
Additionally, the
.Va CLOUDWARE
and
.Va WITH_CLOUDWARE
variables can be added to
.Pa release.conf ,
and used in conjunction with
.Pa release.sh .
.Pp
For a list of supported
.Va CLOUDWARE
values, run:
.Bd -literal -offset indent
cd /usr/src
make -C release list-cloudware
.Ed
.Sh MAKEFILE TARGETS
The release makefile
.Pq Pa src/release/Makefile
@ -470,6 +511,17 @@ target requires the
.Va WITH_VMIMAGES
.Xr make 1
envirionment variable to be set to a non-null value.
.It Cm vm-cloudware
Builds
.Fx
virtual machine images for various cloud hosting providers.
See
.Qq CLOUD HOSTING MACHINE IMAGES
for implementation details.
.It Cm list-cloudware
Displays the list of valid
.Va CLOUDWARE
values.
.El
.Pp
Major subtargets called by targets above:
@ -576,8 +628,11 @@ Typically, one only needs to set
.It Pa /usr/src/Makefile
.It Pa /usr/src/Makefile.inc1
.It Pa /usr/src/release/Makefile
.It Pa /usr/src/release/Makefile.vm
.It Pa /usr/src/release/release.sh
.It Pa /usr/src/release/release.conf.sample
.It Pa /usr/src/release/tools/*.conf
.It Pa /usr/src/release/tools/vmimage.subr
.El
.Sh EXAMPLES
The following sequence of commands can be used to build a