Merge lp:~allenap/maas/docs-and-man-bug-975454 into lp:maas

Proposed by Gavin Panella
Status: Merged
Approved by: Gavin Panella
Approved revision: 1361
Merged at revision: 1363
Proposed branch: lp:~allenap/maas/docs-and-man-bug-975454
Merge into: lp:maas
Prerequisite: lp:~allenap/maas/docs-and-man-tidy
Diff against target: 98 lines (+37/-18)
1 file modified
HACKING.txt (+37/-18)
To merge this branch: bzr merge lp:~allenap/maas/docs-and-man-bug-975454
Reviewer Review Type Date Requested Status
Julian Edwards (community) Approve
Review via email: mp+135259@code.launchpad.net

Commit message

Remove references to maas-import-pxe-files from HACKING.txt.

To post a comment you must log in.
Revision history for this message
Julian Edwards (julian-edwards) wrote :

65 +Start downloading PXE boot resources::
66 +
67 + $ bin/maascli dev node-groups import-boot-images
68 +
69 +This may download dozens or hundreds of megabytes, so depending on your
70 +network connection it may take a while.

This needs updating to mention exactly how this works. ie., it kicks off jobs on all the cluster controllers. Therefore it also needs to mention that it's a good idea to set up a caching proxy in the UI (and say how) so that all the controllers don't duplicate the download.

review: Needs Fixing
Revision history for this message
Gavin Panella (allenap) wrote :

> This needs updating to mention exactly how this works. ie., it kicks off jobs
> on all the cluster controllers. Therefore it also needs to mention that it's
> a good idea to set up a caching proxy in the UI (and say how) so that all the
> controllers don't duplicate the download.

Good point. I've updated the instructions.

Revision history for this message
Julian Edwards (julian-edwards) wrote :

Tippus Toppus!

review: Approve
Revision history for this message
MAAS Lander (maas-lander) wrote :

No proposals found for merge of lp:~allenap/maas/docs-and-man-tidy into lp:maas.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'HACKING.txt'
2--- HACKING.txt 2012-10-02 17:24:06 +0000
3+++ HACKING.txt 2012-11-21 12:20:53 +0000
4@@ -178,10 +178,6 @@
5
6 $ make sampledata
7
8-Install the provisioning server::
9-
10- $ sudo apt-get install maas-provision
11-
12 By default, the snippet ``maas_proxy`` includes a definition for an http
13 proxy running on port 8000 on the same host as the MAAS server. This
14 means you can *either* install ``squid-deb-proxy``::
15@@ -195,16 +191,6 @@
16
17 $ sudo tee -a /etc/tgt/targets.conf < contrib/tgt.conf
18
19-Now run ``maas-import-pxe-files`` to download current Ubuntu releases for
20-installing nodes::
21-
22- $ sudo http_proxy=$http_proxy PATH=$PATH:$PWD/bin:$PWD/scripts \
23- MAAS_PROVISIONING_SETTINGS=$PWD/etc/pserv.yaml \
24- ./scripts/maas-import-pxe-files
25-
26-This may download dozens or hundreds of megabytes, so depending on your
27-network connection it may take a while.
28-
29 The http_proxy variable is only needed if you're downloading through a
30 proxy; "sudo" wouldn't pass it on to the script without the assignment.
31 Or if you don't have it set but do want to download through a proxy, pass
32@@ -220,12 +206,47 @@
33 simple user using the test account (username: 'test', password: 'test') or the
34 admin account (username: 'admin', password: 'test').
35
36+At this point you may also want to `download PXE boot resources`_.
37+
38+.. _`download PXE boot resources`: `Downloading PXE boot resources`_
39+
40 To shut down the database cluster and clean up all other generated files in
41 your branch::
42
43 $ make distclean
44
45
46+Downloading PXE boot resources
47+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
48+
49+To use PXE booting, each cluster controller needs to download several
50+files relating to PXE booting. This process is automated, but it does
51+not start by default.
52+
53+First create a superuser and start all MAAS services::
54+
55+ $ bin/maas createsuperuser
56+ $ make run
57+
58+Get the superuser's API key on the `account preferences`_ page in web
59+UI, and use it to log into MAAS at the command-line::
60+
61+ $ bin/maascli login dev http://localhost:5240
62+
63+.. _`account preferences`: http://localhost:5240/account/prefs/
64+
65+Start downloading PXE boot resources::
66+
67+ $ bin/maascli dev node-groups import-boot-images
68+
69+This sends jobs to each cluster controller, asking each to download
70+the boot resources they require. This may download dozens or hundreds
71+of megabytes, so it may take a while. To save bandwidth, set an HTTP
72+proxy beforehand::
73+
74+ $ bin/maascli dev maas set-config name=http_proxy value=http://...
75+
76+
77 Running the built-in TFTP server
78 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
79
80@@ -414,8 +435,7 @@
81 ``src/maasserver/migrations/<auto_number>_description_of_the_change.py``. Don't
82 forget to add that file to the project with::
83
84- $ bzr add \
85- src/maasserver/migrations/<auto_number>_description_of_the_change.py
86+ $ bzr add src/maasserver/migrations/<auto_number>_description_of_the_change.py
87
88 To apply that migration, run::
89
90@@ -439,8 +459,7 @@
91 methods where data should be actually migrated. Again, don't forget to
92 add that file to the project::
93
94- $ bzr add \
95- src/maasserver/migrations/<auto_number>_description_of_the_change.py
96+ $ bzr add src/maasserver/migrations/<auto_number>_description_of_the_change.py
97
98 Once the methods have been written, apply that migration with::
99