Chris Lalancette
2008-Aug-22 11:07 UTC
[Ovirt-devel] [PATCH]: Remove bad documentation files
Remove a bunch of the documentation in the source tree that was not only wrong, but actively misleading in some cases. Signed-off-by: Chris Lalancette <clalance at redhat.com> diff --git a/README b/README deleted file mode 100644 index 2d8a975..0000000 --- a/README +++ /dev/null @@ -1,22 +0,0 @@ -To do the setup for an Ovirt host, look in the ovirt-host-creator/ directory -and read INSTALL and README. - -To setup a management application, look in the wui/ directory. - -Temporary: we don't have a README for the wui directory yet, so I'll just put -this info here so I don't lose it. - -To make the task-omatic part of the WUI work properly, we have to create a -keytab for it and put it in the right spot. This is so that taskomatic can -properly authenticate to the freeipa server. - -On the freeipa server: -# kadmin.local - > addprinc -randkey libvirt/<hostname>@<realm> (where <hostname> is the DNS - name of the machine where the - WUI is running, and <realm> - is the realm you are using) - > modprinc +requires_preauth libvirt/<hostname>@<realm> - > ktadd -k /tmp/taskomatic.keytab libvirt/<hostname>@<realm> - > quit -# scp /tmp/taskomatic.keytab wui:/usr/share/ovirt-wui/ovirt.keytab (where 'wui' is the name of the machine where the WUI is running) diff --git a/ovirt-host-creator/INSTALL b/ovirt-host-creator/INSTALL deleted file mode 100644 index 42cb1ac..0000000 --- a/ovirt-host-creator/INSTALL +++ /dev/null @@ -1,179 +0,0 @@ -Installation instructions -------------------------- - -[ CAUTION: The instructions in http://ovirt.org/install-instructions.html - are usually more up-to-date than the instructions here. ] - -This file describes an Ovirt installation using a Flash drive as the root -partition. This is the easiest configuration to work with; using either a -LiveCD or PXE is very similar, but presents a few additional steps, so it -will not be discussed here. - -In order to have an ovirt host start up, you'll need to have two machines -available: - -Machine 1 - Fedora 8 x86_64 machine - this will be the build server and the -DHCP/NFS/iSCSI server for the rest of the setup - -Machine 2 - x86_64 machine - this will be the Ovirt host at the end - -There are quite a few steps to getting this running, so let's get started. - -Machine 1/Build Server setup -1) Make sure you have the following packages installed on the build server: - -python-virtinst -libvirt -libvirt-python -libvirt-devel -livecd-tools -dhcp -nfs-utils -scsi-target-utils -gnutls-utils -git -httpd -cyrus-sasl -cyrus-sasl-lib -cyrus-sasl-gssapi -rpm-build -libxml2-devel -perl-ExtUtils-MakeMaker -lm_sensors-devel -python-devel -readline-devel -ncurses-devel -avahi-devel -qemu -cyrus-sasl-devel -gcc -autoconf -automake -libtool -SDL-devel -dev86 -iasl -compat-gcc-34 -e2fsprogs-devel -texi2html -glibc-devel -kernel-devel -createrepo -rrdtool-devel - -2) Checkout the ovirt repo: -# git clone git://et.devel.redhat.com/ovirt - -3) Compile the collectd SRPM located in the "srpms" directory. When it's -done compiling, do the following: - -# mkdir -p /var/www/html/rpms -# cp collectd-<version>.x86_64.rpm /var/www/html/rpms -# createrepo /var/www/html/rpms - -4) Recompile the libvirt SRPM with GSSAPI/kerberos support (located in the -"srpms" directory). When it's done recompiling, do the following: - -# mkdir -p /var/www/html/rpms -# cp libvirt-<version>.x86_64.rpm /var/www/html/rpms -# createrepo /var/www/html/rpms - -5) Recompile the kvm SRPM located in the "srpms" directory. We need this to -bring it up to version 54; note that just using the package from rawhide is -*not* enough, since it doesn't include the updated kernel modules. You need to -install the kernel-devel package to successfully compile this. Note that the -version of kernel-devel you need is the version that will be on the ovirt host, -that is, what is going to get pulled in by yum in subsequent steps; otherwise, -the modules will fail to load on the ovirt host. When it is done recompiling, -do the following: - -# mkdir -p /var/www/html/rpms -# cp kvm-<version>modules.x86_64.rpm /var/www/html/rpms -# createrepo /var/www/html/rpms - -6) Edit ovirt.ks, and add an additional repo where it will pull the collectd -RPM (and optionally, the kerberized libvirt RPM). There is an example repo in -there already. - -7) Put a 1GB (or greater) flash drive into the machine; you'll need to find out -which SCSI device it got assigned to via dmesg (mine went to /dev/sdc, for -instance) - -8) # cd /root/ovirt ; ./ovirt-flash.sh /dev/sdc - -(replacing /dev/sdc with the device your USB stick is). Be warned that this -will totally destroy any data on the USB stick, so make sure to back up any -data you care about. This step will take quite a while, as it will download -and yum install all of the necessary packages into a chroot jail, run the -kickstart %post, and lay the resulting image down on the USB stick. - -9) Edit /etc/dhcpd.conf; you'll want to make it look like: - --------------------------<cut here>---------------------------------------- -allow booting; -allow bootp; -ddns-update-style interim; -ignore client-updates; - -option libvirt-auth-method code 202 = text; - -subnet 192.168.25.0 netmask 255.255.255.0 { - option domain-name "redhat.com"; - option domain-name-servers 172.16.76.10,172.16.76.20; - next-server 192.168.25.1; - option routers 192.168.25.1; - option libvirt-auth-method "krb5:192.168.25.1"; - host perf200 { - fixed-address 192.168.25.200; - hardware ethernet 00:13:20:f5:fa:7c; - } - - filename "pxelinux.0"; -} --------------------------<cut here>---------------------------------------- - -Make sure to replace the subnet with the one you want to use, the -domain-name-servers to what you want, and the next-server, routers, -and libvirt-auth-method options to be the IP address of *this* server. -Finally, make sure that you change the "host perf200" to assign a static IP -address to your ovirt host(s). The IP address and DNS name will be important -for a number of the authentication mechanisms later. - -10) Follow the steps in README.krb5 for setup. You'll need to take the -/etc/krb5.conf and keytable files that you generated for the "ovirt" -machine and place them in /var/www/html for the init scripts to fetch. -Make sure to call the keytable file "<ip>-libvirt.tab" and the krb5.conf -file "<ip>-krb5.conf", as that is the filename the scripts will look for. - -11) Setup the services you need: - -# service dhcpd start -# service iptables stop -# service httpd start - -12) Set up 1 or more iSCSI LUNs for export: - -# lvcreate -n iSCSI1 -L +10G /dev/HostGroup - -(or whatever you want; just make sure that you have either a raw partition or -an LVM volume available for guests) - -# service tgtd start -# tgtadm --lld iscsi --op new --mode target --tid 1 -T host:storage - -(the host:storage can actually be anything you want; it's mostly used as a -descriptive name later. I made mine <hostname>:storage.virt) - -# tgtadm --lld iscsi --op new --mode logicalunit --tid 1 --lun 1 -b /dev/HostGroup/iSCSI1 - -(this exports /dev/HostGroup/iSCSI1 as LUN 1 on the target we made above. If -you want, repeat this for additional devices, making sure to incremente the LUN -for each) - -# tgtadm --lld iscsi --op bind --mode target --tid 1 -I ALL - -Machine 2/Ovirt Host: -1) Take the USB stick created on the build server, and make sure your BIOS -is set to boot to USB. -2) Boot the host; it should come up and login to all of the iSCSI servers -that you specified. It should also be all setup for connecting via GSSAPI. diff --git a/ovirt-host-creator/README b/ovirt-host-creator/README deleted file mode 100644 index e59bc12..0000000 --- a/ovirt-host-creator/README +++ /dev/null @@ -1,142 +0,0 @@ -OVIRT SCRIPTS README --------------------- - -[ CAUTION: The instructions in http://ovirt.org/install-instructions.html - are usually more up-to-date than the instructions here. ] - -If this is the first time you are using the Ovirt scripts, start with INSTALL. -This file is a collection of usage notes, and they assume INSTALL has already -been completed. - -This is currently a collection of scripts to build/deploy an Ovirt instance, -which is essentially stateless. Each of the commands is described below, along -with common usage. - -ovirt-cd.sh: This is just a thin wrapper around livecd-creator, mostly here for -orthogonality with the other commands. - -ovirt-flash.sh: This is a wrapper around creator.py and livecd-iso-to-disk. -Basically this creates an ISO with creator.py, and then lays down that ISO on -top of a flash drive. It is run as: - -./ovirt-flash.sh <usb-device> [base_iso] - -where the second argument is a base ISO to start from. Note that this command -completely destroys any USB device you point it at, so be careful. - -ovirt-flash-static.sh: This is a wrapper around creator.py that additionally -will lay down the output from the creator.py onto a flash drive. It is -"static" because when you boot from this, you are actually booting and writing -to the flash drive, not to a "LiveCD", in-memory drive. This is useful for -development. - -ovirt-pxe.sh: This is a command to create the files needed to do a PXE boot of -ovirt. It is run as: - -./ovirt-pxe.sh [base_iso] - -What this command does is to create an ISO (or use the one from base_iso), and -then create a tftpboot/ in the local directory to set it all up for PXE -booting. You can then follow README.pxe to set up the rest of the server, and -you should be able to get the machine to boot from PXE. - -Typical Script Usage --------------------- - -Here's how I've been typically using these scripts. - -1) Have a 1GB flash drive. I think you can get away with 500MB, but it might -be quite tight. Put the flash drive into the machine where you have the -scripts. -2) Run ./ovirt-flash.sh /dev/sdc. This will build an ISO from repos, and -lay it down on /dev/sdc -3) Put the flash drive in the target machine, and boot that machine from USB. -4) Oops! I need to make a change. Edit the ovirt.ks, then run -./creator.py -b iso_from_last_step -c ovirt.ks; this will just update the parts -of the ISO that is needed, which is much faster than regenerating the whole -thing. Now run ./ovirt-flash.sh /dev/sdc modified_iso, to lay down the -ISO on the flash drive. - -Ovirt Usage ------------ -After booting the Ovirt machine with one of these methods, in theory everything -should be setup for a remote install. You'll need to use the modified -ovirt-install.py in the repository; really the only part that is substantially -modified is the section that checks with storage, since virt-install is -assuming everything is locally stored. There are three caveats to using the -modified ovirt-install.py: - -1) You need to copy over the boot.iso to the Ovirt machine. Currently it has -no way to fetch this stuff remotely. In theory we can use PXE for this, -eliminating the need for the CD at all, but I haven't tested it. - -2) In case you are using the boot.iso, you *also* need to have it locally, in -the same location, on the build machine. This is because there is one part -of the install that actually checks for the existence of the boot.iso, but it -operates on the local machine. - -3) You need to know which bridge you want to bind this guest to, so you can -pass it in. They are called "ovirtbr<n>", starting from 0; if you only have -one network card, it makes it easy. - -Assuming you have the above in place, you should be able to do: - -# ./ovirt-install.py --connect qemu+tcp://perf200.perf.redhat.com/system -n f8x86_64 -r 512 -f /dev/disk/by-id/scsi-16465616462656166313a3100000000000000000000000000 --vnc -c /root/boot.iso --bridge ovirtbr0 --accelerate -v - -If you have virt-viewer installed locally, it should automatically pop up and -connect to the console. - -iSCSI disks ------------ -When using iSCSI as the target for disks, you definitely don't want to use -the /dev/sdc device, or whatever. That could change on subsequent reboots -depending on what order devices are scanned in, how many iSCSI servers there -are, etc, etc. What you really want to use is the ID (or WWID, or UUID) of the -device. That's available through /dev/disk/by-id. For example, say I've -mapped 3 LUNs from iSCSI server laforge. If I run "# ls /dev/disk/by-path", I -see the following: - -ip-192.168.25.1:3260-iscsi-laforge:storage.virt-lun-1 -ip-192.168.25.1:3260-iscsi-laforge:storage.virt-lun-1-part1 -ip-192.168.25.1:3260-iscsi-laforge:storage.virt-lun-1-part2 -ip-192.168.25.1:3260-iscsi-laforge:storage.virt-lun-2 -ip-192.168.25.1:3260-iscsi-laforge:storage.virt-lun-2-part1 -ip-192.168.25.1:3260-iscsi-laforge:storage.virt-lun-2-part2 -ip-192.168.25.1:3260-iscsi-laforge:storage.virt-lun-3 -pci-0000:00:1f.2-scsi-0:0:0:0 -pci-0000:00:1f.2-scsi-0:0:0:0-part1 -pci-0000:00:1f.2-scsi-0:0:0:0-part2 -pci-0000:00:1f.2-scsi-1:0:0:0 - -Note that there are 3 LUNs there. If you know you want to install on LUN 3, -then "# ls -l /dev/disk/by-path/ip-192.168.25.1:3260-iscsi-laforge:storage.virt-lun-3" and you'll see: - -lrwxrwxrwx 1 root root 9 2007-10-24 19:14 ip-192.168.25.1:3260-iscsi-laforge:storage.virt-lun-3 -> ../../sdd - -Now run: - -# /sbin/scsi_id -g -u -s /block/sdd -16465616462656166313a3300000000000000000000000000 - -Which gives you the ID. Finally, what this means is that for your disk device, -you should use: - -/dev/disk/by-id/scsi-16465616462656166313a3300000000000000000000000000 - -which will persist across reboots, and even changes to the LUN scheme. - -Miscellaneous -------------- -We are only going to support kerberos in Ovirt, so we disable TLS completely -and open up the TCP port. - -TODO ----- -1) List of packages to later remove (but are extremely useful for debugging): - a) less - b) openssh-server - c) openssh-clients - d) net-tools - e) nfs-utils - f) wget -2) Use proper iscsid/iscsi startup scripts instead of my hacked up iscsi_scan.sh diff --git a/ovirt-host-creator/README.pxe b/ovirt-host-creator/README.pxe deleted file mode 100644 index fc8a684..0000000 --- a/ovirt-host-creator/README.pxe +++ /dev/null @@ -1,16 +0,0 @@ -This README describes how to set up the server so that you can PXE boot your -ovirt host. Note that there is not much to do, as the ovirt-setup-pxe script -sets up most of the stuff you need. - -On "server" machine: -1. Follow the instructions in INSTALL, except skip the step where you create - the flash device with ovirt-flash.sh. -2. # yum install tftp-server dhcp tftp dhclient -3. edit /etc/xinetd.d/tftp, change disable to no -4. # service xinetd restart -5. Run the "ovirt-pxe" script, which will create a ./tftpboot - directory and put in it everything needed for Ovirt. If you don't - supply your own base_iso, this script creates one for you. - # ./ovirt-pxe.sh [base_iso] -6. Copy the contents to /tftpboot: - # cp -a --remove-destination tftpboot/* /tftpboot