Ubuntu Server Installer, and backend for Ubuntu Desktop Installer
Go to file
Olivier Gayot 747cfc50f6 doc: make links to anchors work with pandoc
For some reason, pandoc seems to struggle to create anchor links if
there is no space between the <a> tag and the title. Add a newline to
make it happy.

Signed-off-by: Olivier Gayot <olivier.gayot@canonical.com>
2022-10-20 09:50:09 +02:00
.github/workflows workflows: -impish 2022-07-18 13:17:58 -06:00
bin do apt configuration before install starts 2021-11-17 12:57:26 +13:00
console_conf fix some easier cases of impolite language 2022-08-29 12:30:39 -06:00
debian update github urls to new organization 2021-02-23 12:03:37 +13:00
documentation doc: make links to anchors work with pandoc 2022-10-20 09:50:09 +02:00
examples examples: fix invalid user-data example since we now validate schema 2022-09-01 13:12:53 -06:00
fake_deps tox: Support running tests and flake8 in tox. 2018-06-05 17:59:46 -04:00
font font: allow to display circled white star in console font 2022-05-10 09:45:25 +02:00
kbds kbds: add entries for UDI 2022-08-08 07:54:09 -06:00
po update from newer export 2022-04-14 10:02:51 +12:00
scripts Merge pull request #1421 from ogayot/kvm-test-cloud-config 2022-09-29 14:31:47 +02:00
snap/hooks Revert "os-prober: patch instead of sed" 2022-01-24 12:18:41 -07:00
subiquity Merge pull request #1443 from mwhudson/snapdapi-again 2022-10-06 13:48:25 +13:00
subiquitycore Revert "Merge pull request #1442 from mwhudson/main" 2022-10-05 15:28:39 +13:00
system_setup Fix 2022-09-27 14:13:36 +02:00
.flake8 Make tox and Makefile more similar. 2018-06-05 22:19:17 -04:00
.gitignore Update .gitignore 2022-04-25 07:23:01 -06:00
DESIGN.md install: invoke curtin multiple times with different stages 2022-08-11 09:16:06 +02:00
LICENSE Initial commit 2015-06-08 17:57:45 -04:00
Makefile hooks: execute hook scripts as builtin late commands 2022-08-09 09:47:26 +02:00
README.md Fixed a typo 2021-08-30 12:32:15 +05:30
apt-deps.txt geoip: move from requests to aiohttp again 2022-05-18 16:27:12 +02:00
autoinstall-schema.json source: don't mark search_drivers required 2022-08-04 10:58:59 +02:00
autoinstall-system-setup-schema.json Adding WSLSetupOptions API endpoint 2022-08-23 10:45:29 -03:00
languagelist update languagelist and layout suggestions 2022-07-29 14:13:27 -06:00
passwd Added a passwd file copied from a livecd filesystem 2022-05-11 12:58:58 -03:00
requirements.txt install probert and curtin via Makefile for testing 2021-07-02 13:49:40 +12:00
reserved-usernames reserved-usernames: add sgx group ahead of ubuntu 2022-09-22 11:09:30 +02:00
setup.py do apt configuration before install starts 2021-11-17 12:57:26 +13:00
snapcraft.yaml Merge pull request #1430 from ogayot/LP#1987341 2022-09-27 14:05:45 +02:00
tox.ini fix snap build 2018-06-13 13:21:20 +12:00
users-and-groups only add the user to groups that exist in the target system 2018-06-14 15:27:06 +12:00

README.md

subiquity & console-conf

Ubuntu Server Installer & Snappy first boot experience

The repository contains the source for the new server installer (the "subiquity" part, aka "ubiquity for servers") and for the snappy first boot experience (the "console-conf" part).

We track bugs in Launchpad at https://bugs.launchpad.net/subiquity. Snappy first boot issues can also be discussed in the forum at https://forum.snapcraft.io.

Our localization platform is Launchpad, translations are managed at https://translations.launchpad.net/ubuntu/+source/subiquity/

To update translation template in launchpad:

  • update po/POTFILES.in with any new files that contain translations
  • execute clean target, i.e. $ debuild -S
  • dput subiquity into Ubuntu

To export and update translations in subiquity:

Acquire subiquity from source

git clone https://github.com/canonical/subiquity

cd subiquity && make install_deps

Testing out the installer Text-UI (TUI)

Subiquity's text UI is available for testing without actually installing anything to a system or a VM. Subiquity developers make use of this for rapid development. After checking out subiquity you can start it:

make dryrun

All of the features are present in dry-run mode. The installer will emit its backend configuration files to /tmp/subiquity-config-* but it won't attempt to run any installer commands (which would fail without root privileges). Further, subiquity can load other machine profiles in case you want to test out the installer without having access to the machine. A few sample machine profiles are available in the repository at ./examples/ and can be loaded via the MACHINE make variable:

make dryrun MACHINE=examples/simple.json

Generating machine profiles

Machine profiles are generated from the probert tool. To collect a machine profile:

PYTHONPATH=probert ./probert/bin/probert --all > mymachine.json

Testing changes in KVM

To try out your changes for real, it is necessary to install them into an ISO. Rather than building one from scratch, it's much easier to install your version of subiquity into the daily image. Here's how to do this:

  1. Build your change into a snap:

    $ snapcraft snap --output subiquity_test.snap
    
  2. Grab the current version of the installer:

    $ urlbase=http://cdimage.ubuntu.com/ubuntu-server/daily-live/current
    $ isoname=$(distro-info -d)-live-server-$(dpkg --print-architecture).iso
    $ zsync ${urlbase}/${isoname}.zsync
    
  3. Run the provided script to make a copy of the downloaded installer that has your version of subiquity:

    $ sudo ./scripts/inject-subiquity-snap.sh ${isoname} subiquity_test.snap custom.iso
    
  4. Boot the new iso in KVM:

    $ qemu-img create -f raw target.img 10G
    $ kvm -m 1024 -boot d -cdrom custom.iso -hda target.img -serial stdio
    
  5. Finally, boot the installed image:

    $ kvm -m 1024 -hda target.img -serial stdio
    

The first three steps are bundled into the script ./scripts/test-this-branch.sh.