~ubuntu-branches/ubuntu/quantal/maas/quantal-security

« back to all changes in this revision

Viewing changes to INSTALL.txt

  • Committer: Package Import Robot
  • Author(s): Seth Arnold
  • Date: 2013-11-01 17:15:48 UTC
  • mfrom: (20.1.2 quantal-proposed)
  • Revision ID: package-import@ubuntu.com-20131101171548-2zswm101618z3kn6
Tags: 1.2+bzr1373+dfsg-0ubuntu1.1
* SECURITY UPDATE: failure to authenticate downloaded content (LP: #1039513)
  - debian/patches/CVE-2013-1058.patch: Authenticate downloaded files with
    GnuPG and MD5SUM files. Thanks to Julian Edwards.
  - CVE-2013-1058
* SECURITY UPDATE: configuration options may be loaded from current working
  directory (LP: #1158425)
  - debian/patches/CVE-2013-1057-1-2.patch: Do not load configuration
    options from the current working directory. Thanks to Julian Edwards.
  - CVE-2013-1057

Show diffs side-by-side

added added

removed removed

Lines of Context:
10
10
 * :ref:`As a fresh install from Ubuntu Server install media. <disc-install>`
11
11
 
12
12
 
13
 
If you are interested in testing the latest development version you can also check out the very latest source and build MAAS yourself. 
 
13
If you are interested in testing the latest development version you can 
 
14
also check out the very latest source and build MAAS yourself. 
14
15
 
15
16
 
16
17
.. _pkg-install:
18
19
Installing MAAS from the archive
19
20
--------------------------------
20
21
 
21
 
Installing MAAS from packages is thankfully straightforward. There are actually several packages that go into making up a working MAAS install, but for convenience, many of these have been gathered into a virtual package called 'maas' which will install the necessary components for a 'seed cloud', that is a single server that will directly control a group of nodes. The main packages are:
 
22
Installing MAAS from packages is thankfully straightforward. There are
 
23
actually several packages that go into making up a working MAAS install,
 
24
but for convenience, many of these have been gathered into a virtual package
 
25
called 'maas' which will install the necessary components for a 'seed cloud',
 
26
that is a single server that will directly control a group of nodes. The main packages are:
22
27
 
23
 
 * ``maas`` - seed cloud setup, which includes both the region controller and the cluster controller below.
 
28
 * ``maas`` - seed cloud setup, which includes both the region controller and
 
29
the cluster controller below.
24
30
 * ``maas-region-controller`` - includes the web UI, API and database.
25
31
 * ``maas-cluster-controller`` - controls a group ("cluster") of nodes including DHCP management.
26
32
 * ``maas-dhcp``/``maas-dns`` - required when managing dhcp/dns.
27
33
 
28
 
If you need to separate these services or want to deploy an additional cluster controller, you should install the corresponding packages individually (see :ref:`the description of a typical setup <setup>` for more background on how a typical hardware setup might be arranged).
 
34
If you need to separate these services or want to deploy an additional cluster
 
35
controller, you should install the corresponding packages individually
 
36
(see :ref:`the description of a typical setup <setup>` for more background
 
37
on how a typical hardware setup might be arranged).
29
38
 
30
 
There are two suggested additional packages 'maas-dhcp' and 'maas-dns'. These set up MAAS-controlled DHCP and DNS services which greatly simplify deployment if you are running a typical setup where the MAAS controller can run the network (Note: These **must** be installed if you later set the options in the web interface to have MAAS manage DHCP/DNS). If you need to integrate your MAAS setup under an existing DHCP setup, see :ref:`manual-dhcp`
 
39
There are two suggested additional packages 'maas-dhcp' and 'maas-dns'. These
 
40
set up MAAS-controlled DHCP and DNS services which greatly simplify deployment
 
41
if you are running a typical setup where the MAAS controller can run the
 
42
network (Note: These **must** be installed if you later set the options in
 
43
the web interface to have MAAS manage DHCP/DNS). If you need to integrate your
 
44
MAAS setup under an existing DHCP setup, see :ref:`manual-dhcp`
31
45
 
32
46
 
33
47
Install packages
37
51
 
38
52
  $ sudo apt-get install maas maas-dhcp maas-dns
39
53
 
40
 
You will see a list of packages and a confirmation message to proceed. The exact list will obviously depend on what you already have installed on your server, but expect to add about 200MB of files.
 
54
You will see a list of packages and a confirmation message to proceed. The
 
55
exact list will obviously depend on what you already have installed on your
 
56
server, but expect to add about 200MB of files.
41
57
 
42
 
The configuration for the MAAS controller will automatically run and pop up this config screen:
 
58
The configuration for the MAAS controller will automatically run and pop up
 
59
this config screen:
43
60
 
44
61
.. image:: media/install_cluster-config.*
45
62
 
46
 
Here you will need to enter the hostname for where the region controller can be contacted. In many scenarios, you may be running the region controller (i.e. the web and API interface) from a different network address, for example where a server has several network interfaces. 
 
63
Here you will need to enter the hostname for where the region controller can
 
64
be contacted. In many scenarios, you may be running the region controller
 
65
(i.e. the web and API interface) from a different network address, for example
 
66
where a server has several network interfaces. 
47
67
 
48
 
Once the configuration scripts have run you should see this message telling you that the system is ready to use:
 
68
Once the configuration scripts have run you should see this message telling
 
69
you that the system is ready to use:
49
70
 
50
71
.. image:: media/install_controller-config.*
51
72
 
52
 
The web server is started last, so you have to accept this message before the service is run and you can access the Web interface. Then there are just a few more setup steps :ref:`post_install`
 
73
The web server is started last, so you have to accept this message before the service is run and you can access the Web interface. Then there are just a few
 
74
more setup steps :ref:`post_install`
53
75
 
54
76
.. _disc-install:
55
77
 
56
78
Installing MAAS from Ubuntu Server boot media
57
79
---------------------------------------------
58
80
 
59
 
If you are installing MAAS as part of a fresh install it is easiest to choose the "Multiple Server install with MAAS" option from the installer and have pretty much everything set up for you.
60
 
Boot from the Ubuntu Server media and you will be greeted with the usual language selection screen:
 
81
If you are installing MAAS as part of a fresh install it is easiest to choose
 
82
the "Multiple Server install with MAAS" option from the installer and have
 
83
pretty much everything set up for you.
 
84
Boot from the Ubuntu Server media and you will be greeted with the usual
 
85
language selection screen:
61
86
 
62
87
.. image:: media/install_01.*
63
88
 
64
 
On the next screen, you will see there is an entry in the menu called "Multiple server install with MAAS". Use the cursor keys to select this and then press Enter.
 
89
On the next screen, you will see there is an entry in the menu called "Multiple
 
90
server install with MAAS". Use the cursor keys to select this and then press
 
91
Enter.
65
92
 
66
93
.. image:: media/install_02.*
67
94
 
68
 
The installer then runs through the usual language and keyboard options. Make your selections using Tab/Cursor keys/Enter to proceed through the install.
 
95
The installer then runs through the usual language and keyboard options. Make
 
96
your selections using Tab/Cursor keys/Enter to proceed through the install.
69
97
The installer will then load various drivers, which may take a moment or two.
70
98
 
71
99
.. image:: media/install_03.*
72
100
 
73
 
The next screen asks for the hostname for this server. Choose something appropriate for your network.
 
101
The next screen asks for the hostname for this server. Choose something
 
102
appropriate for your network.
74
103
 
75
104
 
76
105
.. image:: media/install_04.*
77
106
 
78
 
Finally we get to the MAAS part! Here there are just two options. We want to "Create a new MAAS on this server" so go ahead and choose that one.
 
107
Finally we get to the MAAS part! Here there are just two options. We want to
 
108
"Create a new MAAS on this server" so go ahead and choose that one.
79
109
 
80
110
.. image:: media/install_05.*
81
111
 
82
 
The install now continues as usual. Next you will be prompted to enter a username. This will be the admin user for the actual server that MAAS will be running on (not the same as the MAAS admin user!)
 
112
The install now continues as usual. Next you will be prompted to enter a
 
113
username. This will be the admin user for the actual server that MAAS will
 
114
be running on (not the same as the MAAS admin user!)
83
115
 
84
116
.. image:: media/install_06.*
85
117
 
86
 
As usual you will have the chance to encrypt your home directory. Continue to make selections based on whatever settings suit your usage.
 
118
As usual you will have the chance to encrypt your home directory. Continue
 
119
to make selections based on whatever settings suit your usage.
87
120
 
88
121
.. image:: media/install_07.*
89
122
 
90
 
After making selections and partitioning storage, the system software will start to be installed. This part should only take a few minutes.
 
123
After making selections and partitioning storage, the system software will 
 
124
start to be installed. This part should only take a few minutes.
91
125
 
92
126
.. image:: media/install_09.*
93
127
 
94
 
Various packages will now be configured, including the package manager and update manager. It is important to set these up appropriately so you will receive timely updates of the MAAS server software, as well as other essential services that may run on this server.
 
128
Various packages will now be configured, including the package manager and 
 
129
update manager. It is important to set these up appropriately so you will
 
130
receive timely updates of the MAAS server software, as well as other essential services that may run on this server.
95
131
 
96
132
.. image:: media/install_10.*
97
133
 
98
 
The configuration for MAAS will ask you to configure the host address of the server. This should be the IP address you will use to connect to the server (you may have additional interfaces e.g. to run node subnets)
 
134
The configuration for MAAS will ask you to configure the host address of the
 
135
server. This should be the IP address you will use to connect to the server 
 
136
(you may have additional interfaces e.g. to run node subnets)
99
137
 
100
138
.. image:: media/install_cluster-config.*
101
139
 
102
 
The next screen will confirm the web address that will be used to the web interface.
 
140
The next screen will confirm the web address that will be used to the web
 
141
interface.
103
142
 
104
143
.. image:: media/install_controller-config.*
105
144
 
106
 
After configuring any other packages the installer will finally come to and end. At this point you should eject the boot media.
 
145
After configuring any other packages the installer will finally come to and
 
146
end. At this point you should eject the boot media.
107
147
 
108
148
.. image:: media/install_14.*
109
149
 
110
 
After restarting, you should be able to login to the new server with the information you supplied during the install. The MAAS software will run automatically.
 
150
After restarting, you should be able to login to the new server with the
 
151
information you supplied during the install. The MAAS software will run automatically.
111
152
 
112
153
 
113
154
.. image:: media/install_15.*
123
164
 
124
165
Post-Install tasks
125
166
==================
126
 
If you now use a web browser to connect to the region controller, you should see that MAAS is running, but there will also be some errors on the screen:
 
167
If you now use a web browser to connect to the region controller, you should
 
168
see that MAAS is running, but there will also be some errors on the screen:
127
169
 
128
170
.. image:: media/install_web-init.*
129
171
 
130
 
The on screen messages will tell you that there are no boot images present, and that you can't login because there is no admin user. 
 
172
The on screen messages will tell you that there are no boot images present, 
 
173
and that you can't login because there is no admin user. 
131
174
 
132
175
Create a superuser account
133
176
--------------------------
137
180
 
138
181
  $ sudo maas createsuperuser
139
182
 
140
 
Follow the prompts to create the account which you will need to login to the web interface. Unless you have a special need, it is best to accept the default login name of `root`, as it is rather annoying if you forget the username (although you can simply run this command again to create a new superuser).
 
183
Follow the prompts to create the account which you will need to 
 
184
login to the web interface. Unless you have a special need, it is best to 
 
185
accept the default login name of `root`, as it is rather annoying if you 
 
186
forget the username (although you can simply run this command again to create
 
187
a new superuser).
141
188
 
142
189
 
143
190
Import the boot images
158
205
Login to the server
159
206
-------------------
160
207
 
161
 
To check that everything is working properly, you should try and login to the server now. Both the error messages should have gone (it can take a few minutes for the boot image files to register) and you can see that there are currently 0 nodes attached to this controller.
 
208
To check that everything is working properly, you should try and login to 
 
209
the server now. Both the error messages should have gone (it can take a 
 
210
few minutes for the boot image files to register) and you can see that 
 
211
there are currently 0 nodes attached to this controller.
162
212
 
163
213
.. image:: media/install-login.*
164
214
 
166
216
Configure DHCP
167
217
--------------
168
218
 
169
 
If you are using MAAS to control DHCP, you need to set this via the web interface.
170
 
However, if you are manually configuring a DHCP server, you should take a look at :ref:`manual-dhcp`
 
219
If you are using MAAS to control DHCP, you need to configure this using the 
 
220
commandline interface, first by :ref:`logging on to the server API <api-key>` 
 
221
and then :ref:`setting up the interface <cli-dhcp>` 
 
222
However, if you are manually configuring a DHCP server, you should take a 
 
223
look at :ref:`manual-dhcp`
171
224
 
172
 
Once everything is set up and running, you are ready to :doc:`start enlisting nodes <nodes>`
 
225
Once everything is set up and running, you are ready to :doc:`start enlisting
 
226
nodes <nodes>`