You are here

New Handbook Structure

Primary tabs

Basic outline

  • Intro
  • Get it
  • Install it
  • Use it
  • Discuss it
  • Extend it
  • FAQ's
  • Tips and Tricks

OI Handbook Structure (or questions a basic handbook should be able to answer)

Helpful resources for writing some of these sections:

The New OpenIndiana Handbook needs to answer at least the following:

What questions would people new to Openindiana have?

  • Where did it come from?
  • Why should people consider it?
  • What makes it different than say BSD or Linux?
  • What makes it more interesting than something else?

What would people really need to know to "get started".

  • Where can the software be obtained?
  • How can it be burned to a DVD or onto a USB drive?
  • What is the process for installing it?
  • What are the pre-installation caveats and considerations?
    • System partitioning, Gparted, etc.
    • Device Driver utility - (also how to manually install missing drivers - and where to find them if they are available)
      • Network install drivers: pkgrecv -s -d bash.p5a -a bash && sudo pkg install -nv -g bash.p5a bash
      • Local install drivers: pkg install -g name.p5a fmri
    • How to disable drivers at boot time (this might help fix the kernel panic we see when trying to boot OI inside KVM)
    • Physical or virtual?
    • 1 GB of memory for each TB of ZFS storage.
  • What are the post-installation caveats and considerations?
  • Where to find support and help
    • Talk about IRC, mailing list, how to use MAN pages, mlocate, apropos, etc.

What kinds of things can be done with a system once installed?

  • How can the desktop be modified?
    • Gnome walkthrough
    • Compiz
  • How does one keep the system updated?
    • IPS and BEADMIN walkthroughs
  • How does one perform system backups?
    • Time Machine, ZFS exports, etc.
  • How does one add additional users?
    • Basic system administration
    • Basic UNIX commands
  • How does one mount or import additional disks?
    • talk about the ZFS import command.
    • Need a walkthrough of mounting options for other filesystems...NTFS, FAT, UFS, etc.

What other things should someone learn to best utilize OI?

  • Getting OI to play Multimedia
    • How to get OI to play a DVD
    • How to get flash player installed and working.
    • How to get VLC installed and working.
    • Codecs, etc.
    • How to use the hidden gstreamer-properties configuration utility.
  • Graphics workstation
  • Desktop Publishing system, Etc.
  • Virtualization Storage Server
    • Poor man's standalone ISCSI SAN linked to a 2nd machine running VMware ESXI (2 computers required)
      • A variation of this would be to run OI as an ESXI guest with local storage hardware "passed through" to OI and then subsequently share ZFS volumes via ISCSI with the ESXI host itself. In this configuration, OI effectively becomes a SAN (1 computer required)
  • Virtualization Server
    • Qemu-KVM walkthrough (Does hipster even have this package?)
      • Yes, KVM is the package name
    • Using VIRSH, Virt-manager, etc. (Does hipster [or any illumos distro for that matter] even have virsh or Virt-manager)
      • If not, what tools are used to manage the Joyant KVM port (VMADM perhaps?)
    • Virtualbox walkthrough - there a package available?

  • Zones - running web stuff in zone, development, etc.
    • Need to mention some of the changes to zone sys-unconfig gone. Also sysding replaced syscfg, so you now have to have DNS, root password, etc. all configured inside the zone before being able to logon using zlogin -C <zonename>, otherwise have to do zlogin <zonename>. So a fair amount of stuff has changed there.

Development related topics

Note: The book titled "Introduction to Operating Systems: A Hands-On Approach Using the OpenSolaris Project" may be a good resource for helping to complete this part of the handbook.

  • How can OI be used as a development platform?
  • What programming tools, languages, etc., are available?
  • How can OI be used to further the development of OI itself?