Differential D427

update install guide, add README
ClosedPublic
Actions

Authored by garretraziel on Jul 10 2015, 11:44 AM.

Details

Reviewers
adamwill
jskladan
Commits
rOPENQA386e1205c980: update install guide, add README
Summary

InstallGuide was little bit outdated and Docker README
didn't mention openqa_trigger. I have reformatted InstallGuide
to markdown (so it gets rendered on bitbucket) and updated it. I have
also created README.md - user is told to use InstallGuide to install
OpenQA on bare machine or to use docker/README.md to install OpenQA
with Docker and then it explains how to install openqa_trigger.

Test Plan

try to follow InstallGuide and install OpenQA with it.

Diff Detail

Repository
rOPENQA fedora_openqa
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
garretraziel retitled this revision from to update install guide, add README.Jul 10 2015, 11:44 AM
garretraziel updated this object.
garretraziel edited the test plan for this revision. (Show Details)
garretraziel added reviewers: jskladan, adamwill.
garretraziel added a comment.Jul 10 2015, 11:47 AM

See if you have any notes on this - is it easy to understand and follow? I will check InstallGuide with bare machine in the meantime.

jskladan accepted this revision.Jul 13 2015, 7:44 AM

Overall, this looks good to me! thx

This revision is now accepted and ready to land.Jul 13 2015, 7:44 AM
Closed by commit rOPENQA386e1205c980: update install guide, add README (authored by Garret Raziel <boloomka@gmail.com>). · Explain WhyJul 13 2015, 9:59 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathPackages
AMInstallGuide.md (128 lines)
DMInstallGuide.txt (177 lines)
AMREADME.md (92 lines)

Diff 1138

View Options

InstallGuide.md

  • This file was added.
1​OpenQA install guide
2​====================
3​
4​Install OpenSuse 13.2
5​---------------------
6​
7​* Add online repos before installation
8​* Create partition setup & use the right HDD
9​* Select Update & Non-OSS repos & Main Update Repository
10​* Select GNOME desktop
11​* Create user (test/fedora), make user system administrator
12​* Disable firewall, enable SSH
13​
14​Install OpenQA
15​--------------
16​
17​1. become a root
18​
19​ sudo su -
20​
21​2. add repos
22​
23​ zypper ar -f http://download.opensuse.org/repositories/devel:openQA:stable/openSUSE_13.2/devel:openQA:stable.repo
24​ zypper ar -f obs://devel:openQA/openSUSE_13.2 openQA
25​ zypper ar -f obs://devel:openQA:13.2/openSUSE_13.2 openQA-perl-modules
26​
27​3. install OpenQA
28​
29​ zypper in openQA
30​ zypper in openQA-worker
31​
32​4. create filesystem layout
33​
34​ cd /var/lib/openqa
35​ mkdir factory/hdd
36​
37​5. setup apache
38​
39​ gensslcert
40​ cd /etc/apache2/vhosts.d/
41​ a2enmod headers
42​ a2enmod proxy
43​ a2enmod proxy_http
44​ a2enmod proxy_wstunnel
45​ a2enmod ssl
46​ a2enflag SSL
47​
48​ cp openqa-ssl.conf.template openqa-ssl.conf
49​ cp openqa.conf.template openqa.conf
50​
51​6. edit openqa-ssl.conf
52​
53​ vim openqa-ssl.conf
54​
55​ Un-comment lines starting with `#SSL`. Replace paths to certificates from
56​ `openqa.{crt,key}` to `server.{crt,key}`.
57​
58​7. correct OpenID link
59​
60​ vim /etc/openqa/openqa.ini
61​
62​ Uncomment & change:
63​
64​ [openid]
65​ provider = https://id.fedoraproject.org/
66​ [auth]
67​ method = OpenID
68​
69​8. set up fedora tests from repo
70​
71​ zypper in guestfs-tools
72​ git clone http://bitbucket.org/rajcze/openqa_fedora.git /var/lib/openqa/tests/fedora
73​ chown -R geekotest /var/lib/openqa/tests/
74​
75​9. set up disks
76​
77​ git clone http://bitbucket.org/rajcze/openqa_fedora_tools.git ~/openqa_fedora_tools
78​ cd /var/lib/openqa/factory/hdd/
79​ bash ~/openqa_fedora_tools/tools/createhdds.sh
80​ chown geekotest *
81​
82​10. setup services
83​
84​ systemctl enable apache2
85​ systemctl restart apache2
86​ systemctl enable openqa-webui
87​ systemctl restart openqa-webui
88​
89​11. check if openqa-webui is runing
90​
91​ curl http://localhost
92​
93​12. login via OpenID in the web interface - the first one to login is automagically set to be the admin
94​
95​13. setup Worker - go to http://localhost/api_keys & create the keys. Copy the key & secret to `/etc/openqa/client.conf`
96​
97​14. [optional] create required worker directories - this isn't needed if you plan to have only one worker (suitable for development):
98​
99​ mkdir pool/1
100​ chown -R _openqa-worker pool/1
101​
102​15. start worker
103​ systemctl enable openqa-worker@1
104​ systemctl start openqa-worker@1
105​
106​ Check whether worker is active in the web-ui. To add another worker, repeat the steps of "create required worker directories" and "start worker", substituing "1" to next available number.
107​
108​16. populate database with fedora-specific tests
109​
110​ cd /var/lib/openqa/tests/fedora && ./templates
111​
112​17. go to OpenQA web interface, login as admin, go to "admin" -> "Test suites".
113​Set `REPOSITORY_GRAPHICAL` and `REPOSITORY_VARIATION` to your nearest mirror
114​according to this list: https://mirrors.fedoraproject.org/mirrorlist?repo=fedora-22&arch=x86_64,
115​excluding `/22/x86_64/os/` at the end of url. For example if your nearest mirror
116​is http://ftp.linux.cz/pub/linux/fedora/linux/development/22/x86_64/os/, set
117​`REPOSITORY_GRAPHICAL` and `REPOSITORY_VARIATION` to http://ftp.linux.cz/pub/linux/fedora/linux/development.
118​
119​18. enable SSH
120​
121​ systemctl enable sshd
122​ systemctl start sshd
123​
124​19. enable SSH, HTTP and HTTPS in firewall
125​
126​ SuSEfirewall2 open EXT TCP ssh
127​ SuSEfirewall2 open EXT TCP http
128​ SuSEfirewall2 open EXT TCP https
View Options

InstallGuide.txt

  • This file was deleted.
This file was completely deleted. Show File Contents
View Options

README.md

  • This file was added.
1​OpenQA Fedora additional tools
2​==============================
3​
4​This repository contains additional tools for testing Fedora with
5​[OpenQA](http://os-autoinst.github.io/openQA/). For actual
6​OpenQA tests for Fedora, see [this repository](https://bitbucket.org/rajcze/openqa_fedora).
7​
8​Installation of OpenQA
9​----------------------
10​There are currently two options how to install OpenQA to do Fedora testing.
11​
12​1. Use OpenSUSE instance and install OpenQA on top of it - see `InstallGuide.md`
13​2. Use any Linux distribution and use Docker - see `docker/README.md`
14​
15​Installation of openqa_trigger
16​------------------------------
17​
18​After OpenQA is installed, you may want to set up openqa_trigger that downloads
19​iso and runs tests automatically when new compose is released.
20​
21​1. install python deps
22​
23​ Either:
24​
25​ zypper in python-setuptools python-six python-requests python-urlgrabber
26​
27​ when you have installed OpenQA on OpenSUSE or:
28​
29​ dnf install python-setuptools python-six python-requests python-urlgrabber
30​
31​ when you have installed OpenQA using Docker on Fedora.
32​
33​2. get the deps from GIT repos - do this as user that will be used for running
34​the trigger:
35​
36​ sudo su - geekotest # substitue for user of your choice
37​
38​ mkdir WIKITCMS; cd WIKITCMS
39​ git clone https://www.happyassassin.net/cgit/wikitcms
40​ git clone https://www.happyassassin.net/cgit/relval
41​ git clone https://www.happyassassin.net/cgit/fedfind
42​ git clone https://github.com/os-autoinst/openQA-python-client.git
43​
44​ cd fedfind; sudo python setup.py install
45​ cd ../wikitcms; sudo python setup.py install
46​ cd ../relval; sudo python setup.py install
47​ cd ../openQA-python-client; sudo python setup.py install
48​ cd
49​
50​3. check whether relval works by running:
51​
52​ relval
53​
54​4. set-up credentials file for user
55​
56​ mkdir ~/.fedora
57​ echo "fas_username fas_password" > ~/.fedora/credentials
58​
59​5. [docker] if you run OpenQA in Docker, you have to set up credentials for OpenQA
60​on your system. Create file `~/.config/openqa/client.conf` with following content:
61​
62​ [localhost:8080]
63​ key = KEY
64​ secret = SECRET
65​
66​ where `KEY` and `SECRET` are values from http://localhost:8080/api_keys you
67​ have created during OpenQA installation. You can run:
68​
69​ docker exec openqa_webui cat /data/conf/client.conf
70​
71​ which displays both values.
72​
73​6. get the actual tools
74​
75​ git clone https://bitbucket.org/rajcze/openqa_fedora_tools
76​
77​7. set-up cronjob - run
78​
79​ crontab -e
80​
81​ and insert following:
82​
83​ 00 * * * * /PATH/TO/THE/openqa_fedora_tools/tools/openqa_trigger/openqa_trigger.py current
84​
85​ openqa_trigger will check for new composes every hour.
86​
87​ [docker] If you run OpenQA in Docker, you probably don't want to use default
88​ directory for downloading isos. Insert following into crontab instead:
89​
90​ 00 * * * * /PATH/TO/THE/openqa_fedora_tools/tools/openqa_trigger/openqa_trigger.py -i /PATH/TO/PREVIOUSLY/CREATED/data/factory/iso current
91​
92​ For full list of options of openqa_trigger, run `python openqa_trigger.py -h`.