Skip to content

Uyuni development in no time

Jump to bottom
Pau Garcia Quiles edited this page Apr 21, 2021 · 8 revisions

Intro

While we generally advise developers to use sumaform to create development infrastructure (Server, clients, etc), it is not a must and can be a bit difficult to understand at the beginning.

Here is how to get started developing without sumaform, just by manually creating your infrastructure. It's written in an informal tone because it was originally written in answer to a user in Gitter.

TL;DR

What we are going to do is the following:

  1. Install Uyuni Stable to make sure all the dependencies, database, etc are set up correctly
  2. Deploy a development version of Uyuni on top of Uyuni Stable

The reason to "prepare" the system first with Uyuni Stable is some of the pattern packages are not built by default for Uyuni development versions. Instead of trying to get those packages built, it's just easier to do this in two setps.

Whenever you make changes in the code and want to try them, you can go directly to step 2 (deploy Uyuni development version), you only need step 1 (deploy Uyuni Stable) once.

How to manually set up your development infrastructure

  1. Install Uyuni Server Stable (2021.02 as of now)

  2. Fork all of the packages of Uyuni master into your own OBS project:

for I in `osc ls systemsmanagement:Uyuni:Master`; do osc branch --nodevelproject systemsmanagement:Uyuni:Master $I home:pagarcia:hackweek20; done

OBS typically updates the forks when there are changes in the original project (systemsmanagement:Uyuni:Master). We do not want that because it would smash the precious code we are going to write. We can avoid OBS smashing our code by using --nodevelproject parameter.

E. g. in my case that results in: https://build.opensuse.org/project/show/home:pagarcia:hackweek20).

  1. Copy the projectconfig and meta from https://build.opensuse.org/project/show/systemsmanagement:Uyuni:Master to your fork's to make sure everything builds.

  2. When the packages in your fork are built, ssh into the Uyuni Server and zypper ar --enable --refresh the repo of your fork.

  3. Stop Uyuni: spacewalk-service stop on the Uyuni Server

  4. Run zypper dup --allow-vendor-change --allow-arch-change --allow-name-change --allow-downgrade on the Uyuni Server. Your Uyuni Server is now updated to your fork.

  5. Run rpm -qi susemanager-schema and note the version. As of today, it says 4.2.9.

  6. Run ls -lah /etc/sysconfig/rhn/schema-upgrade. Notice the susemanager-schema-4.2.X-to-susemanager-schema-4.2.Ydirectories. If 4.2.X > 4.2.9 (or whatever version of susemanager-schema is installed on your system), then you need to manually execute those migration scripts: psql -U uyunidatabaseuser -d uyunidatabase < /etc/sysconfig/rhn/schema-upgrade/susemanager-schema-4.2.9-to-susemanager-schema-4.2.10/*. You may need to run this for more than one directory. You only need to do this if you modified some SQL, or (in the future) if you are rebasing your code and someone else modified the database.

  7. If operating system packages were also upgraded, reboot. If not, just start Uyuni Server: spacewalk-service start. It might take a while to the database migrations.

Client tools

If you will be modifying the client tools (either traditional stack or Salt stack), then do the same for the whatever client tools OBS project you will be modifying. E. g. for CentOS 7:

  1. Create fork of Uyuni Master CentOS 7 client tools in a new subproject of your project (e. g. home:pagarcia:hackweek20:CentOS7-Client-Tools):
for I in ``osc ls systemsmanagement:Uyuni:Master:CentOS7-Uyuni-Client-Tools``; do osc branch --nodevelproject systemsmanagement:Uyuni:Master:CentOS7-Uyuni-Client-Tools home:pagarcia:hackweek20:CentOS7-Client-Tools; done

  1. To avoid submitting Salt to two places (home:pagarcia:hackwek20 -for the Server- and home:pagarcia:hackweek20:CentOS7-Client-Tools -for the client tools-), delete the salt package in home:pagarcia:hackweek20:CentOS7-Client-Tools and branch it from the Server OBS repo: osc branch home:pagarcia:hackwek20 salt home:pagarcia:hackweek20:CentOS7-Client-Tools

  2. Modify /etc/rhn/spacewalk-common-channels.ini to take the client tools from your OBS repository. Otherwise, you will noticed very weird interactions because Salt on the Uyuni Server side will contain the changes you made, but Salt on the client side will not.

How to manually set up your development environment

  1. Fork the Uyuni source code (https://github.com/uyuni-project/uyuni/) into your own repo (e. .g in my case https://github.com/paususe/uyuni).
  2. Clone the Uyuni upstream repository: git clone git@github.com:uyuni-project/uyuni.git
  3. Add your own fork as a remote: git remote add paususe git@github.com:paususe/uyuni.git
  4. Follow the instructions in http://bosdonnat.fr/slides/openSUSEAsiaSummit19/ to develop.

What I typically do is I always develop locally, submit code to OBS for packages to be created, and then zypper dup --allow-vendor-change --allow-arch-change --allow-name-change --allow-downgrade on the Uyuni Server. It's a bit slower (I need to wait for OBS to finish) than deploying code directly to the Uyuni Server via SSH but that way I am sure I am always updating all the packages that might have been affected by my changes.

Clone this wiki locally