Project

General

Profile

Installation instructions » History » Version 28

Ohad Levy, 05/30/2010 09:24 AM

1 8 Ohad Levy
{{toc}}
2 1 Ohad Levy
3 8 Ohad Levy
h1. Requirements
4 8 Ohad Levy
5 1 Ohad Levy
before you start, make sure you have:
6 1 Ohad Levy
7 1 Ohad Levy
* Puppet >= 0.24-4
8 1 Ohad Levy
* rake >= 0.84 
9 8 Ohad Levy
* rubygems
10 17 Ohad Levy
* rack = 1.0.1
11 8 Ohad Levy
* ruby-sqlite3 (libsqlite3-ruby) if you are going to use sqlite as your database
12 8 Ohad Levy
* git (if installing from source )
13 1 Ohad Levy
14 27 Ohad Levy
The installation has been successfully tested on RHE5 and Ubuntu 8.04 -  10.04,  for older operating systems you might need additional packages (e.g. sqlite)
15 1 Ohad Levy
16 8 Ohad Levy
h1. Download
17 1 Ohad Levy
18 13 Ohad Levy
h2. Puppet Module ready to use
19 13 Ohad Levy
20 13 Ohad Levy
You may try out the puppet Foreman module, this should take care for most of the basic setup.
21 13 Ohad Levy
22 25 Ohad Levy
The module could be downloaded via: http://github.com/ohadlevy/puppet-foreman/tarball/master
23 1 Ohad Levy
24 21 Ohad Levy
you may use puppet (if you don't want to add it as a module to your puppetmaster) in the following way:
25 1 Ohad Levy
26 25 Ohad Levy
if you are using RHE5, EPEL repo must be enabled http://fedoraproject.org/wiki/EPEL
27 1 Ohad Levy
28 25 Ohad Levy
If you are using puppet store configs please set $using_store_configs to true in foreman/manifests/init.pp.
29 25 Ohad Levy
If you want this module to configure passenger as well, set $using_passenger to true in foreman/manifests/init.pp
30 21 Ohad Levy
31 25 Ohad Levy
usage:
32 25 Ohad Levy
33 21 Ohad Levy
<pre>
34 25 Ohad Levy
echo include foreman | puppet  --verbose --modulepath /path_to/tarball
35 21 Ohad Levy
</pre>
36 21 Ohad Levy
37 13 Ohad Levy
*Its recommend to review the module prior usage.*
38 13 Ohad Levy
39 23 Ohad Levy
h2. RPM
40 23 Ohad Levy
41 23 Ohad Levy
We maintain a repository for RHE5 (and clones) - you may add it via:
42 23 Ohad Levy
43 23 Ohad Levy
h3. Puppet 
44 23 Ohad Levy
45 23 Ohad Levy
<pre>
46 23 Ohad Levy
yumrepo { 'foreman':
47 23 Ohad Levy
    descr => 'Foreman Repo',
48 23 Ohad Levy
    baseurl => 'http://theforeman.org/repo',
49 23 Ohad Levy
    gpgcheck => '0',
50 23 Ohad Levy
    enabled => '1'
51 23 Ohad Levy
}
52 23 Ohad Levy
</pre>
53 23 Ohad Levy
54 23 Ohad Levy
h3. Quick and dirty
55 23 Ohad Levy
56 23 Ohad Levy
<pre>
57 23 Ohad Levy
cat > /etc/yum.repos.d/foreman.repo << EOF
58 23 Ohad Levy
[foreman]
59 23 Ohad Levy
name=Foreman Repo
60 23 Ohad Levy
baseurl=http://theforeman.org/repo
61 23 Ohad Levy
gpgcheck=0
62 1 Ohad Levy
enabled=1
63 23 Ohad Levy
EOF
64 23 Ohad Levy
</pre>
65 23 Ohad Levy
66 23 Ohad Levy
<pre>
67 23 Ohad Levy
yum install foreman
68 23 Ohad Levy
</pre>
69 23 Ohad Levy
70 25 Ohad Levy
Additional rpms might be required from epel repo's
71 23 Ohad Levy
72 23 Ohad Levy
if you just want to get the rpms:
73 23 Ohad Levy
74 24 Ohad Levy
http://theforeman.org/repo/el5/noarch/foreman-0.1.4-3.noarch.rpm
75 23 Ohad Levy
http://theforeman.org/repo/el5/noarch/rubygem-rack-1.0.1-1.noarch.rpm
76 23 Ohad Levy
and 
77 23 Ohad Levy
http://theforeman.org/repo/el5/SRPM/foreman-0.1.4-2.src.rpm
78 23 Ohad Levy
79 8 Ohad Levy
h2. Latest stable release
80 7 Ohad Levy
81 1 Ohad Levy
Latest stable version can be found "here":http://theforeman.org/attachments/download/60/foreman-0.1-4.tar.bz2
82 19 Ohad Levy
83 8 Ohad Levy
h2. Latest source code
84 7 Ohad Levy
85 7 Ohad Levy
You can get the latest source code of Foreman from the git repository hosted at github.
86 7 Ohad Levy
This is the preferred way to get Foreman if you want to benefit from the latest improvements. By using the git repository you can also upgrade more easily.
87 7 Ohad Levy
88 1 Ohad Levy
to get latest "stable" version do:
89 1 Ohad Levy
90 4 Ohad Levy
<pre><code>git clone git://github.com/ohadlevy/foreman.git foreman
91 4 Ohad Levy
cd foreman
92 1 Ohad Levy
git submodule init
93 1 Ohad Levy
git submodule update
94 1 Ohad Levy
</code></pre>
95 1 Ohad Levy
96 1 Ohad Levy
* if you are behind a proxy or firewall and dont have access to github using the git protocol, use http protocol instead (e.g.)
97 5 Rama Krishna
<pre>
98 5 Rama Krishna
git clone http://github.com/ohadlevy/foreman.git foreman
99 5 Rama Krishna
cd foreman
100 1 Ohad Levy
sed -i 's/git:\/\//http:\/\//g' .gitmodules
101 1 Ohad Levy
git submodule init
102 5 Rama Krishna
git submodule update
103 5 Rama Krishna
</pre>
104 5 Rama Krishna
105 12 Ohad Levy
h3. Daily snapshot
106 12 Ohad Levy
107 12 Ohad Levy
You can also fetch the latest daily snapshot of the development version at:
108 28 Ohad Levy
http://theforeman.org/foreman-nightly.tar.bz2
109 12 Ohad Levy
110 3 Ohad Levy
111 8 Ohad Levy
h1. Initial setup
112 1 Ohad Levy
113 8 Ohad Levy
h2. Database
114 6 Ohad Levy
115 6 Ohad Levy
Foreman uses a database, this database can be shared with Puppet store-configs (they are compatible, as Foreman extends the puppet database schema).
116 14 Ohad Levy
By default, SQLite is used, if you want to use other database (e.g. [[FAQ#I-want-to-use-MySQL|MySQL]]) please modify the configuration file under +config/database.yml+.
117 1 Ohad Levy
118 6 Ohad Levy
If you want to share the database with Puppets (storeconfig), just modify +config/database.yml+ to point to the same database configuration as puppet is.
119 6 Ohad Levy
120 1 Ohad Levy
In both cases, please use the *production* settings.
121 6 Ohad Levy
122 1 Ohad Levy
to initialize the database schema type:
123 11 Ohad Levy
<pre>
124 11 Ohad Levy
RAILS_ENV=production rake db:migrate
125 11 Ohad Levy
</pre>
126 6 Ohad Levy
127 8 Ohad Levy
h2. Import Data from Puppet
128 6 Ohad Levy
129 6 Ohad Levy
At this point, you might want to go through the [[FAQ]] to see how can you import your data into Foreman.
130 6 Ohad Levy
131 8 Ohad Levy
h2. Start The Web Server
132 6 Ohad Levy
133 26 Ohad Levy
if you installed via rpm, just start the foreman service, or start the built in web server by typing:
134 1 Ohad Levy
<code>./script/server -e production</code>
135 1 Ohad Levy
136 6 Ohad Levy
and point your browser to http://foreman:3000
137 1 Ohad Levy
138 26 Ohad Levy
If you would like to keep the server running, its recommend to setup passenger or use the RPM.
139 26 Ohad Levy
example usage with passenger can be found here: http://github.com/ohadlevy/puppet-foreman/blob/master/foreman/templates/foreman-vhost.conf.erb
140 1 Ohad Levy
141 8 Ohad Levy
h1. Future Updates
142 1 Ohad Levy
143 9 Ohad Levy
see [[Upgrade instructions]]
144 1 Ohad Levy
145 9 Ohad Levy
h1. Problems?
146 9 Ohad Levy
147 9 Ohad Levy
see [[Troubleshooting]]