Merge lp:~blake-rouse/maas/update-boot-image-doc-1.7 into lp:maas/1.7

[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.

[Blake Rouse (blake-rouse)]

Self-approving since this is just documentation.

review: Approve

[MAAS Lander (maas-lander)]

The attempt to merge lp:~blake-rouse/maas/update-boot-image-doc-1.7 into lp:maas/1.7 failed. Below is the output from the failed tests.

Ign http://security.ubuntu.com trusty-security InRelease
Get:1 http://security.ubuntu.com trusty-security Release.gpg [933 B]
Ign http://nova.clouds.archive.ubuntu.com trusty InRelease
Get:2 http://security.ubuntu.com trusty-security Release [59.7 kB]
Ign http://nova.clouds.archive.ubuntu.com trusty-updates InRelease
Hit http://nova.clouds.archive.ubuntu.com trusty Release.gpg
Get:3 http://nova.clouds.archive.ubuntu.com trusty-updates Release.gpg [933 B]
Hit http://nova.clouds.archive.ubuntu.com trusty Release
Get:4 http://nova.clouds.archive.ubuntu.com trusty-updates Release [59.7 kB]
Get:5 http://security.ubuntu.com trusty-security/main Sources [48.3 kB]
Hit http://nova.clouds.archive.ubuntu.com trusty/main Sources
Get:6 http://security.ubuntu.com trusty-security/universe Sources [11.2 kB]
Get:7 http://security.ubuntu.com trusty-security/main amd64 Packages [149 kB]
Get:8 http://security.ubuntu.com trusty-security/universe amd64 Packages [50.4 kB]
Hit http://nova.clouds.archive.ubuntu.com trusty/universe Sources
Hit http://security.ubuntu.com trusty-security/main Translation-en
Hit http://nova.clouds.archive.ubuntu.com trusty/main amd64 Packages
Hit http://nova.clouds.archive.ubuntu.com trusty/universe amd64 Packages
Hit http://security.ubuntu.com trusty-security/universe Translation-en
Hit http://nova.clouds.archive.ubuntu.com trusty/main Translation-en
Hit http://nova.clouds.archive.ubuntu.com trusty/universe Translation-en
Get:9 http://nova.clouds.archive.ubuntu.com trusty-updates/main Sources [129 kB]
Get:10 http://nova.clouds.archive.ubuntu.com trusty-updates/universe Sources [88.2 kB]
Get:11 http://nova.clouds.archive.ubuntu.com trusty-updates/main amd64 Packages [343 kB]
Get:12 http://nova.clouds.archive.ubuntu.com trusty-updates/universe amd64 Packages [215 kB]
Hit http://nova.clouds.archive.ubuntu.com trusty-updates/main Translation-en
Hit http://nova.clouds.archive.ubuntu.com trusty-updates/universe Translation-en
Ign http://nova.clouds.archive.ubuntu.com trusty/main Translation-en_US
Ign http://nova.clouds.archive.ubuntu.com trusty/universe Translation-en_US
Fetched 1,155 kB in 3s (378 kB/s)
Reading package lists...
sudo DEBIAN_FRONTEND=noninteractive apt-get -y \
     --no-install-recommends install apache2 authbind bind9 bind9utils build-essential bzr-builddeb curl daemontools debhelper dh-apport distro-info dnsutils firefox freeipmi-tools gjs ipython isc-dhcp-common libjs-raphael libjs-yui3-full libjs-yui3-min libpq-dev make pep8 postgresql pyflakes python-amqplib python-bzrlib python-celery python-convoy python-crochet python-cssselect python-curtin python-dev python-distro-info python-django python-django-piston python-django-south python-djorm-ext-pgarray python-docutils python-extras python-fixtures python-flake8 python-formencode python-hivex python-httplib2 python-jinja2 python-jsonschema python-lockfile python-lxml python-mimeparse python-mock python-netaddr python-netifaces python-nose python-oauth python-oops python-oops-amqp python-oops-datedir-repo python-oops-twisted python-oops-w...

=== modified file 'INSTALL.txt'
--- INSTALL.txt	2014-08-22 00:13:24 +0000
+++ INSTALL.txt	2014-10-23 19:36:58 +0000
@@ -232,28 +232,27 @@
 Import the boot images
 ----------------------
 
-MAAS will check for and download new Ubuntu images once a week.  To avoid
-having to wait that long, you'll need to download them manually the first time
-once you have set up your MAAS region and cluster controllers.  Do it again if
-you add a cluster controller later, so that the new cluster controller also has
-the images.
+MAAS will check for and download new Ubuntu images every hour.  On a new
+installation you'll need to start the import process manually once you have
+set up your MAAS region.
 
 There are two ways to start the import: through the web user interface, or
 through the remote API.
 
-To do it in the web user interface, go to the Clusters tab and click the
-"Import boot images" button at the bottom of the list of cluster
-controllers.
+To do it in the web user interface, go to the Images tab, check the boxes to
+say which images you want to import, and click the "Import images" button at
+the bottom of the Ubuntu section.
 
 .. image:: media/import-images.*
 
 A message will appear to let you know that the import has started, and after a
 while, the warnings about the lack of boot images will disappear.
 
-It may take longer for the exact boot images you need to be downloaded.  Give
-the import time to run; do not click the "Import boot images" button again
-until the script has had time to download several hundred megabytes from the
-archive server.
+It may take a long time, depending on the speed of your Internet connection for
+import process to complete, as the images are several hundred megabytes.  The
+import process will only download images that have changed since last import.
+You can check the progress of the import by hovering over the spinner next to
+each image.
 
 The other way to start the import is through the
 :ref:`region-controller API <region-controller-api>`, which you can invoke most
@@ -263,22 +262,15 @@
 See :ref:`Logging in <api-key>` for how to get set up with this tool.  Then,
 run the command::
 
-  $ maas my-maas-session node-groups import-boot-images
+  $ maas my-maas-session boot-resources import
 
 (Substitute a different profile name for 'my-maas-session' if you have named
 yours something else.)  This will initiate the download, just as if you had
-clicked "Import boot images" in the web user interface.
-
-.. note::
-  This API command is only available in MAAS versions 1.3 and above.
-  If you are using an earlier version, you will need to run the shell command
-  ``sudo maas-import-pxe-files`` on each of your cluster controllers.
-
-By default, each cluster is configured to download the images of the two most
-recent LTSes for all the supported architectures from the default location
-(http://maas.ubuntu.com/images/).  Although this should suit most needs,
-an advanced user might want to customise the sources from which the images are
-downloaded or which images should be downloaded.  Read
+clicked "Import images" in the web user interface.
+
+By default, the import is configured to download the most recent LTS release
+only for the amd64 architecture.  Although this should suit most needs, you can
+change the selections on the Images tab, or over the API.  Read
 :doc:`customise boot sources </bootsources>` to see examples on how to do that.
 
 

=== modified file 'docs/bootsources.rst'
--- docs/bootsources.rst	2014-09-26 18:48:41 +0000
+++ docs/bootsources.rst	2014-10-23 19:36:58 +0000
@@ -5,7 +5,7 @@
 Boot images import configuration
 ================================
 
-The configuration for where a cluster downloads its images is defined by
+The configuration for where a region downloads its images is defined by
 a set of "sources".  Each "source" defines a Simplestreams repository
 location (``url``) from which images can be downloaded and a
 ``keyring_filename`` (or ``keyring_data``) for validating index and image
@@ -14,11 +14,10 @@
 that source.
 
 The following example use the MAAS CLI to list the boot sources and the boot
-source selections for a particular cluster.  Assuming that ``CLUSTER_UUID`` is
-the UUID of that cluster, and the CLI ``PROFILE`` is the name of the profile
+source selections.  Assuming the CLI ``PROFILE`` is the name of the profile
 under which you're logged in to the server::
 
-    $ maas $PROFILE boot-sources read $CLUSTER_UUID
+    $ maas $PROFILE boot-sources read
     [
         {
             "url": "http://maas.ubuntu.com/images/ephemeral-v2/releases/",
@@ -29,47 +28,34 @@
         }
     ]
 
-    $ maas $PROFILE boot-source-selections read $CLUSTER_UUID 1
+    $ maas $PROFILE boot-source-selections read 1
     [
         {
-            "release": "precise",
-            "arches": ["*"],
-            "resource_uri": "<url omitted for readability>",
+            "labels": [
+                "release"
+            ],
+            "arches": [
+                "amd64"
+            ],
+            "subarches": [
+                "*"
+            ],
+            "release": "trusty",
             "id": 1,
-            "subarches": ["*"]
-        },
-        {
-            "release": "trusty",
-            "arches": ["*"],
-            "resource_uri": "<url omitted for readability>",
-            "id": 2,
-            "subarches": ["*"]
+            "resource_uri": "<url omitted for readability>"
         }
     ]
 
+
 Restricting the images being downloaded
 ---------------------------------------
 
-Let's say you want to restrict the images being downloaded to only one
-architecture and one release; starting from the configuration described above,
-you would need to:
-
-- Delete the "Precise" selection (the selection '1' of the source '1')::
-
-    $ maas $PROFILE boot-source-selection delete  $CLUSTER_UUID 1 1
-
-- Update the architecture list of the "Trusty" selection so that only the
-  image for amd64 will be downloaded (this is the selection '2' of the source
-  '1')::
-
-    $ maas $PROFILE boot-source-selection update $CLUSTER_UUID 1 2 arches=amd64
-    {
-        "release": "trusty",
-        "arches": ["amd64"],
-        "resource_uri": "<url omitted for readability>",
-        "id": 2,
-        "subarches": ["*"]
-    }
+Let's say you want to add a previous LTS release to images being downloaded.
+Starting from the configuration described above, you would need to:
+
+- Add the "Precise" selection (the selection '1' of the source '1')::
+
+    $ maas $PROFILE boot-source-selection create 1 os="ubuntu" release="precise" arches="amd64" subarches="*" labels="*"
 
 Downloading the images from a different source
 ----------------------------------------------
@@ -77,7 +63,7 @@
 Let's say you want to import the images from a different location.  You would
 need to to change the source's url and keyring::
 
-    $ maas $PROFILE boot-source update $CLUSTER_UUID 1 url="http://custom.url" keyring_filename="" keyring_data@=./custom_keyring_file
+    $ maas $PROFILE boot-source update 1 url="http://custom.url" keyring_filename="" keyring_data@=./custom_keyring_file
     {
         "url": "http://custom.url/",
         "keyring_data": "<base64 encoded content of `custom_keyring_file`>",
@@ -91,7 +77,7 @@
 
 You can also add a new source::
 
-    $ maas maas boot-sources create $CLUSTER_UUID url=http://my.url keyring_filename="" keyring_data@=./ custom_keyring_file
+    $ maas $PROFILE boot-sources create url=http://my.url keyring_filename="" keyring_data@=./ custom_keyring_file
     {
         "url": "http://my.url/",
         "keyring_data": "ZW1wdHkK",
@@ -102,7 +88,7 @@
 
 Inside that newly created source ('2') you can add selections::
 
-    $ maas $PROFILE boot-source-selections create $CLUSTER_UUID 2 arches=amd64 subarches='*' release='trusty' labels='*' os='ubuntu'
+    $ maas $PROFILE boot-source-selections create os="ubuntu" release="trusty" arches="amd64" subarches="*" labels='*'
     {
         "labels": ["*"],
         "arches": ["amd64"],

=== modified file 'docs/index.rst'
--- docs/index.rst	2014-10-10 01:25:49 +0000
+++ docs/index.rst	2014-10-23 19:36:58 +0000
@@ -108,7 +108,6 @@
 
    man/maas-region-admin.8
    man/maas.8
-   man/maas-import-pxe-files.8
 
 
 ***************

=== modified file 'docs/media/import-images.png'
Binary files docs/media/import-images.png	2014-04-14 07:35:07 +0000 and docs/media/import-images.png	2014-10-23 19:36:58 +0000 differ