Annotation of wikisrc/ports/xen/howto.mdwn, revision 1.38
1.5 mspo 1: Introduction
1.13 gdt 2: ============
1.1 mspo 3:
4: [![[Xen
1.7 mspo 5: screenshot]](http://www.netbsd.org/gallery/in-Action/hubertf-xens.png)](../../gallery/in-Action/hubertf-xen.png)
1.1 mspo 6:
1.12 gdt 7: Xen is a virtual machine monitor or hypervisor for x86 hardware
8: (i686-class or higher), which supports running multiple guest
9: operating systems on a single physical machine. With Xen, one uses
10: the Xen kernel to control the CPU, memory and console, a dom0
11: operating system which mediates access to other hardware (e.g., disks,
12: network, USB), and one or more domU operating systems which operate in
13: an unprivileged virtualized environment. IO requests from the domU
14: systems are forwarded by the hypervisor (Xen) to the dom0 to be
15: fulfilled.
16:
17: Xen supports two styles of guests. The original is Para-Virtualized
18: (PV) which means that the guest OS does not attempt to access hardware
19: directly, but instead makes hypercalls to the hypervisor. This is
20: analogous to a user-space program making system calls. (The dom0
21: operating system uses PV calls for some functions, such as updating
22: memory mapping page tables, but has direct hardware access for disk
23: and network.) PV guests must be specifically coded for Xen.
24:
25: The more recent style is HVM, which means that the guest does not have
26: code for Xen and need not be aware that it is running under Xen.
27: Attempts to access hardware registers are trapped and emulated. This
28: style is less efficient but can run unmodified guests.
29:
1.29 gdt 30: Generally any amd64 machine will work with Xen and PV guests. In
31: theory i386 computers without amd64 support can be used for Xen <=
32: 4.2, but we have no recent reports of this working (this is a hint).
33: For HVM guests, the VT or VMX cpu feature (Intel) or SVM/HVM/VT
34: (amd64) is needed; "cpuctl identify 0" will show this. TODO: Clean up
35: and check the above features.
1.19 gdt 36:
1.27 jnemeth 37: At boot, the dom0 kernel is loaded as a module with Xen as the kernel.
1.12 gdt 38: The dom0 can start one or more domUs. (Booting is explained in detail
39: in the dom0 section.)
40:
41: NetBSD supports Xen in that it can serve as dom0, be used as a domU,
42: and that Xen kernels and tools are available in pkgsrc. This HOWTO
43: attempts to address both the case of running a NetBSD dom0 on hardware
1.24 gdt 44: and running domUs under it (NetBSD and other), and also running NetBSD
45: as a domU in a VPS.
1.12 gdt 46:
1.20 gdt 47: Some versions of Xen support "PCI passthrough", which means that
48: specific PCI devices can be made available to a specific domU instead
49: of the dom0. This can be useful to let a domU run X11, or access some
50: network interface or other peripheral.
51:
1.12 gdt 52: Prerequisites
1.13 gdt 53: -------------
1.12 gdt 54:
55: Installing NetBSD/Xen is not extremely difficult, but it is more
56: complex than a normal installation of NetBSD.
1.15 gdt 57: In general, this HOWTO is occasionally overly restrictive about how
58: things must be done, guiding the reader to stay on the established
59: path when there are no known good reasons to stray.
1.12 gdt 60:
61: This HOWTO presumes a basic familiarity with the Xen system
1.16 gdt 62: architecture. This HOWTO presumes familiarity with installing NetBSD
63: on i386/amd64 hardware and installing software from pkgsrc.
1.27 jnemeth 64: See also the [Xen website](http://www.xenproject.org/).
1.1 mspo 65:
1.19 gdt 66: History
67: -------
68:
69: NetBSD used to support Xen2; this has been removed.
70:
71: Before NetBSD's native bootloader could support Xen, the use of
72: grub was recommended. If necessary, see the
1.27 jnemeth 73: [old grub information](/ports/xen/howto-grub/).
1.19 gdt 74:
1.15 gdt 75: Versions of Xen and NetBSD
76: ==========================
77:
1.27 jnemeth 78: Most of the installation concepts and instructions are independent
79: of Xen version and NetBSD version. This section gives advice on
80: which version to choose. Versions not in pkgsrc and older unsupported
81: versions of NetBSD are intentionally ignored.
1.15 gdt 82:
83: Xen
84: ---
85:
86: In NetBSD, xen is provided in pkgsrc, via matching pairs of packages
87: xenkernel and xentools. We will refer only to the kernel versions,
88: but note that both packages must be installed together and must have
89: matching versions.
90:
91: xenkernel3 and xenkernel33 provide Xen 3.1 and 3.3. These no longer
1.20 gdt 92: receive security patches and should not be used. Xen 3.1 supports PCI
1.29 gdt 93: passthrough. Xen 3.1 supports non-PAE on i386.
1.15 gdt 94:
95: xenkernel41 provides Xen 4.1. This is no longer maintained by Xen,
96: but as of 2014-12 receives backported security patches. It is a
97: reasonable although trailing-edge choice.
98:
99: xenkernel42 provides Xen 4.2. This is maintained by Xen, but old as
100: of 2014-12.
101:
102: Ideally newer versions of Xen will be added to pkgsrc.
103:
1.26 gdt 104: Note that NetBSD support is called XEN3. It works with 3.1 through
105: 4.2 because the hypercall interface has been stable.
1.20 gdt 106:
1.19 gdt 107: Xen command program
108: -------------------
109:
110: Early Xen used a program called "xm" to manipulate the system from the
111: dom0. Starting in 4.1, a replacement program with similar behavior
1.27 jnemeth 112: called "xl" is provided. In 4.2 and later, "xl" is preferred. 4.4 is
113: the last version that has "xm".
1.19 gdt 114:
1.15 gdt 115: NetBSD
116: ------
117:
118: The netbsd-5, netbsd-6, netbsd-7, and -current branches are all
119: reasonable choices, with more or less the same considerations for
120: non-Xen use. Therefore, netbsd-6 is recommended as the stable version
1.29 gdt 121: of the most recent release for production use. For those wanting to
122: learn Xen or without production stability concerns, netbsd-7 is likely
123: most appropriate.
1.15 gdt 124:
125: As of NetBSD 6, a NetBSD domU will support multiple vcpus. There is
126: no SMP support for NetBSD as dom0. (The dom0 itself doesn't really
127: need SMP; the lack of support is really a problem when using a dom0 as
128: a normal computer.)
129:
1.18 gdt 130: Architecture
131: ------------
132:
1.29 gdt 133: Xen itself can run on i386 or amd64 machines. (Practically, almost
134: any computer where one would want to run Xen supports amd64.) If
135: using an i386 NetBSD kernel for the dom0, PAE is required (PAE
136: versions are built by default). While i386 dom0 works fine, amd64 is
137: recommended as more normal.
138:
139: Xen 4.2 is the last version to support i386 as a host. TODO: Clarify
140: if this is about the CPU having to be amd64, or about the dom0 kernel
141: having to be amd64.
142:
143: One can then run i386 domUs and amd64 domUs, in any combination. If
144: running an i386 NetBSD kernel as a domU, the PAE version is required.
145: (Note that emacs (at least) fails if run on i386 with PAE when built
146: without, and vice versa, presumably due to bugs in the undump code.)
1.18 gdt 147:
1.15 gdt 148: Recommendation
149: --------------
150:
1.18 gdt 151: Therefore, this HOWTO recommends running xenkernel42 (and xentools42),
1.30 gdt 152: xl, the NetBSD 6 stable branch, and to use an amd64 kernel as the
153: dom0. Either the i386 or amd64 of NetBSD may be used as domUs.
1.15 gdt 154:
1.36 gdt 155: Build problems
156: --------------
157:
158: Ideally, all versions of Xen in pkgsrc would build on all versions of
159: NetBSD on both i386 and amd64. However, that isn't the case. Besides
160: aging code and aging compilers, qemu (included in xentools for HVM
161: support) is difficult to build. The following are known to fail:
162:
163: xenkernel3 netbsd-6 i386
164: xentools42 netbsd-6 i386
165:
166: The following are known to work:
167:
168: xenkernel41 netbsd-5 amd64
169: xentools41 netbsd-5 amd64
170: xenkernel41 netbsd-6 i386
171: xentools41 netbsd-6 i386
172:
1.15 gdt 173: NetBSD as a dom0
174: ================
175:
176: NetBSD can be used as a dom0 and works very well. The following
177: sections address installation, updating NetBSD, and updating Xen.
1.19 gdt 178: Note that it doesn't make sense to talk about installing a dom0 OS
179: without also installing Xen itself. We first address installing
180: NetBSD, which is not yet a dom0, and then adding Xen, pivoting the
181: NetBSD install to a dom0 install by just changing the kernel and boot
182: configuration.
1.15 gdt 183:
184: Styles of dom0 operation
185: ------------------------
186:
187: There are two basic ways to use Xen. The traditional method is for
188: the dom0 to do absolutely nothing other than providing support to some
189: number of domUs. Such a system was probably installed for the sole
190: purpose of hosting domUs, and sits in a server room on a UPS.
191:
192: The other way is to put Xen under a normal-usage computer, so that the
193: dom0 is what the computer would have been without Xen, perhaps a
194: desktop or laptop. Then, one can run domUs at will. Purists will
195: deride this as less secure than the previous approach, and for a
196: computer whose purpose is to run domUs, they are right. But Xen and a
197: dom0 (without domUs) is not meaingfully less secure than the same
198: things running without Xen. One can boot Xen or boot regular NetBSD
199: alternately with little problems, simply refraining from starting the
200: Xen daemons when not running Xen.
201:
202: Note that NetBSD as dom0 does not support multiple CPUs. This will
203: limit the performance of the Xen/dom0 workstation approach.
204:
1.19 gdt 205: Installation of NetBSD
206: ----------------------
1.13 gdt 207:
1.19 gdt 208: First,
1.27 jnemeth 209: [install NetBSD/amd64](/guide/inst/)
1.19 gdt 210: just as you would if you were not using Xen.
211: However, the partitioning approach is very important.
212:
213: If you want to use RAIDframe for the dom0, there are no special issues
214: for Xen. Typically one provides RAID storage for the dom0, and the
1.22 gdt 215: domU systems are unaware of RAID. The 2nd-stage loader bootxx_* skips
216: over a RAID1 header to find /boot from a filesystem within a RAID
217: partition; this is no different when booting Xen.
1.19 gdt 218:
219: There are 4 styles of providing backing storage for the virtual disks
220: used by domUs: raw partitions, LVM, file-backed vnd(4), and SAN,
221:
222: With raw partitions, one has a disklabel (or gpt) partition sized for
223: each virtual disk to be used by the domU. (If you are able to predict
224: how domU usage will evolve, please add an explanation to the HOWTO.
225: Seriously, needs tend to change over time.)
226:
1.27 jnemeth 227: One can use [lvm(8)](/guide/lvm/) to create logical devices to use
228: for domU disks. This is almost as efficient as raw disk partitions
229: and more flexible. Hence raw disk partitions should typically not
230: be used.
1.19 gdt 231:
232: One can use files in the dom0 filesystem, typically created by dd'ing
233: /dev/zero to create a specific size. This is somewhat less efficient,
234: but very convenient, as one can cp the files for backup, or move them
235: between dom0 hosts.
236:
237: Finally, in theory one can place the files backing the domU disks in a
238: SAN. (This is an invitation for someone who has done this to add a
239: HOWTO page.)
1.1 mspo 240:
1.19 gdt 241: Installation of Xen
242: -------------------
1.1 mspo 243:
1.20 gdt 244: In the dom0, install sysutils/xenkernel42 and sysutils/xentools42 from
245: pkgsrc (or another matching pair).
246: See [the pkgsrc
247: documentation](http://www.NetBSD.org/docs/pkgsrc/) for help with pkgsrc.
248:
249: For Xen 3.1, support for HVM guests is in sysutils/xentool3-hvm. More
250: recent versions have HVM support integrated in the main xentools
251: package. It is entirely reasonable to run only PV guests.
252:
253: Next you need to install the selected Xen kernel itself, which is
254: installed by pkgsrc as "/usr/pkg/xen*-kernel/xen.gz". Copy it to /.
255: For debugging, one may copy xen-debug.gz; this is conceptually similar
256: to DIAGNOSTIC and DEBUG in NetBSD. xen-debug.gz is basically only
257: useful with a serial console. Then, place a NetBSD XEN3_DOM0 kernel
258: in /, copied from releasedir/amd64/binary/kernel/netbsd-XEN3_DOM0.gz
259: of a NetBSD build. Both xen and NetBSD may be left compressed. (If
260: using i386, use releasedir/i386/binary/kernel/netbsd-XEN3PAE_DOM0.gz.)
261:
262: In a dom0 kernel, kernfs is mandatory for xend to comunicate with the
263: kernel, so ensure that /kern is in fstab.
264:
265: Because you already installed NetBSD, you have a working boot setup
266: with an MBR bootblock, either bootxx_ffsv1 or bootxx_ffsv2 at the
267: beginning of your root filesystem, /boot present, and likely
268: /boot.cfg. (If not, fix before continuing!)
269:
270: See boot.cfg(5) for an example. The basic line is
271:
1.37 gdt 272: menu=Xen:load /netbsd-XEN3_DOM0.gz console=pc;multiboot /xen.gz dom0_mem=256M
1.20 gdt 273:
274: which specifies that the dom0 should have 256M, leaving the rest to be
1.37 gdt 275: allocated for domUs. In an attempt to add performance, one can also
276: add
277:
278: dom0_max_vcpus=1 dom0_vcpus_pin
279:
280: to force only one vcpu to be provided (since NetBSD dom0 can't use
281: more) and to pin that vcpu to a physical cpu. TODO: benchmark this.
1.20 gdt 282:
283: As with non-Xen systems, you should have a line to boot /netbsd (a
284: kernel that works without Xen) and fallback versions of the non-Xen
285: kernel, Xen, and the dom0 kernel.
1.1 mspo 286:
1.28 gdt 287: The [HowTo on Installing into
288: RAID-1](http://mail-index.NetBSD.org/port-xen/2006/03/01/0010.html)
289: explains how to set up booting a dom0 with Xen using grub with
290: NetBSD's RAIDframe. (This is obsolete with the use of NetBSD's native
291: boot.)
292:
1.21 gdt 293: Configuring Xen
294: ---------------
295:
296: Now, you have a system that will boot Xen and the dom0 kernel, and
297: just run the dom0 kernel. There will be no domUs, and none can be
1.31 gdt 298: started because you still have to configure the dom0 tools. The
299: daemons which should be run vary with Xen version and with whether one
300: is using xm or xl. Note that xend is for supporting "xm", and should
301: only be used if you plan on using "xm". Do NOT enable xend if you
302: plan on using "xl" as it will cause problems.
1.21 gdt 303:
1.31 gdt 304: TODO: Give 3.1 advice (or remove it from pkgsrc).
305:
306: For 3.3 (and thus xm), add to rc.conf (but note that you should have
307: installed 4.1 or 4.2):
308:
1.32 gdt 309: xend=YES
310: xenbackendd=YES
1.31 gdt 311:
1.33 gdt 312: For 4.1 (and thus xm; xl is believed not to work well), add to rc.conf:
1.31 gdt 313:
314: xend=YES
315: xencommons=YES
316:
317: TODO: Explain why if xm is preferred on 4.1, rc.d/xendomains has xl.
1.33 gdt 318: Or fix the package.
1.31 gdt 319:
1.33 gdt 320: For 4.2 with xm, add to rc.conf
321:
322: xend=YES
323: xencommons=YES
324:
325: For 4.2 with xl (preferred), add to rc.conf:
1.31 gdt 326:
327: TODO: explain if there is a xend replacement
328: xencommons=YES
329:
330: TODO: Recommend for/against xen-watchdog.
1.27 jnemeth 331:
1.33 gdt 332: After you have configured the daemons and rebooted, run the following
1.38 ! gdt 333: (or use xl) to inspect Xen's boot messages, available resources, and
! 334: running domains:
1.34 gdt 335:
1.33 gdt 336: xm dmesg
1.35 gdt 337: xm info
338: xm list
1.33 gdt 339:
1.15 gdt 340: Updating NetBSD in a dom0
341: -------------------------
342:
343: This is just like updating NetBSD on bare hardware, assuming the new
344: version supports the version of Xen you are running. Generally, one
345: replaces the kernel and reboots, and then overlays userland binaries
346: and adjusts /etc.
347:
348: Note that one must update both the non-Xen kernel typically used for
349: rescue purposes and the DOM0 kernel used with Xen.
350:
1.22 gdt 351: To convert from grub to /boot, install an mbr bootblock with fdisk,
352: bootxx_ with installboot, /boot and /boot.cfg. This really should be
353: no different than completely reinstalling boot blocks on a non-Xen
354: system.
355:
1.15 gdt 356: Updating Xen versions
357: ---------------------
358:
1.21 gdt 359: Updating Xen is conceptually not difficult, but can run into all the
360: issues found when installing Xen. Assuming migration from 4.1 to 4.2,
361: remove the xenkernel41 and xentools41 packages and install the
362: xenkernel42 and xentools42 packages. Copy the 4.2 xen.gz to /.
363:
364: Ensure that the contents of /etc/rc.d/xen* are correct. Enable the
365: correct set of daemons. Ensure that the domU config files are valid
366: for the new version.
1.15 gdt 367:
1.28 gdt 368:
369: Unprivileged domains (domU)
370: ===========================
371:
372: This section describes general concepts about domUs. It does not
1.33 gdt 373: address specific domU operating systems or how to install them. The
374: config files for domUs are typically in /usr/pkg/etc/xen, and are
375: typically named so that the file anme, domU name and the domU's host
376: name match.
377:
378: The domU is provided with cpu and memory by Xen, configured by the
379: dom0. The domU is provided with disk and network by the dom0,
380: mediated by Xen, and configured in the dom0.
381:
382: Entropy in domUs can be an issue; physical disks and network are on
383: the dom0. NetBSD's /dev/random system works, but is often challenged.
384:
385: CPU and memory
386: --------------
387:
388: A domain is provided with some number of vcpus, less than the
389: number of cpus seen by the hypervisor. For a dom0, this is controlled
390: by the boot argument "dom0_max_vcpus=1". For a domU, it is controlled
391: from the config file.
392:
393: A domain is provided with memory, In the straightforward case, the sum
394: of the the memory allocated to the dom0 and all domUs must be less
395: than the available memory.
396:
397: Xen also provides a "balloon" driver, which can be used to let domains
398: use more memory temporarily. TODO: Explain better, and explain how
399: well it works with NetBSD.
1.28 gdt 400:
401: Virtual disks
402: -------------
403:
1.33 gdt 404: With the file/vnd style, typically one creates a directory,
405: e.g. /u0/xen, on a disk large enough to hold virtual disks for all
406: domUs. Then, for each domU disk, one writes zeros to a file that then
407: serves to hold the virtual disk's bits; a suggested name is foo-xbd0
408: for the first virtual disk for the domU called foo. Writing zeros to
409: the file serves two purposes. One is that preallocating the contents
410: improves performance. The other is that vnd on sparse files has
411: failed to work. TODO: give working/notworking NetBSD versions for
412: sparse vnd. Note that the use of file/vnd for Xen is not really
413: different than creating a file-backed virtual disk for some other
414: purpose, except that xentools handles the vnconfig commands.
415:
416: With the lvm style, one creates logical devices. They are then used
417: similarly to vnds.
1.28 gdt 418:
419: Virtual Networking
420: ------------------
421:
422: TODO: explain xvif concept, and that it's general.
423:
424: There are two normal styles: bridging and NAT.
425:
426: With bridging, the domU perceives itself to be on the same network as
427: the dom0. For server virtualization, this is usually best.
428:
429: With NAT, the domU perceives itself to be behind a NAT running on the
430: dom0. This is often appropriate when running Xen on a workstation.
431:
432: One can construct arbitrary other configurations, but there is no
433: script support.
434:
1.33 gdt 435: Sizing domains
436: --------------
437:
438: Modern x86 hardware has vast amounts of resources. However, many
439: virtual servers can function just fine on far less. A system with
440: 256M of RAM and a 4G disk can be a reasonable choice. Note that it is
441: far easier to adjust virtual resources than physical ones. For
442: memory, it's just a config file edit and a reboot. For disk, one can
443: create a new file and vnconfig it (or lvm), and then dump/restore,
444: just like updating physical disks, but without having to be there and
445: without those pesky connectors.
446:
1.28 gdt 447: Config files
448: ------------
449:
450: TODO: give example config files. Use both lvm and vnd.
451:
452: TODO: explain the mess with 3 arguments for disks and how to cope (0x1).
453:
454: Starting domains
455: ----------------
456:
457: TODO: Explain "xm start" and "xl start". Explain rc.d/xendomains.
458:
459: TODO: Explain why 4.1 rc.d/xendomains has xl, when one should use xm
460: on 4.1.
461:
462: Creating specific unprivileged domains (domU)
463: =============================================
1.14 gdt 464:
465: Creating domUs is almost entirely independent of operating system. We
466: first explain NetBSD, and then differences for Linux and Solaris.
467:
468: Creating an unprivileged NetBSD domain (domU)
469: ---------------------------------------------
1.1 mspo 470:
471: Once you have *domain0* running, you need to start the xen tool daemon
1.5 mspo 472: (`/usr/pkg/share/examples/rc.d/xend start`) and the xen backend daemon
473: (`/usr/pkg/share/examples/rc.d/xenbackendd start` for Xen3\*,
474: `/usr/pkg/share/examples/rc.d/xencommons start` for Xen4.\*). Make sure
475: that `/dev/xencons` and `/dev/xenevt` exist before starting `xend`. You
476: can create them with this command:
1.1 mspo 477:
1.3 mspo 478: # cd /dev && sh MAKEDEV xen
1.1 mspo 479:
1.5 mspo 480: xend will write logs to `/var/log/xend.log` and
481: `/var/log/xend-debug.log`. You can then control xen with the xm tool.
482: 'xm list' will show something like:
1.1 mspo 483:
1.3 mspo 484: # xm list
485: Name Id Mem(MB) CPU State Time(s) Console
486: Domain-0 0 64 0 r---- 58.1
1.1 mspo 487:
488: 'xm create' allows you to create a new domain. It uses a config file in
489: PKG\_SYSCONFDIR for its parameters. By default, this file will be in
1.5 mspo 490: `/usr/pkg/etc/xen/`. On creation, a kernel has to be specified, which
491: will be executed in the new domain (this kernel is in the *domain0* file
492: system, not on the new domain virtual disk; but please note, you should
493: install the same kernel into *domainU* as `/netbsd` in order to make
1.27 jnemeth 494: your system tools, like savecore(8), work). A suitable kernel is
1.5 mspo 495: provided as part of the i386 and amd64 binary sets: XEN3\_DOMU.
1.1 mspo 496:
497: Here is an /usr/pkg/etc/xen/nbsd example config file:
498:
1.3 mspo 499: # -*- mode: python; -*-
500: #============================================================================
501: # Python defaults setup for 'xm create'.
502: # Edit this file to reflect the configuration of your system.
503: #============================================================================
1.5 mspo 504:
1.3 mspo 505: #----------------------------------------------------------------------------
506: # Kernel image file. This kernel will be loaded in the new domain.
507: kernel = "/home/bouyer/netbsd-XEN3_DOMU"
508: #kernel = "/home/bouyer/netbsd-INSTALL_XEN3_DOMU"
1.5 mspo 509:
1.3 mspo 510: # Memory allocation (in megabytes) for the new domain.
511: memory = 128
1.5 mspo 512:
1.3 mspo 513: # A handy name for your new domain. This will appear in 'xm list',
514: # and you can use this as parameters for xm in place of the domain
515: # number. All domains must have different names.
516: #
517: name = "nbsd"
1.5 mspo 518:
1.3 mspo 519: # The number of virtual CPUs this domain has.
520: #
521: vcpus = 1
1.5 mspo 522:
1.3 mspo 523: #----------------------------------------------------------------------------
524: # Define network interfaces for the new domain.
1.5 mspo 525:
1.3 mspo 526: # Number of network interfaces (must be at least 1). Default is 1.
527: nics = 1
1.5 mspo 528:
1.3 mspo 529: # Define MAC and/or bridge for the network interfaces.
530: #
531: # The MAC address specified in ``mac'' is the one used for the interface
532: # in the new domain. The interface in domain0 will use this address XOR'd
533: # with 00:00:00:01:00:00 (i.e. aa:00:00:51:02:f0 in our example). Random
534: # MACs are assigned if not given.
535: #
536: # ``bridge'' is a required parameter, which will be passed to the
537: # vif-script called by xend(8) when a new domain is created to configure
538: # the new xvif interface in domain0.
539: #
540: # In this example, the xvif is added to bridge0, which should have been
541: # set up prior to the new domain being created -- either in the
542: # ``network'' script or using a /etc/ifconfig.bridge0 file.
543: #
544: vif = [ 'mac=aa:00:00:50:02:f0, bridge=bridge0' ]
1.5 mspo 545:
1.3 mspo 546: #----------------------------------------------------------------------------
547: # Define the disk devices you want the domain to have access to, and
548: # what you want them accessible as.
549: #
550: # Each disk entry is of the form:
551: #
1.5 mspo 552: # phy:DEV,VDEV,MODE
1.3 mspo 553: #
554: # where DEV is the device, VDEV is the device name the domain will see,
555: # and MODE is r for read-only, w for read-write. You can also create
556: # file-backed domains using disk entries of the form:
557: #
1.5 mspo 558: # file:PATH,VDEV,MODE
1.3 mspo 559: #
560: # where PATH is the path to the file used as the virtual disk, and VDEV
561: # and MODE have the same meaning as for ``phy'' devices.
562: #
563: # VDEV doesn't really matter for a NetBSD guest OS (it's just used as an index),
564: # but it does for Linux.
565: # Worse, the device has to exist in /dev/ of domain0, because xm will
566: # try to stat() it. This means that in order to load a Linux guest OS
567: # from a NetBSD domain0, you'll have to create /dev/hda1, /dev/hda2, ...
568: # on domain0, with the major/minor from Linux :(
569: # Alternatively it's possible to specify the device number in hex,
570: # e.g. 0x301 for /dev/hda1, 0x302 for /dev/hda2, etc ...
1.5 mspo 571:
1.3 mspo 572: disk = [ 'phy:/dev/wd0e,0x1,w' ]
573: #disk = [ 'file:/var/xen/nbsd-disk,0x01,w' ]
574: #disk = [ 'file:/var/xen/nbsd-disk,0x301,w' ]
1.5 mspo 575:
1.3 mspo 576: #----------------------------------------------------------------------------
577: # Set the kernel command line for the new domain.
1.5 mspo 578:
1.3 mspo 579: # Set root device. This one does matter for NetBSD
580: root = "xbd0"
581: # extra parameters passed to the kernel
582: # this is where you can set boot flags like -s, -a, etc ...
583: #extra = ""
1.5 mspo 584:
1.3 mspo 585: #----------------------------------------------------------------------------
586: # Set according to whether you want the domain restarted when it exits.
587: # The default is False.
588: #autorestart = True
1.5 mspo 589:
1.3 mspo 590: # end of nbsd config file ====================================================
1.1 mspo 591:
592: When a new domain is created, xen calls the
1.5 mspo 593: `/usr/pkg/etc/xen/vif-bridge` script for each virtual network interface
594: created in *domain0*. This can be used to automatically configure the
595: xvif?.? interfaces in *domain0*. In our example, these will be bridged
596: with the bridge0 device in *domain0*, but the bridge has to exist first.
597: To do this, create the file `/etc/ifconfig.bridge0` and make it look
598: like this:
1.1 mspo 599:
1.3 mspo 600: create
601: !brconfig $int add ex0 up
1.1 mspo 602:
1.5 mspo 603: (replace `ex0` with the name of your physical interface). Then bridge0
1.27 jnemeth 604: will be created on boot. See the bridge(4) man page for details.
1.1 mspo 605:
1.5 mspo 606: So, here is a suitable `/usr/pkg/etc/xen/vif-bridge` for xvif?.? (a
607: working vif-bridge is also provided with xentools20) configuring:
1.1 mspo 608:
1.5 mspo 609: #!/bin/sh
1.3 mspo 610: #============================================================================
1.38 ! gdt 611: # $NetBSD: howto.mdwn,v 1.37 2014/12/24 16:06:38 gdt Exp $
1.3 mspo 612: #
613: # /usr/pkg/etc/xen/vif-bridge
614: #
615: # Script for configuring a vif in bridged mode with a dom0 interface.
616: # The xend(8) daemon calls a vif script when bringing a vif up or down.
617: # The script name to use is defined in /usr/pkg/etc/xen/xend-config.sxp
618: # in the ``vif-script'' field.
619: #
620: # Usage: vif-bridge up|down [var=value ...]
621: #
622: # Actions:
1.5 mspo 623: # up Adds the vif interface to the bridge.
624: # down Removes the vif interface from the bridge.
1.3 mspo 625: #
626: # Variables:
1.5 mspo 627: # domain name of the domain the interface is on (required).
628: # vifq vif interface name (required).
629: # mac vif MAC address (required).
630: # bridge bridge to add the vif to (required).
1.3 mspo 631: #
632: # Example invocation:
633: #
634: # vif-bridge up domain=VM1 vif=xvif1.0 mac="ee:14:01:d0:ec:af" bridge=bridge0
635: #
636: #============================================================================
1.5 mspo 637:
1.3 mspo 638: # Exit if anything goes wrong
639: set -e
1.5 mspo 640:
1.3 mspo 641: echo "vif-bridge $*"
1.5 mspo 642:
1.3 mspo 643: # Operation name.
644: OP=$1; shift
1.5 mspo 645:
1.3 mspo 646: # Pull variables in args into environment
647: for arg ; do export "${arg}" ; done
1.5 mspo 648:
1.3 mspo 649: # Required parameters. Fail if not set.
650: domain=${domain:?}
651: vif=${vif:?}
652: mac=${mac:?}
653: bridge=${bridge:?}
1.5 mspo 654:
1.3 mspo 655: # Optional parameters. Set defaults.
656: ip=${ip:-''} # default to null (do nothing)
1.5 mspo 657:
1.3 mspo 658: # Are we going up or down?
659: case $OP in
1.5 mspo 660: up) brcmd='add' ;;
1.3 mspo 661: down) brcmd='delete' ;;
662: *)
1.5 mspo 663: echo 'Invalid command: ' $OP
664: echo 'Valid commands are: up, down'
665: exit 1
666: ;;
1.3 mspo 667: esac
1.5 mspo 668:
1.3 mspo 669: # Don't do anything if the bridge is "null".
670: if [ "${bridge}" = "null" ] ; then
1.5 mspo 671: exit
1.3 mspo 672: fi
1.5 mspo 673:
1.3 mspo 674: # Don't do anything if the bridge doesn't exist.
675: if ! ifconfig -l | grep "${bridge}" >/dev/null; then
1.5 mspo 676: exit
1.3 mspo 677: fi
1.5 mspo 678:
1.3 mspo 679: # Add/remove vif to/from bridge.
680: ifconfig x${vif} $OP
681: brconfig ${bridge} ${brcmd} x${vif}
1.1 mspo 682:
683: Now, running
684:
1.3 mspo 685: xm create -c /usr/pkg/etc/xen/nbsd
1.1 mspo 686:
1.5 mspo 687: should create a domain and load a NetBSD kernel in it. (Note: `-c`
688: causes xm to connect to the domain's console once created.) The kernel
689: will try to find its root file system on xbd0 (i.e., wd0e) which hasn't
690: been created yet. wd0e will be seen as a disk device in the new domain,
691: so it will be 'sub-partitioned'. We could attach a ccd to wd0e in
692: *domain0* and partition it, newfs and extract the NetBSD/i386 or amd64
693: tarballs there, but there's an easier way: load the
694: `netbsd-INSTALL_XEN3_DOMU` kernel provided in the NetBSD binary sets.
695: Like other install kernels, it contains a ramdisk with sysinst, so you
696: can install NetBSD using sysinst on your new domain.
1.1 mspo 697:
698: If you want to install NetBSD/Xen with a CDROM image, the following line
1.5 mspo 699: should be used in the `/usr/pkg/etc/xen/nbsd` file:
1.1 mspo 700:
1.3 mspo 701: disk = [ 'phy:/dev/wd0e,0x1,w', 'phy:/dev/cd0a,0x2,r' ]
1.1 mspo 702:
703: After booting the domain, the option to install via CDROM may be
1.5 mspo 704: selected. The CDROM device should be changed to `xbd1d`.
1.1 mspo 705:
1.5 mspo 706: Once done installing, `halt -p` the new domain (don't reboot or halt, it
707: would reload the INSTALL\_XEN3\_DOMU kernel even if you changed the
1.1 mspo 708: config file), switch the config file back to the XEN3\_DOMU kernel, and
1.5 mspo 709: start the new domain again. Now it should be able to use `root on xbd0a`
710: and you should have a second, functional NetBSD system on your xen
711: installation.
1.1 mspo 712:
713: When the new domain is booting you'll see some warnings about *wscons*
714: and the pseudo-terminals. These can be fixed by editing the files
1.5 mspo 715: `/etc/ttys` and `/etc/wscons.conf`. You must disable all terminals in
716: `/etc/ttys`, except *console*, like this:
1.1 mspo 717:
1.3 mspo 718: console "/usr/libexec/getty Pc" vt100 on secure
719: ttyE0 "/usr/libexec/getty Pc" vt220 off secure
720: ttyE1 "/usr/libexec/getty Pc" vt220 off secure
721: ttyE2 "/usr/libexec/getty Pc" vt220 off secure
722: ttyE3 "/usr/libexec/getty Pc" vt220 off secure
1.1 mspo 723:
1.5 mspo 724: Finally, all screens must be commented out from `/etc/wscons.conf`.
1.1 mspo 725:
726: It is also desirable to add
727:
1.3 mspo 728: powerd=YES
1.1 mspo 729:
1.5 mspo 730: in rc.conf. This way, the domain will be properly shut down if
731: `xm shutdown -R` or `xm shutdown -H` is used on the domain0.
1.1 mspo 732:
733: Your domain should be now ready to work, enjoy.
734:
1.14 gdt 735: Creating an unprivileged Linux domain (domU)
1.5 mspo 736: --------------------------------------------
1.1 mspo 737:
738: Creating unprivileged Linux domains isn't much different from
739: unprivileged NetBSD domains, but there are some details to know.
740:
741: First, the second parameter passed to the disk declaration (the '0x1' in
742: the example below)
743:
1.3 mspo 744: disk = [ 'phy:/dev/wd0e,0x1,w' ]
1.1 mspo 745:
746: does matter to Linux. It wants a Linux device number here (e.g. 0x300
747: for hda). Linux builds device numbers as: (major \<\< 8 + minor). So,
748: hda1 which has major 3 and minor 1 on a Linux system will have device
749: number 0x301. Alternatively, devices names can be used (hda, hdb, ...)
750: as xentools has a table to map these names to devices numbers. To export
751: a partition to a Linux guest we can use:
752:
1.3 mspo 753: disk = [ 'phy:/dev/wd0e,0x300,w' ]
754: root = "/dev/hda1 ro"
1.1 mspo 755:
756: and it will appear as /dev/hda on the Linux system, and be used as root
757: partition.
758:
759: To install the Linux system on the partition to be exported to the guest
760: domain, the following method can be used: install sysutils/e2fsprogs
761: from pkgsrc. Use mke2fs to format the partition that will be the root
762: partition of your Linux domain, and mount it. Then copy the files from a
1.5 mspo 763: working Linux system, make adjustments in `/etc` (fstab, network
764: config). It should also be possible to extract binary packages such as
765: .rpm or .deb directly to the mounted partition using the appropriate
766: tool, possibly running under NetBSD's Linux emulation. Once the
767: filesystem has been populated, umount it. If desirable, the filesystem
768: can be converted to ext3 using tune2fs -j. It should now be possible to
769: boot the Linux guest domain, using one of the vmlinuz-\*-xenU kernels
770: available in the Xen binary distribution.
1.1 mspo 771:
772: To get the linux console right, you need to add:
773:
1.3 mspo 774: extra = "xencons=tty1"
1.1 mspo 775:
776: to your configuration since not all linux distributions auto-attach a
777: tty to the xen console.
778:
1.14 gdt 779: Creating an unprivileged Solaris domain (domU)
1.5 mspo 780: ----------------------------------------------
1.1 mspo 781:
782: Download an Opensolaris [release](http://opensolaris.org/os/downloads/)
783: or [development snapshot](http://genunix.org/) DVD image. Attach the DVD
1.5 mspo 784: image to a MAN.VND.4 device. Copy the kernel and ramdisk filesystem
785: image to your dom0 filesystem.
1.1 mspo 786:
1.3 mspo 787: dom0# mkdir /root/solaris
788: dom0# vnconfig vnd0 osol-1002-124-x86.iso
789: dom0# mount /dev/vnd0a /mnt
1.5 mspo 790:
1.3 mspo 791: ## for a 64-bit guest
792: dom0# cp /mnt/boot/amd64/x86.microroot /root/solaris
793: dom0# cp /mnt/platform/i86xpv/kernel/amd64/unix /root/solaris
1.5 mspo 794:
1.3 mspo 795: ## for a 32-bit guest
796: dom0# cp /mnt/boot/x86.microroot /root/solaris
797: dom0# cp /mnt/platform/i86xpv/kernel/unix /root/solaris
1.5 mspo 798:
1.3 mspo 799: dom0# umount /mnt
1.5 mspo 800:
801:
802: Keep the MAN.VND.4 configured. For some reason the boot process stalls
803: unless the DVD image is attached to the guest as a "phy" device. Create
804: an initial configuration file with the following contents. Substitute
805: */dev/wd0k* with an empty partition at least 8 GB large.
1.1 mspo 806:
1.4 mspo 807: memory = 640
808: name = 'solaris'
809: disk = [ 'phy:/dev/wd0k,0,w' ]
810: disk += [ 'phy:/dev/vnd0d,6:cdrom,r' ]
811: vif = [ 'bridge=bridge0' ]
812: kernel = '/root/solaris/unix'
813: ramdisk = '/root/solaris/x86.microroot'
814: # for a 64-bit guest
815: extra = '/platform/i86xpv/kernel/amd64/unix - nowin -B install_media=cdrom'
816: # for a 32-bit guest
817: #extra = '/platform/i86xpv/kernel/unix - nowin -B install_media=cdrom'
1.5 mspo 818:
819:
1.1 mspo 820: Start the guest.
821:
1.4 mspo 822: dom0# xm create -c solaris.cfg
823: Started domain solaris
824: v3.3.2 chgset 'unavailable'
825: SunOS Release 5.11 Version snv_124 64-bit
826: Copyright 1983-2009 Sun Microsystems, Inc. All rights reserved.
827: Use is subject to license terms.
828: Hostname: opensolaris
829: Remounting root read/write
830: Probing for device nodes ...
831: WARNING: emlxs: ddi_modopen drv/fct failed: err 2
832: Preparing live image for use
833: Done mounting Live image
1.5 mspo 834:
1.1 mspo 835:
836: Make sure the network is configured. Note that it can take a minute for
837: the xnf0 interface to appear.
838:
1.4 mspo 839: opensolaris console login: jack
840: Password: jack
841: Sun Microsystems Inc. SunOS 5.11 snv_124 November 2008
842: jack@opensolaris:~$ pfexec sh
843: sh-3.2# ifconfig -a
844: sh-3.2# exit
1.5 mspo 845:
1.1 mspo 846:
847: Set a password for VNC and start the VNC server which provides the X11
848: display where the installation program runs.
849:
1.4 mspo 850: jack@opensolaris:~$ vncpasswd
851: Password: solaris
852: Verify: solaris
853: jack@opensolaris:~$ cp .Xclients .vnc/xstartup
854: jack@opensolaris:~$ vncserver :1
1.5 mspo 855:
1.1 mspo 856:
1.5 mspo 857: From a remote machine connect to the VNC server. Use `ifconfig xnf0` on
858: the guest to find the correct IP address to use.
1.1 mspo 859:
1.4 mspo 860: remote$ vncviewer 172.18.2.99:1
1.5 mspo 861:
1.1 mspo 862:
863: It is also possible to launch the installation on a remote X11 display.
864:
1.4 mspo 865: jack@opensolaris:~$ export DISPLAY=172.18.1.1:0
866: jack@opensolaris:~$ pfexec gui-install
1.5 mspo 867:
1.1 mspo 868:
869: After the GUI installation is complete you will be asked to reboot.
870: Before that you need to determine the ZFS ID for the new boot filesystem
871: and update the configuration file accordingly. Return to the guest
872: console.
873:
1.4 mspo 874: jack@opensolaris:~$ pfexec zdb -vvv rpool | grep bootfs
875: bootfs = 43
876: ^C
877: jack@opensolaris:~$
1.5 mspo 878:
1.1 mspo 879:
880: The final configuration file should look like this. Note in particular
881: the last line.
882:
1.4 mspo 883: memory = 640
884: name = 'solaris'
885: disk = [ 'phy:/dev/wd0k,0,w' ]
886: vif = [ 'bridge=bridge0' ]
887: kernel = '/root/solaris/unix'
888: ramdisk = '/root/solaris/x86.microroot'
889: extra = '/platform/i86xpv/kernel/amd64/unix -B zfs-bootfs=rpool/43,bootpath="/xpvd/xdf@0:a"'
1.5 mspo 890:
1.1 mspo 891:
892: Restart the guest to verify it works correctly.
893:
1.4 mspo 894: dom0# xm destroy solaris
895: dom0# xm create -c solaris.cfg
896: Using config file "./solaris.cfg".
897: v3.3.2 chgset 'unavailable'
898: Started domain solaris
899: SunOS Release 5.11 Version snv_124 64-bit
900: Copyright 1983-2009 Sun Microsystems, Inc. All rights reserved.
901: Use is subject to license terms.
902: WARNING: emlxs: ddi_modopen drv/fct failed: err 2
903: Hostname: osol
904: Configuring devices.
905: Loading smf(5) service descriptions: 160/160
906: svccfg import warnings. See /var/svc/log/system-manifest-import:default.log .
907: Reading ZFS config: done.
908: Mounting ZFS filesystems: (6/6)
909: Creating new rsa public/private host key pair
910: Creating new dsa public/private host key pair
1.5 mspo 911:
1.4 mspo 912: osol console login:
1.5 mspo 913:
1.1 mspo 914:
915: Using PCI devices in guest domains
1.14 gdt 916: ----------------------------------
1.1 mspo 917:
918: The domain0 can give other domains access to selected PCI devices. This
919: can allow, for example, a non-privileged domain to have access to a
920: physical network interface or disk controller. However, keep in mind
921: that giving a domain access to a PCI device most likely will give the
922: domain read/write access to the whole physical memory, as PCs don't have
923: an IOMMU to restrict memory access to DMA-capable device. Also, it's not
924: possible to export ISA devices to non-domain0 domains (which means that
925: the primary VGA adapter can't be exported. A guest domain trying to
926: access the VGA registers will panic).
927:
928: This functionality is only available in NetBSD-5.1 (and later) domain0
929: and domU. If the domain0 is NetBSD, it has to be running Xen 3.1, as
930: support has not been ported to later versions at this time.
931:
932: For a PCI device to be exported to a domU, is has to be attached to the
1.5 mspo 933: `pciback` driver in domain0. Devices passed to the domain0 via the
934: pciback.hide boot parameter will attach to `pciback` instead of the
935: usual driver. The list of devices is specified as `(bus:dev.func)`,
936: where bus and dev are 2-digit hexadecimal numbers, and func a
937: single-digit number:
1.1 mspo 938:
1.4 mspo 939: pciback.hide=(00:0a.0)(00:06.0)
1.1 mspo 940:
941: pciback devices should show up in the domain0's boot messages, and the
1.5 mspo 942: devices should be listed in the `/kern/xen/pci` directory.
1.1 mspo 943:
1.5 mspo 944: PCI devices to be exported to a domU are listed in the `pci` array of
945: the domU's config file, with the format `'0000:bus:dev.func'`
1.1 mspo 946:
1.4 mspo 947: pci = [ '0000:00:06.0', '0000:00:0a.0' ]
1.1 mspo 948:
1.5 mspo 949: In the domU an `xpci` device will show up, to which one or more pci
950: busses will attach. Then the PCI drivers will attach to PCI busses as
951: usual. Note that the default NetBSD DOMU kernels do not have `xpci` or
952: any PCI drivers built in by default; you have to build your own kernel
953: to use PCI devices in a domU. Here's a kernel config example:
1.1 mspo 954:
1.4 mspo 955: include "arch/i386/conf/XEN3_DOMU"
956: #include "arch/i386/conf/XENU" # in NetBSD 3.0
1.5 mspo 957:
1.4 mspo 958: # Add support for PCI busses to the XEN3_DOMU kernel
959: xpci* at xenbus ?
960: pci* at xpci ?
1.5 mspo 961:
1.4 mspo 962: # Now add PCI and related devices to be used by this domain
963: # USB Controller and Devices
1.5 mspo 964:
1.4 mspo 965: # PCI USB controllers
966: uhci* at pci? dev ? function ? # Universal Host Controller (Intel)
1.5 mspo 967:
1.4 mspo 968: # USB bus support
969: usb* at uhci?
1.5 mspo 970:
1.4 mspo 971: # USB Hubs
972: uhub* at usb?
973: uhub* at uhub? port ? configuration ? interface ?
1.5 mspo 974:
1.4 mspo 975: # USB Mass Storage
976: umass* at uhub? port ? configuration ? interface ?
977: wd* at umass?
978: # SCSI controllers
979: ahc* at pci? dev ? function ? # Adaptec [23]94x, aic78x0 SCSI
1.5 mspo 980:
1.4 mspo 981: # SCSI bus support (for both ahc and umass)
982: scsibus* at scsi?
1.5 mspo 983:
1.4 mspo 984: # SCSI devices
985: sd* at scsibus? target ? lun ? # SCSI disk drives
986: cd* at scsibus? target ? lun ? # SCSI CD-ROM drives
1.1 mspo 987:
988:
1.28 gdt 989: NetBSD as a domU in a VPS
990: =========================
991:
992: The bulk of the HOWTO is about using NetBSD as a dom0 on your own
993: hardware. This section explains how to deal with Xen in a domU as a
994: virtual private server where you do not control or have access to the
995: dom0.
996:
997: TODO: Perhaps reference panix, prmgr, amazon as interesting examples.
998:
999: TODO: Somewhere, discuss pvgrub and py-grub to load the domU kernel
1000: from the domU filesystem.
CVSweb for NetBSD wikisrc <wikimaster@NetBSD.org> software: FreeBSD-CVSweb
![[BACK]](/icons/back.gif){kind=icon}
Return to howto.mdwn CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [NetBSD Developer Wiki] / wikisrc / ports / xen