QA/Test Days/Live Image

From FedoraProject

< QA | Test Days(Difference between revisions)
Jump to: navigation, search
(test day script accepted in spin-kickstarts project)
(Changing the URL opened from the welcome screen)
 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{header|qa}}
 
{{header|qa}}
 +
 +
[[File:qa-test-day-live-image.png|right|400px]]
  
 
= Creating a Test Day Live Image =
 
= Creating a Test Day Live Image =
  
The following steps outline how to create a Fedora live image based on current Rawhide packages for use during Test Days.
+
The following steps outline how to create a Fedora live image based on current [[Releases/Branched|Fedora Branched]] packages for use during [[QA/Test_Days|Test Days]]. This is mainly intended for Fedora QA team and teams that host a Test Day. Of course these teams can also use a [http://alt.fedoraproject.org/pub/alt/nightly-composes/ nightly compose] image, but special Test Day images bring additional benefits - a welcome screen with an easy access to test day channels (web, chat), smaller size and customizability.
  
{{admon/note|This guide is intended mainly for Fedora QA team|Ordinary users who want to participate on a test day don't have to follow this guide, the pre-built images will be published and available for them to download on a [[QA/Test_Days|Test Day pages]].}}
+
How to build a Test Day Live image:
 +
<ol>
 +
<li>Install {{package|livecd-tools}} from the same or higher release that you intend to build the image for. If you want to build a {{FedoraVersion|long|next}} live image, you need to install the <code>.fc{{FedoraVersion|number|next}}</code> package or later. Usually you can install it and run it on an older release ({{FedoraVersion|long|current}}) just fine. If that doesn't work, you will need to install {{FedoraVersion|long|next}} first:
 +
{{#tag:pre|
 +
yum install livecd-tools --releasever={{FedoraVersion|number|next}}
 +
}}
 +
</li>
  
1. Install required packages:
+
<li>Download the kickstart script used by {{FedoraVersion|long|next}} by using the <code>f{{FedoraVersion|number|next}}</code> git branch:
<pre>
+
{{#tag:pre|
yum install livecd-tools git
+
yum install git
</pre>
+
git clone 'git://git.fedorahosted.org/spin-kickstarts.git' -b f{{FedoraVersion|number|next}}
 
+
}}
2. Download our most recent kickstart script:
+
<pre>
+
git clone 'git://git.fedorahosted.org/spin-kickstarts.git' spin-kickstarts
+
</pre>
+
 
or if you have done it in the past, just update it:
 
or if you have done it in the past, just update it:
<pre>
+
{{#tag:pre|cd spin-kickstarts; git checkout f{{FedoraVersion|number|next}}; git pull; cd ..}}
cd spin-kickstarts; git pull; cd ..
+
The Test Day kickstart is located at {{filename|spin-kickstarts/custom/qa-test-day.ks}}.
</pre>
+
</li>
  
3. Create the live image:
+
<li>OPTIONAL: If you need some changes related to your Test Day (some packages pre-installed or some default configuration adjusted), either modify {{filename|qa-test-day.ks}} (it is well documented) or create a new kickstart file, include {{filename|qa-test-day.ks}} and put in your changes. This is an example of ''my-test-day.ks'':
 
<pre>
 
<pre>
livecd-creator -c spin-kickstarts/custom/qa-test-day.ks --cache /var/cache/live -f "testday-`date +%Y%m%d`"
+
%include spin-kickstarts/custom/qa-test-day.ks
</pre>
+
  
{{Admon/tip|Different architecture|You can use <code>setarch</code> command to create a x86 Live CD/DVD on a x86_64 system. Example: <code>setarch i686 livecd-creator <...></code>.}}
+
# Point repositories to a local mirror
 +
repo --name=fedora --baseurl=file:/mnt/globalsync/fedora/linux/development/$releasever/$basearch/os/
 +
repo --name=updates --baseurl=file:/mnt/globalsync/fedora/linux/updates/$releasever/$basearch/
 +
# Enable updates-testing (from the Internet)
 +
repo --name=updates-testing --mirrorlist=http://mirrors.fedoraproject.org/mirrorlist?repo=updates-testing-f$releasever&arch=$basearch
  
= Making custom changes =
 
 
You can make any number of custom changes in the script. Just create a new file ''qa-test-day-custom.ks'' in the parent directory looking like this:
 
 
<pre>
 
%include spin-kickstarts/custom/qa-test-day.ks
 
 
#redefine repo to some local mirror
 
#repo --name=rawhide --baseurl=file:/mnt/globalsync/fedora/linux/development/$basearch/os/
 
  
 
%packages
 
%packages
#packageYouWant
+
# List of packages to be added or removed - dependencies are handled
#wildcardedPackagesYouWant*
+
packageYouWant
#-packageYouDontWant
+
wildcardedPackagesYouWant*
%end  
+
@GroupYouWant
 +
-packageYouDontWant (unless something else requires it)
 +
%end
  
 
%post
 
%post
#any shell commands
+
# Put any shell commands here, they will be executed in a chrooted environment
 
%end
 
%end
 
</pre>
 
</pre>
 +
More kickstart documentation is available at [[Anaconda/Kickstart]].
 +
</li>
  
If you have some local mirror of Rawhide, it is recommended to redefine the repository and you will download the packages much faster than from the Internet. You can also install or uninstall any packages or run any commands in the shell.
+
<li>Create the live image:
 +
{{#tag:pre|livecd-creator -c spin-kickstarts/custom/qa-test-day.ks --releasever {{FedoraVersion|number|next}} --cache /var/cache/live -f testday-YYYY-MM-DD}}
 +
(of course replace ''spin-kickstarts/custom/qa-test-day.ks'' with ''my-test-day.ks'' if you have created your custom kickstart file)
  
After you have made your changes, just run the <code>livecd-creator</code> and point it to your new script.
+
{{Admon/tip|Different architecture|You can use <code>setarch</code> command to create a x86 Live image on a x86_64 system. Example: <code>setarch i686 livecd-creator <...></code>}}
 +
</li>
 +
</ol>
  
= Solving problems =
+
= Further tips =
  
== Rawhide repository broken ==
+
== Using unreleased or custom packages ==
If current rawhide repository is broken and the livecd can't be built, and you have access to some mirror with older rawhide snapshot, create [[#Making_custom_changes|a new custom script]] and redefine the rawhide repository:<br/>
+
It happens quite often that you need to include some bleeding-edge packages that have already been built in [[Koji]], but they haven't been pushed to any of the repositories (''fedora'', ''updates'' or ''updates-testing'') yet, or they haven't hit your mirror yet.
<pre>repo --name=rawhide --baseurl=protocol:/path-to-older-rawhide-repository/$basearch/os/</pre>
+
In the worst case you can base the whole livecd on Fedora 11 packages with this definition:
+
<pre>
+
# not really rawhide, overriden with F11 'released' repo
+
repo --name=rawhide --mirrorlist=http://mirrors.fedoraproject.org/mirrorlist?repo=fedora-11&arch=$basearch
+
repo --name=updates --mirrorlist=http://mirrors.fedoraproject.org/mirrorlist?repo=updates-released-f11&arch=$basearch
+
</pre>
+
Don't forget to comment out these lines when rawhide repository gets fixed.
+
  
== SELinux complaints ==
+
* '''If the packages are already available on the [http://dl.fedoraproject.org/pub/fedora/linux/ master mirror], but not yet on your local mirror''', you can overwrite the <code>repo</code> definitions to force using the master mirror:
For building Test Days LiveCD you '''must''' have SELinux installed and enabled. Ideally it should be in the enforcing mode and everything should run fine. In case you have problems with that, you may switch the mode temporarily into permissive mode with this command run as root:
+
{{#tag:pre|
<pre>
+
repo --name=fedora --baseurl=http://dl.fedoraproject.org/pub/fedora/linux/development/$releasever/$basearch/os/
setenforce 0
+
repo --name=updates --baseurl=http://dl.fedoraproject.org/pub/fedora/linux/updates/$releasever/$basearch/
</pre>
+
repo --name=updates-testing --baseurl=http://dl.fedoraproject.org/pub/fedora/linux/updates/testing/$releasever/$basearch/
 +
}}
 +
Please use this only when necessary. Don't stress our master mirror needlessly.
 +
 
 +
* '''If your package builds are not available even on the master mirror, just in Koji''', you need to download them, create a custom repository and use it in your kickstart file. Example:
 +
<ol>
 +
<li>Download the packages:
 +
<pre>koji download-build NVR</pre></li>
 +
<li>Create a repository from the contents of the current directory:
 +
<pre>createrepo -v .</pre></li>
 +
<li>Share the repository over HTTP, FTP or NFS. One of the easiest way is:
 +
<pre>python -m SimpleHTTPServer</pre>
 +
Now your repository is available at http://localhost:8000.</li>
 +
<li>Include the repository in your kickstart:
 +
<pre>repo --name=test-day --baseurl=http://server/path</pre>
 +
<li>If the packages are included by default, their new versions will be picked up automatically. Otherwise you need to list them:
 +
<pre>%packages
 +
package1
 +
package2
 +
%end</pre></li>
 +
</ol>
 +
 
 +
== Using a non-debug kernel ==
 +
In [[Rawhide]] and in {{FedoraVersion|long|next}} before Beta the debug kernels are used by default. That lowers the system performance considerably. If you need performance rather than kernel debug information, you can manually add a production (non-debug) kernel to the Live image.
  
If that doesn't help, you may also modify the ''fedora-livecd-testday.ks'' file and after <code>%include</code> line add a directive
+
The information how to distinguish a production and a debug kernel is outlined in [[KernelDebugStrategy]]. The easiest way is to search [[Koji]] for a list of kernels built for your Fedora release and pick the latest one that contains ''kernel-debug'' RPM (the presence of this RPM indicates this is a production kernel, i.e. the debug information are separated). If this kernel is available in one of the repositories, you can simple put kernel NVR into the <code>%packages</code> section, like this:
<pre>
+
{{#tag:pre|
selinux --permissive
+
%packages
</pre>
+
kernel-3.9.0-0.rc7.git3.1.fc{{FedoraVersion|number|next}}
 +
%end
 +
}}
 +
 
 +
Very often, however, a production kernel will not be a part of any repository and you'll need to download it manually from Koji and put it into a [[#Using unreleased or custom packages|custom repository]] first.
  
Now the build should run fine.
+
== Changing the URL opened from the welcome screen ==
 +
We use a wiki redirect to display the currently active test day: [[Test_Day:Current]]. If you build your Live image in advance, some other (older) test day will display when you click on the welcome screen button. Don't worry, this will be adjusted later. Shortly before your test day should begin, just edit the redirect: [https://fedoraproject.org/wiki/Test_Day:Current?redirect=no Test_Day:Current?redirect=no]. No need to rebuild your images.
  
 
= Further references =
 
= Further references =
Line 86: Line 112:
 
* [[How_to_create_and_use_a_Live_CD#Testing_your_Live_CD_using_KVM_or_qemu|How to load the live image in KVM or qemu]].
 
* [[How_to_create_and_use_a_Live_CD#Testing_your_Live_CD_using_KVM_or_qemu|How to load the live image in KVM or qemu]].
  
= Ideas For Improvement =
 
# <s>Create a .desktop file with a Test Day URL on the Desktop</s>
 
# <s>Make browser default homepage http://fedoraproject.org/wiki/Test_Day:Current (suggested by [[User:sgallagh]])</s>
 
# Setup a test day .repo for the running live image (suggested by [[User:sgallagh]])
 
  
 
[[Category:Test Days]]
 
[[Category:Test Days]]
 +
[[Category:QA_SOPs]]

Latest revision as of 14:31, 6 May 2013

QA.png


Qa-test-day-live-image.png

Contents

[edit] Creating a Test Day Live Image

The following steps outline how to create a Fedora live image based on current Fedora Branched packages for use during Test Days. This is mainly intended for Fedora QA team and teams that host a Test Day. Of course these teams can also use a nightly compose image, but special Test Day images bring additional benefits - a welcome screen with an easy access to test day channels (web, chat), smaller size and customizability.

How to build a Test Day Live image:

  1. Install Package-x-generic-16.pnglivecd-tools from the same or higher release that you intend to build the image for. If you want to build a Fedora 21 live image, you need to install the .fc21 package or later. Usually you can install it and run it on an older release (Fedora 20) just fine. If that doesn't work, you will need to install Fedora 21 first:
    yum install livecd-tools --releasever=21
    
  2. Download the kickstart script used by Fedora 21 by using the f21 git branch:
    yum install git
    git clone 'git://git.fedorahosted.org/spin-kickstarts.git' -b f21
    

    or if you have done it in the past, just update it:

    cd spin-kickstarts; git checkout f21; git pull; cd ..

    The Test Day kickstart is located at spin-kickstarts/custom/qa-test-day.ks.

  3. OPTIONAL: If you need some changes related to your Test Day (some packages pre-installed or some default configuration adjusted), either modify qa-test-day.ks (it is well documented) or create a new kickstart file, include qa-test-day.ks and put in your changes. This is an example of my-test-day.ks:
    %include spin-kickstarts/custom/qa-test-day.ks
    
    # Point repositories to a local mirror
    repo --name=fedora --baseurl=file:/mnt/globalsync/fedora/linux/development/$releasever/$basearch/os/
    repo --name=updates --baseurl=file:/mnt/globalsync/fedora/linux/updates/$releasever/$basearch/
    # Enable updates-testing (from the Internet)
    repo --name=updates-testing --mirrorlist=http://mirrors.fedoraproject.org/mirrorlist?repo=updates-testing-f$releasever&arch=$basearch
    
    
    %packages
    # List of packages to be added or removed - dependencies are handled
    packageYouWant
    wildcardedPackagesYouWant*
    @GroupYouWant
    -packageYouDontWant (unless something else requires it)
    %end
    
    %post
    # Put any shell commands here, they will be executed in a chrooted environment
    %end
    

    More kickstart documentation is available at Anaconda/Kickstart.

  4. Create the live image:
    livecd-creator -c spin-kickstarts/custom/qa-test-day.ks --releasever 21 --cache /var/cache/live -f testday-YYYY-MM-DD

    (of course replace spin-kickstarts/custom/qa-test-day.ks with my-test-day.ks if you have created your custom kickstart file)

    Idea.png
    Different architecture
    You can use setarch command to create a x86 Live image on a x86_64 system. Example: setarch i686 livecd-creator <...>

[edit] Further tips

[edit] Using unreleased or custom packages

It happens quite often that you need to include some bleeding-edge packages that have already been built in Koji, but they haven't been pushed to any of the repositories (fedora, updates or updates-testing) yet, or they haven't hit your mirror yet.

  • If the packages are already available on the master mirror, but not yet on your local mirror, you can overwrite the repo definitions to force using the master mirror:
repo --name=fedora --baseurl=http://dl.fedoraproject.org/pub/fedora/linux/development/$releasever/$basearch/os/
repo --name=updates --baseurl=http://dl.fedoraproject.org/pub/fedora/linux/updates/$releasever/$basearch/
repo --name=updates-testing --baseurl=http://dl.fedoraproject.org/pub/fedora/linux/updates/testing/$releasever/$basearch/

Please use this only when necessary. Don't stress our master mirror needlessly.

  • If your package builds are not available even on the master mirror, just in Koji, you need to download them, create a custom repository and use it in your kickstart file. Example:
  1. Download the packages:
    koji download-build NVR
  2. Create a repository from the contents of the current directory:
    createrepo -v .
  3. Share the repository over HTTP, FTP or NFS. One of the easiest way is:
    python -m SimpleHTTPServer
    Now your repository is available at http://localhost:8000.
  4. Include the repository in your kickstart:
    repo --name=test-day --baseurl=http://server/path
  5. If the packages are included by default, their new versions will be picked up automatically. Otherwise you need to list them:
    %packages
    package1
    package2
    %end

[edit] Using a non-debug kernel

In Rawhide and in Fedora 21 before Beta the debug kernels are used by default. That lowers the system performance considerably. If you need performance rather than kernel debug information, you can manually add a production (non-debug) kernel to the Live image.

The information how to distinguish a production and a debug kernel is outlined in KernelDebugStrategy. The easiest way is to search Koji for a list of kernels built for your Fedora release and pick the latest one that contains kernel-debug RPM (the presence of this RPM indicates this is a production kernel, i.e. the debug information are separated). If this kernel is available in one of the repositories, you can simple put kernel NVR into the %packages section, like this:

%packages
kernel-3.9.0-0.rc7.git3.1.fc21
%end

Very often, however, a production kernel will not be a part of any repository and you'll need to download it manually from Koji and put it into a custom repository first.

[edit] Changing the URL opened from the welcome screen

We use a wiki redirect to display the currently active test day: Test_Day:Current. If you build your Live image in advance, some other (older) test day will display when you click on the welcome screen button. Don't worry, this will be adjusted later. Shortly before your test day should begin, just edit the redirect: Test_Day:Current?redirect=no. No need to rebuild your images.

[edit] Further references