441.1.2
by Gavin Panella
Add mode hints to docs, and tidy a bit. |
1 |
.. -*- mode: rst -*- |
2 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
3 |
|
346.2.8
by matthew.revell at canonical
Fixed the install.txt |
4 |
Installing MAAS |
1155.3.1
by Nick Veitch
added new install and config guide to docs |
5 |
=============== |
6 |
||
3354.3.1
by Raphael Badin
Fix documentation to point to the hacking guide (which explain where to get the source and how to build MAAS) and add reference to the development PPAs. |
7 |
There are two main ways to install MAAS: |
1155.3.1
by Nick Veitch
added new install and config guide to docs |
8 |
|
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
9 |
* :ref:`From Ubuntu's package archive on an existing Ubuntu |
10 |
install. <pkg-install>` |
|
11 |
* :ref:`As a fresh install from Ubuntu Server install |
|
12 |
media. <disc-install>` |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
13 |
|
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
14 |
If you are interested in testing the latest development version you |
3354.3.4
by Raphael Badin
Review fixes. |
15 |
can also check out the very latest source and build MAAS — see |
16 |
the :doc:`hacking guide <hacking>` — or use the `Testing PPA`_ or the |
|
17 |
`Daily PPA`_. Note that these PPAs contain development versions of |
|
18 |
MAAS that are potentially unstable, so use with caution. |
|
3354.3.1
by Raphael Badin
Fix documentation to point to the hacking guide (which explain where to get the source and how to build MAAS) and add reference to the development PPAs. |
19 |
|
20 |
.. _Testing PPA: |
|
21 |
https://launchpad.net/~maas-maintainers/+archive/ubuntu/testing |
|
22 |
.. _Daily PPA: |
|
23 |
https://launchpad.net/~maas-maintainers/+archive/ubuntu/dailybuilds |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
24 |
|
25 |
||
26 |
.. _pkg-install: |
|
438.2.1
by Gavin Panella
Remove an accidental paste in the middle of a line. Tidy other things up too. |
27 |
|
346.2.8
by matthew.revell at canonical
Fixed the install.txt |
28 |
Installing MAAS from the archive |
1155.3.1
by Nick Veitch
added new install and config guide to docs |
29 |
-------------------------------- |
30 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
31 |
Installing MAAS from packages is thankfully straightforward. There are |
32 |
actually several packages that go into making up a working MAAS |
|
33 |
install, but for convenience, many of these have been gathered into a |
|
34 |
virtual package called 'maas' which will install the necessary |
|
35 |
components for a 'seed cloud', that is a single server that will |
|
36 |
directly control a group of nodes. The main packages are: |
|
1155.3.2
by Nick Veitch
updating docs |
37 |
|
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
38 |
* ``maas`` - seed cloud setup, which includes both the region |
39 |
controller and the cluster controller below. |
|
1155.3.2
by Nick Veitch
updating docs |
40 |
* ``maas-region-controller`` - includes the web UI, API and database. |
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
41 |
* ``maas-cluster-controller`` - controls a group ("cluster") of nodes |
42 |
including DHCP management. |
|
1155.3.2
by Nick Veitch
updating docs |
43 |
* ``maas-dhcp``/``maas-dns`` - required when managing dhcp/dns. |
44 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
45 |
If you need to separate these services or want to deploy an additional |
46 |
cluster controller, you should install the corresponding packages |
|
47 |
individually (see :ref:`the description of a typical setup <setup>` |
|
48 |
for more background on how a typical hardware setup might be |
|
49 |
arranged). |
|
50 |
||
51 |
There are two suggested additional packages 'maas-dhcp' and |
|
52 |
'maas-dns'. These set up MAAS-controlled DHCP and DNS services which |
|
53 |
greatly simplify deployment if you are running a typical setup where |
|
54 |
the MAAS controller can run the network (Note: These **must** be |
|
55 |
installed if you later set the options in the web interface to have |
|
56 |
MAAS manage DHCP/DNS). If you need to integrate your MAAS setup under |
|
57 |
an existing DHCP setup, see :ref:`manual-dhcp` |
|
58 |
||
1738.1.2
by Julian Edwards
Add note about the cloud archive |
59 |
.. note:: |
60 |
A more up-to-date MAAS is available for the most recent Ubuntu LTS |
|
61 |
release in the Canonical cloud archive. You can activate the archive |
|
62 |
with ``sudo add-apt-repository cloud-archive:tools``. Using packages |
|
63 |
from this archive is recommended as it contains important fixes and |
|
64 |
new features that are not always available in the Ubuntu archive. |
|
65 |
||
1155.3.1
by Nick Veitch
added new install and config guide to docs |
66 |
|
67 |
Install packages |
|
68 |
^^^^^^^^^^^^^^^^ |
|
69 |
||
2007.1.1
by jtv at canonical
Update documentation, especially for boot images and the CLI. Download ephemeral images for 14.04 only, because 1.5 won't enlist/commission with anything less. |
70 |
At the command line, type:: |
1155.3.1
by Nick Veitch
added new install and config guide to docs |
71 |
|
72 |
$ sudo apt-get install maas maas-dhcp maas-dns |
|
73 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
74 |
You will see a list of packages and a confirmation message to |
75 |
proceed. The exact list will obviously depend on what you already have |
|
76 |
installed on your server, but expect to add about 200MB of files. |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
77 |
|
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
78 |
The configuration for the MAAS controller will automatically run and |
79 |
pop up this config screen: |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
80 |
|
81 |
.. image:: media/install_cluster-config.* |
|
82 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
83 |
Here you will need to enter the hostname for where the region |
84 |
controller can be contacted. In many scenarios, you may be running the |
|
85 |
region controller (i.e. the web and API interface) from a different |
|
86 |
network address, for example where a server has several network |
|
87 |
interfaces. |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
88 |
|
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
89 |
Once the configuration scripts have run you should see this message |
90 |
telling you that the system is ready to use: |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
91 |
|
92 |
.. image:: media/install_controller-config.* |
|
93 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
94 |
The web server is started last, so you have to accept this message |
95 |
before the service is run and you can access the Web interface. Then |
|
96 |
there are just a few more setup steps :ref:`post_install` |
|
97 |
||
1155.3.1
by Nick Veitch
added new install and config guide to docs |
98 |
|
99 |
.. _disc-install: |
|
100 |
||
101 |
Installing MAAS from Ubuntu Server boot media |
|
102 |
--------------------------------------------- |
|
103 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
104 |
If you are installing MAAS as part of a fresh install it is easiest to |
105 |
choose the "Multiple Server install with MAAS" option from the |
|
106 |
installer and have pretty much everything set up for you. Boot from |
|
107 |
the Ubuntu Server media and you will be greeted with the usual |
|
108 |
language selection screen: |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
109 |
|
110 |
.. image:: media/install_01.* |
|
111 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
112 |
On the next screen, you will see there is an entry in the menu called |
113 |
"Multiple server install with MAAS". Use the cursor keys to select |
|
114 |
this and then press Enter. |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
115 |
|
116 |
.. image:: media/install_02.* |
|
117 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
118 |
The installer then runs through the usual language and keyboard |
119 |
options. Make your selections using Tab/Cursor keys/Enter to proceed |
|
120 |
through the install. The installer will then load various drivers, |
|
121 |
which may take a moment or two. |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
122 |
|
123 |
.. image:: media/install_03.* |
|
124 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
125 |
The next screen asks for the hostname for this server. Choose |
126 |
something appropriate for your network. |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
127 |
|
128 |
.. image:: media/install_04.* |
|
129 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
130 |
Finally we get to the MAAS part! Here there are just two options. We |
131 |
want to "Create a new MAAS on this server" so go ahead and choose that |
|
132 |
one. |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
133 |
|
134 |
.. image:: media/install_05.* |
|
135 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
136 |
The install now continues as usual. Next you will be prompted to enter |
137 |
a username. This will be the admin user for the actual server that |
|
138 |
MAAS will be running on (not the same as the MAAS admin user!) |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
139 |
|
140 |
.. image:: media/install_06.* |
|
141 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
142 |
As usual you will have the chance to encrypt your home |
143 |
directory. Continue to make selections based on whatever settings suit |
|
144 |
your usage. |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
145 |
|
146 |
.. image:: media/install_07.* |
|
147 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
148 |
After making selections and partitioning storage, the system software |
149 |
will start to be installed. This part should only take a few minutes. |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
150 |
|
151 |
.. image:: media/install_09.* |
|
152 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
153 |
Various packages will now be configured, including the package manager |
154 |
and update manager. It is important to set these up appropriately so |
|
155 |
you will receive timely updates of the MAAS server software, as well |
|
156 |
as other essential services that may run on this server. |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
157 |
|
158 |
.. image:: media/install_10.* |
|
159 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
160 |
The configuration for MAAS will ask you to configure the host address |
161 |
of the server. This should be the IP address you will use to connect |
|
162 |
to the server (you may have additional interfaces e.g. to run node |
|
163 |
subnets) |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
164 |
|
165 |
.. image:: media/install_cluster-config.* |
|
166 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
167 |
The next screen will confirm the web address that will be used to the |
168 |
web interface. |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
169 |
|
170 |
.. image:: media/install_controller-config.* |
|
171 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
172 |
After configuring any other packages the installer will finally come |
173 |
to and end. At this point you should eject the boot media. |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
174 |
|
175 |
.. image:: media/install_14.* |
|
176 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
177 |
After restarting, you should be able to login to the new server with |
178 |
the information you supplied during the install. The MAAS software |
|
179 |
will run automatically. |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
180 |
|
181 |
.. image:: media/install_15.* |
|
182 |
||
1762.2.3
by Julian Edwards
Clarify instructions for installing masa-dhcp and maas-dns |
183 |
**NOTE:** The maas-dhcp and maas-dns packages should be installed by |
184 |
default, but on older releases of MAAS they won't be. If you want to |
|
185 |
have MAAS run DHCP and DNS services, you should install these packages. |
|
186 |
Check whether they are installed with:: |
|
187 |
||
188 |
$ dpkg -l maas-dhcp maas-dns |
|
189 |
||
190 |
If they are missing, then:: |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
191 |
|
192 |
$ sudo apt-get install maas-dhcp maas-dns |
|
193 |
||
1155.3.2
by Nick Veitch
updating docs |
194 |
And then proceed to the post-install setup below. |
1155.3.1
by Nick Veitch
added new install and config guide to docs |
195 |
|
196 |
.. _post_install: |
|
197 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
198 |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
199 |
Post-Install tasks |
200 |
================== |
|
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
201 |
|
2007.1.1
by jtv at canonical
Update documentation, especially for boot images and the CLI. Download ephemeral images for 14.04 only, because 1.5 won't enlist/commission with anything less. |
202 |
Your MAAS is now installed, but there are a few more things to be done. |
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
203 |
If you now use a web browser to connect to the region controller, you |
204 |
should see that MAAS is running, but there will also be some errors on |
|
205 |
the screen: |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
206 |
|
207 |
.. image:: media/install_web-init.* |
|
208 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
209 |
The on screen messages will tell you that there are no boot images |
210 |
present, and that you can't login because there is no admin user. |
|
211 |
||
1155.3.1
by Nick Veitch
added new install and config guide to docs |
212 |
|
213 |
Create a superuser account |
|
214 |
-------------------------- |
|
215 |
||
216 |
Once MAAS is installed, you'll need to create an administrator |
|
438.2.1
by Gavin Panella
Remove an accidental paste in the middle of a line. Tidy other things up too. |
217 |
account:: |
218 |
||
2016.1.1
by Julian Edwards
Fix another maas -> maas-tregion-admin missed substitution |
219 |
$ sudo maas-region-admin createadmin --username=root --email=MYEMAIL@EXAMPLE.COM |
1718.3.4
by jtv at canonical
Update documentation: security problem of --password is now optional. |
220 |
|
221 |
Substitute your own email address for MYEMAIL@EXAMPLE.COM. You may also |
|
222 |
use a different username for your administrator account, but "root" is a |
|
223 |
common convention and easy to remember. The command will prompt for a |
|
224 |
password to assign to the new user. |
|
1718.3.1
by jtv at canonical
Document createadmin as the replacement for createsuperuser. |
225 |
|
226 |
You can run this command again for any further administrator accounts you |
|
227 |
may wish to create, but you need at least one. |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
228 |
|
229 |
||
2007.1.1
by jtv at canonical
Update documentation, especially for boot images and the CLI. Download ephemeral images for 14.04 only, because 1.5 won't enlist/commission with anything less. |
230 |
Log in on the server |
231 |
-------------------- |
|
232 |
||
233 |
Looking at the region controller's main web page again, you should now see |
|
234 |
a login screen. Log in using the user name and password which you have just |
|
235 |
created. |
|
236 |
||
237 |
.. image:: media/install-login.* |
|
238 |
||
239 |
||
1155.3.1
by Nick Veitch
added new install and config guide to docs |
240 |
Import the boot images |
241 |
---------------------- |
|
346.2.8
by matthew.revell at canonical
Fixed the install.txt |
242 |
|
3298.2.1
by Julian Edwards
Add more documentation for images and mirroring |
243 |
Since version 1.7, MAAS stores the boot images in the region controller's |
244 |
database, from where the cluster controllers will synchronise with the region |
|
245 |
and pull images from the region to the cluster's local disk. This process |
|
246 |
is automatic and MAAS will check for and download new Ubuntu images every hour. |
|
2007.1.1
by jtv at canonical
Update documentation, especially for boot images and the CLI. Download ephemeral images for 14.04 only, because 1.5 won't enlist/commission with anything less. |
247 |
|
3298.2.1
by Julian Edwards
Add more documentation for images and mirroring |
248 |
However, on a new installation you'll need to start the import process manually |
249 |
once you have set up your MAAS region controller. There are two ways to start |
|
250 |
the import: through the web user interface, or through the remote API. |
|
2007.1.1
by jtv at canonical
Update documentation, especially for boot images and the CLI. Download ephemeral images for 14.04 only, because 1.5 won't enlist/commission with anything less. |
251 |
|
3287.2.3
by Blake Rouse
Fix code review. |
252 |
To do it in the web user interface, go to the Images tab, check the boxes to |
253 |
say which images you want to import, and click the "Import images" button at |
|
254 |
the bottom of the Ubuntu section. |
|
2007.1.1
by jtv at canonical
Update documentation, especially for boot images and the CLI. Download ephemeral images for 14.04 only, because 1.5 won't enlist/commission with anything less. |
255 |
|
256 |
.. image:: media/import-images.* |
|
257 |
||
258 |
A message will appear to let you know that the import has started, and after a |
|
259 |
while, the warnings about the lack of boot images will disappear. |
|
260 |
||
3287.2.3
by Blake Rouse
Fix code review. |
261 |
It may take a long time, depending on the speed of your Internet connection for |
262 |
import process to complete, as the images are several hundred megabytes. The |
|
263 |
import process will only download images that have changed since last import. |
|
264 |
You can check the progress of the import by hovering over the spinner next to |
|
265 |
each image. |
|
2007.1.1
by jtv at canonical
Update documentation, especially for boot images and the CLI. Download ephemeral images for 14.04 only, because 1.5 won't enlist/commission with anything less. |
266 |
|
267 |
The other way to start the import is through the |
|
268 |
:ref:`region-controller API <region-controller-api>`, which you can invoke most |
|
269 |
conveniently through the :ref:`command-line interface <cli>`. |
|
270 |
||
271 |
To do this, connect to the MAAS API using the "maas" command-line client. |
|
272 |
See :ref:`Logging in <api-key>` for how to get set up with this tool. Then, |
|
1352.2.8
by Gavin Panella
Much more wrapping, tidying, and fixing of warnings and errors in doc generation. |
273 |
run the command:: |
1355.1.1
by Nick Veitch
removed doc references to maas-import-pxe-files |
274 |
|
3287.2.1
by Blake Rouse
Update the documentation for the new boot images WebUI and API. Remove the reference to maas-import-pxe-files on index.rst, as its no longer supported as of 1.7. |
275 |
$ maas my-maas-session boot-resources import |
1355.1.1
by Nick Veitch
removed doc references to maas-import-pxe-files |
276 |
|
2007.1.1
by jtv at canonical
Update documentation, especially for boot images and the CLI. Download ephemeral images for 14.04 only, because 1.5 won't enlist/commission with anything less. |
277 |
(Substitute a different profile name for 'my-maas-session' if you have named |
278 |
yours something else.) This will initiate the download, just as if you had |
|
3287.2.1
by Blake Rouse
Update the documentation for the new boot images WebUI and API. Remove the reference to maas-import-pxe-files on index.rst, as its no longer supported as of 1.7. |
279 |
clicked "Import images" in the web user interface. |
538.3.1
by Jeroen Vermeulen
Doc fix: don't let sudo clobber http_proxy when running maas-import-isos. |
280 |
|
3287.2.1
by Blake Rouse
Update the documentation for the new boot images WebUI and API. Remove the reference to maas-import-pxe-files on index.rst, as its no longer supported as of 1.7. |
281 |
By default, the import is configured to download the most recent LTS release |
282 |
only for the amd64 architecture. Although this should suit most needs, you can |
|
283 |
change the selections on the Images tab, or over the API. Read |
|
2783.1.1
by Newell Jensen
Changing documentation inconsistencies between American English and British English. |
284 |
:doc:`customise boot sources </bootsources>` to see examples on how to do that. |
2377.2.1
by Raphael Badin
Add documentation on how to customize the boot sources. |
285 |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
286 |
|
3298.2.1
by Julian Edwards
Add more documentation for images and mirroring |
287 |
Speeding up repeated image imports by using a local mirror |
288 |
---------------------------------------------------------- |
|
289 |
See :doc:`sstreams-mirror` for information on how to set up a mirror and |
|
290 |
configure MAAS to use it. |
|
291 |
||
292 |
||
1155.3.1
by Nick Veitch
added new install and config guide to docs |
293 |
Configure DHCP |
294 |
-------------- |
|
295 |
||
1608.3.2
by Julian Edwards
Add references to new documentation from existing pages |
296 |
If you want MAAS to control DHCP, you can either: |
297 |
||
1608.3.7
by Julian Edwards
fix x-doc links |
298 |
#. Follow the instructions at :doc:`cluster-configuration` to |
1608.3.3
by Julian Edwards
fix x-doc links |
299 |
use the web UI to set up your cluster controller. |
1608.3.2
by Julian Edwards
Add references to new documentation from existing pages |
300 |
|
1952.1.1
by jtv at canonical
Rename maas-cli to maas in a few more places. |
301 |
#. Use the command line interface `maas` by first |
1608.3.2
by Julian Edwards
Add references to new documentation from existing pages |
302 |
:ref:`logging in to the API <api-key>` and then |
2009.1.2
by jtv at canonical
Fix trailing whitespace in documentation. |
303 |
:ref:`following this procedure <cli-dhcp>` |
1379.2.1
by Nick Veitch
preseed and series docs added |
304 |
|
305 |
If you are manually configuring a DHCP server, you should take a look at |
|
306 |
:ref:`manual-dhcp` |
|
1155.3.1
by Nick Veitch
added new install and config guide to docs |
307 |
|
1555.1.1
by Julian Edwards
Mention 'portfast' in the installation docs. |
308 |
|
309 |
Configure switches on the network |
|
310 |
--------------------------------- |
|
311 |
||
312 |
Some switches use Spanning-Tree Protocol (STP) to negotiate a loop-free path |
|
313 |
through a root bridge. While scanning, it can make each port wait up to 50 |
|
314 |
seconds before data is allowed to be sent on the port. This delay in turn can |
|
315 |
cause problems with some applications/protocols such as PXE, DHCP and DNS, of |
|
316 |
which MAAS makes extensive use. |
|
317 |
||
318 |
To alleviate this problem, you should enable `Portfast`_ for Cisco switches |
|
319 |
or its equivalent on other vendor equipment, which enables the ports to come |
|
320 |
up almost immediately. |
|
321 |
||
322 |
.. _Portfast: |
|
323 |
https://www.symantec.com/business/support/index?page=content&id=HOWTO6019 |
|
324 |
||
325 |
||
1352.2.1
by Gavin Panella
Wrap and tidy INSTALL.txt. |
326 |
Once everything is set up and running, you are ready to :doc:`start |
327 |
enlisting nodes <nodes>` |