summaryrefslogtreecommitdiffstats
path: root/genome-docs/genome-docs-1.0.0/en-US/QuickStart.xml
blob: 7774ccb8113b6e941351a4fb641f6639d30dd5ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
<?xml version='1.0'?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
]>

<chapter id="genome-QuickStart">
	<title>Quick Start</title>
    <para>
        This quick start will you get up and running with the &PRODUCT;
        framework.  However, this is not intended to provide comprehensive
        coverage of the &PRODUCT; framework.  It is important to take the 
        time to read the rest of this document in order to have a full
        understanding of the &PRODUCT; framework.
    </para>
    <para>
        Additionally, the <link linkend="genome-Cookbook">cookbook</link> 
        section contains a number of helpful examples.
    </para>

    <section id="quickstart-Understanding">
        <title>Understanding the Framework</title>
        <para>
            It is very important that you have a full understanding of the &PRODUCT; framework.
            Without that understanding, it will be hard to understand system requirements of
            the various portions of the framework.  After completing this quick start, please 
            take the time to read through the rest of this document.
        </para>
        <para>
            The &PRODUCT; framework consists of three parts:
            <itemizedlist>
                <listitem>
                    <simpara><glossterm linkend="glossary-genomeappliance">Genome Appliance</glossterm></simpara>
                </listitem>
                <listitem>
                    <simpara><glossterm linkend="glossary-cloudappliance">Cloud Appliance</glossterm></simpara>
                </listitem>
                <listitem>
                    <simpara>An arbitrary number of <glossterm linkend="glossary-genomeappliance">Cloud Members</glossterm></simpara>
                </listitem>
            </itemizedlist>
        </para>
        <important>
            <para>
		When using the default setup with Fedora, you need two machines and one will need to have
                hardware virtualization support.  Check the following link to see if your machine meets the
                requirements: <ulink url="http://kvm.qumranet.com/kvmwiki/FAQ#head-a78f5f083749cb9c2e57d7d4efaf2ecf25b9db60">KVM Information</ulink>
                Also check the system requirements for the <link linkend="genome-appliance-systemreqs">Genome Appliance</link>
                and the <link linkend="genome-cloud-appliance-systemreqs">Cloud Appliance</link> before beginning the quick start.
		If you don't have a machine that supports hardware virtualization, you won't be able to
                use Fedora for your <link linkend="genome-cloud-appliance-systemreqs">Cloud Appliance</link>
                but you can still use any distribution that supports Xen (e.g. Red Hat Enterprise Linux).
            </para>
        </important>
    </section>
    <section id="quickstart-Prereqs">
        <title>Prerequisites</title>
        <itemizedlist>
            <listitem>
                <simpara>
                    Download and burn the 
                    <ulink url="http://ftp.redhat.com/pub/redhat/genome/isos/Genome-Fedora-8-i386-CD.iso">Genome Appliance boot CD</ulink>
                </simpara>
            </listitem>
            <listitem>
                <simpara>
                    Download and burn the 
                    <ulink url="http://ftp.redhat.com/pub/redhat/genome/isos/Cloud-Fedora-8-i386-CD.iso">Cloud Appliance boot CD</ulink>
                </simpara>
            </listitem>
        </itemizedlist>
    </section>
    <section id="quickstart-Genome">
        <title>Setting Up the Genome Appliance</title>
        <para>
            Choose a server to be the Genome Appliance and boot with the Genome Appliance CD. 
            At the boot menu, choose the default option (Install from Kickstart).
            Booting the CD will kickstart the server with the appropriate Genome Appliance 
            operating system.  After the kickstart finishes, the genome-firstboot service 
            will start and initialize the server as a Genome Appliance.
        </para>
        <important>
            <simpara>
                The kickstart reboots the server when it completes.  Be sure to remove the 
                CD from the drive when the kickstart finishes to ensure it does not try to 
                run the kickstart after rebooting.
            </simpara>
        </important>
    </section>
    <section id="quickstart-Cloud">
        <title>Setting Up the Cloud Appliance</title>
        <para>
            Choose a server to be the Cloud Appliance and boot with the Cloud Appliance CD.
            Booting the CD will kickstart the server with the appropriate Cloud Appliance
            operating system.
        </para>
        <para>
            This server now serves as both the Cloud Appliance and the first
            <glossterm linkend="glossary-cloudmember">cloud member</glossterm>.  You can always add 
            additional cloud members.
        </para>
        <important>
            <simpara>
                The kickstart reboots the server when it completes.  Be sure to remove the 
                CD from the drive when the kickstart finishes to ensure it does not try to 
                run the kickstart after rebooting.
            </simpara>
        </important>
    </section>
    <section id="quickstart-FirstDistro">
        <title>Setting Up the First Distro</title>
        <para>
            While there are several ways to import a distro into cobbler, we highly recommend downloading
            and mounting an ISO image and importing it.  Run these commands on the &PRODUCT; machine to 
            import the Fedora distribution.
        </para>
        <screen>
mkdir /mnt/Fedora-9-i386
wget -O /tmp/Fedora-9-i386-DVD.iso http://download.fedoraproject.org/pub/fedora/linux/releases/9/Fedora/i386/iso/Fedora-9-i386-DVD.iso
mount -o loop /tmp/Fedora-9-i386-DVD.iso /mnt/Fedora-9-i386
cobbler import --mirror=/mnt/Fedora-9-i386 --name=Fedora-9-i386
        </screen>
    </section>
    <section id="quickstart-FirstGuest">
        <title>Setting Up the First Guest</title>
        <para>
            Use <application><link linkend="genome-GenomeBootstrap">genome-bootstrap</link></application> 
            to setup the first guest machine.
        </para>
        <screen linenumbering="numbered" startinglinenumber="1">
$ genome-bootstrap

Your genome repo server is the system that serves as the 
puppet master, git server, and cobbler server all in one.
Enter your Genome repo fully qualified domain name (fqdn):  genome.example.org 

Your cloud master is the server that determines where the
machine you're trying to create will be provisioned.  Typically
cloud masters control several machines in a cloud.  However,
cloud masters can be configured to simply manage their own disk space.
Enter your cloud master fqdn:  cloud.example.org
Enter your email address for cloud notification:  johndoe@example.org

Your system prefix is added to your machine name to help identify
it as your own.  It must be a single word and should be short (e.g. username).
Enter your system prefix:  johndoe

Now, you can select your machine type.
To see a description of these machine types visit: http://GENOME-APPLIANCE/genome/machine_types.html
1. django-example
Select your machine type: 1

Your cobbler profile determines the OS, the disk space, and
the amount of memory that should be allocated to the system
that you are provisioning.
1. LargeGenomeGuest-Fedora-9-i386
2. NormalGenomeGuest-Fedora-9-i386
Select your cobbler profile (This determines the OS):  2

Your system is now being provisioned
Trying to determine the ip address.
We'll try and maximum of 10 times.
Polling for cobbler status...
Retrying in 5 seconds
Polling for cobbler status...
Retrying in 5 seconds
Polling for cobbler status...
Retrying in 5 seconds
Polling for cobbler status...
Retrying in 5 seconds
Polling for cobbler status...
Retrying in 5 seconds
Polling for cobbler status...
Retrying in 5 seconds
Polling for cobbler status...
Retrying in 5 seconds
Your new system is being provisioned on cloud-7.example.org.
The IP address of the new system is 1.2.3.4.
        </screen>
	<para>
	    Once you have created that machine, you should be able to see it
	    in the cloud at http://CLOUD-APPLIANCE/cloud/status.html.  In a few
	    minutes, your machine should have finished installing and will be
	    ready for use.
	</para>
	<para>
	    At this point, you are ready to move onto some more interesting
	    scenarios like adding more &PRODUCT; Appliances for the various
	    teams in your organization or creating custom machine types for
	    your own use.  You can find most of these examples in the Cookbook,
	    like <link linkend="genome-AddMachineType">creating your own
	    machine type</link>.
	</para>
    </section>
</chapter>