From a297b54cdae1a3c9f18693b00e7aef1e1164d6c1 Mon Sep 17 00:00:00 2001 From: Steve Woodcock Date: Mon, 18 Feb 2008 21:52:35 +0000 Subject: [PATCH] Some manpage cleanups --- docs/cobbler.pod | 22 +++++++++++----------- 1 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/cobbler.pod b/docs/cobbler.pod index 70c0337..9e5dc0f 100644 --- a/docs/cobbler.pod +++ b/docs/cobbler.pod @@ -37,11 +37,11 @@ Also see the aforementioned webpages for additional documentation, user contribu =head2 SETUP -After installing, run "cobbler check" to verify that cobbler's ecosystem is configured correctly. Cobbler check will direct you on how to modify it's config files using a text editor. +After installing, run "cobbler check" to verify that cobbler's ecosystem is configured correctly. Cobbler check will direct you on how to modify its config files using a text editor. Any problems detected should be corrected, with the potential exception of DHCP related warnings where you will need to use your judgement as to whether they apply to your environment. Run "cobbler sync" after making any changes to the configuration files to ensure those changes are applied to the environment. -It is especially important that the server name field be accurate in /var/lib/cobbler/settings, without this field being correct, kickstart trees will not be found, and automated installtions will fail. +It is especially important that the server name field be accurate in /var/lib/cobbler/settings, without this field being correct, kickstart trees will not be found, and automated installations will fail. For PXE, if DHCP is to be run from the cobbler server, the dhcp configuration file should be changed as suggested by "cobbler check". If DHCP is not run locally, the "next-server" field on the DHCP server should at minimum point to the cobbler server's IP and the filename should be set to "pxelinux.0". Alternatively, cobbler can also generate your dhcp configuration file if you want to run dhcp locally -- this is covered in a later section. If you don't already have a DHCP setup managed by some other tool, allowing cobbler to manage DHCP will prove to be useful as it can manage DHCP reservations and other data. If you already have a DHCP setup, moving an existing setup to be managed from within cobbler is relatively painless -- though usage of the DHCP management feature is entirely optional. If you are not interested in network booting via PXE and just want to use koan to install virtual systems or replace existing ones, DHCP configuration can be totally ignored. Koan also has a live CD (see koan's manpage) capability that can be used to simulate PXE environments. @@ -184,9 +184,9 @@ This parameter should be useful only in select circumstances. If machines are o =head2 ADDING A SYSTEM -System records map a piece of hardware (or a virtual machine) with the cobbler profile to be assigned to run on it. This may be thought of as chosing a role for a specific system. +System records map a piece of hardware (or a virtual machine) with the cobbler profile to be assigned to run on it. This may be thought of as choosing a role for a specific system. -Note that if provisioning via koan and PXE menus alone, it is not required to create system records, though they are useful when system specific customizations are required. One such customization would be defining the MAC address. If there is a specific role inteded for a given machine, system records should be created for it. +Note that if provisioning via koan and PXE menus alone, it is not required to create system records, though they are useful when system specific customizations are required. One such customization would be defining the MAC address. If there is a specific role intended for a given machine, system records should be created for it. B @@ -267,7 +267,7 @@ cobbler system report foo NOTE: Additional interfaces can presently only be deleted via the web interface. -=end +=back =head2 ADDING A REPOSITORY TO MIRROR @@ -363,7 +363,7 @@ Alternatively, you could look at the configuration files in /var/lib/cobbler to =head2 DELETING CONFIGURATION ENTRIES -If you want to remove a specific object, use the remove command with the name that was used to add it. +If you want to remove a specific object, use the "remove" command with the name that was used to add it. B @@ -563,13 +563,13 @@ The dhcpd.conf file will be updated each time "cobbler sync" is run, and not unt =head2 SERVICE DISCOVERY (AVAHI) -If the avahi-tools package is installed, cobblerd will broadcast it's presence on the network, allowing it to be discovered by koan with the koan --server=DISCOVER parameter. +If the avahi-tools package is installed, cobblerd will broadcast its presence on the network, allowing it to be discovered by koan with the koan --server=DISCOVER parameter. =head2 IMPORTING TREES Cobbler can auto-add distributions and profiles from remote sources, whether this is a filesystem path or an rsync mirror. This can save a lot of time when setting up a new provisioning environment. Import is a feature that many users will want to take advantage of, and is very simple to use. - + After an import is run, cobbler will try to detect the distribution type and automatically assign kickstarts. By default, it will provision the system by erasing the hard drive, setting up eth0 for dhcp, and using a default password of "cobbler". If this is undesirable, edit the kickstart files in /etc/cobbler to do something else or change the kickstart setting after cobbler creates the profile. Mirrored content is saved automatically in /var/www/cobbler/ks_mirror. @@ -596,10 +596,10 @@ Should you want to force the usage of a specific cobbler kickstart template for =head2 DEFAULT PXE BOOT BEHAVIOR -What happens when PXE booting a system when cobbler has no record of the system being booted? +What happens when PXE booting a system and cobbler has no record of the system being booted? By default, cobbler will configure PXE to boot to the contents of /etc/cobbler/default.pxe, which (if unmodified) will just fall through to the local boot process. Administrators can modify this file if they -like to change that behavior. +want to change that behavior. An easy way to specify a default cobbler profile to PXE boot is to create a system named "default". This will cause /etc/cobbler/default.pxe to be ignored. To restore the previous behavior do a "cobbler system remove" on the "default" system. @@ -629,7 +629,7 @@ B When updating repos by name, a repo will be updated even if it is set to be not updated during a regular reposync operation (ex: cobbler repo edit --name=reponame1 --keep-updated=0). -Note that if a cobbler import provides enough information to use the boot server as a yum mirror for core packages, cobbler can set up kickstarts to use the cobbler server as a mirror instead of the outside world. If this feature is not desirable, it can be turned on by setting yum_post_install_mirror to 0 in /var/lib/cobbler/settings (and rerunning "cobbler sync"). You should disable this feature if machines are provisioned on a different VLAN/network than production, or if you are provisioning laptops that will want to acquire updates on multiple networks. +Note that if a cobbler import provides enough information to use the boot server as a yum mirror for core packages, cobbler can set up kickstarts to use the cobbler server as a mirror instead of the outside world. If this feature is not desirable, it can be turned off by setting yum_post_install_mirror to 0 in /var/lib/cobbler/settings (and rerunning "cobbler sync"). You should disable this feature if machines are provisioned on a different VLAN/network than production, or if you are provisioning laptops that will want to acquire updates on multiple networks. =head2 PXE BOOT LOOP PREVENTION -- 1.5.3.7