serial: T8375: use boot activation script to define a serial console on the CLI

[c-po]

Change summary

Required during first-boot of a system. We have images form amd64 and arm64 CPUs which also tend to have different serial interfaces (ttyS vs. ttyAMA).

The images which are installed have the correct serial setting for GRUB (ttyS0 or ttyAMA0) and the activation script will probe the Kernel command-line. If a serial interface is defined, we will include it in the VyOS CLI configuration.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Code style update (formatting, renaming)
• Refactoring (no functional changes)
• Migration from an old Vyatta component to vyos-1x, please link to related PR inside obsoleted component
• Other (please describe):

Related Task(s)

• https://vyos.dev/T8375

Related PR(s)

• flavor: T8375: add flavor.json during build into resulting image vyos-build#1152
• Testsuite: T8375: verify proper serial console settings vyos-build#1155
• console: T8375: document "set system console device <device> kernel" command vyos-documentation#1820

How to test / Smoketest result

TBD

Checklist:

• I have read the CONTRIBUTING document
• I have linked this PR to one or more Phabricator Task(s)
• I have run the components SMOKETESTS if applicable
• My commit headlines contain a valid Task id
• My change requires a change to the documentation
• I have updated the documentation accordingly

[github-actions]

👍
No issues in PR Title / Commit Title

[zdc]

Overall, it looks logical. Let's try to polish it, I think.

1. I think, if we use only one way to note the console, it will be less messy in the code: console_type + console_num or console_device.

2. There is a mix-up between str and None arguments in functions and their calls, which should work fine generally. But it may also end up with unexpected surprises in the long term, when someone will update calls. I would prefer to unify all calls to a single type. Also, we may consider using just the explicit defaults argument: str = '' more for "cleanup" operations to keep the mistake risk surface purely inside functions.

[c-po]

Smoketests are failing due to unmerged vyos/vyos-build#1152

[sever-sever]

Add console parameters based on architecture
At least we see the login/password for the git ARM runner

DEBUG - Welcome to VyOS - vyos ttyAMA0
DEBUG - 
DEBUG - vyos login: vyos
DEBUG - vyos
DEBUG - Password: vyos
DEBUG - 
DEBUG - Welcome to VyOS!
DEBUG - 
DEBUG -    ┌── ┐
DEBUG -    . VyOS 999.202604030943
DEBUG -    └ ──┘  current
DEBUG - 
DEBUG -  * Documentation:  https://docs.vyos.io/en/latest
DEBUG -  * Project news:   https://blog.vyos.io/
DEBUG -  * Bug reports:    https://vyos.dev/
DEBUG - 
DEBUG - You can change this banner using "set system login banner post-login" command.
DEBUG - 
DEBUG - VyOS is a free software distribution that includes multiple components,
DEBUG - you can check individual component licenses under /usr/share/doc/*/copyright
DEBUG - 
DEBUG - ---
DEBUG - WARNING: This VyOS system is not a stable long-term support version and
DEBUG -          is not intended for production use.
DEBUG - 
 INFO - Logged in!
DEBUG - vyos@vyos:~$ if sudo grep -rq "BEGIN PRIVATE KEY" /var/lib/shim-signed/mok; then echo Found private key - bailing out; exit 1; fi
DEBUG - if sudo grep -rq "BEGIN PRIVATE KEY" /var/lib/shim-signed/mok; then 
 echo Found private key - bailing out; exit 1; fi
 INFO - Starting installer
DEBUG - vyos@vyos:~$ install image
DEBUG - install image
DEBUG - Welcome to VyOS installation!
DEBUG - This command will install VyOS to your permanent storage.
DEBUG - Would you like to continue?y
DEBUG -  [y/N] y
DEBUG - What would you like to name this image? (Default: 999.202604030943)
DEBUG - 
DEBUG - Please enter a password for the "vyos" user: vyos
DEBUG - 
DEBUG - 
DEBUG - WARNING: Default password used. Consider changing it on next login.
DEBUG - 
DEBUG - Please confirm password for the "vyos" user: vyos
DEBUG - 
DEBUG - What console should be used by default? (K: KVM, S: Serial)? (DefauS
DEBUG - lt: A) S
DEBUG - Invalid value, try again.
ERROR - Timeout waiting for VyOS system
ERROR - Traceback (most recent call last):
  File "/__w/vyos-build-arm64/vyos-build-arm64/vyos-build/scripts/check-qemu-install", line 692, in <module>
    c.expect('\nWhich one should be used for installation?.*')
  File "/usr/lib/python3/dist-packages/pexpect/spawnbase.py", line 343, in expect
    return self.expect_list(compiled_pattern_list,
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3/dist-packages/pexpect/spawnbase.py", line 372, in expect_list
    return exp.expect_loop(timeout)
           ^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3/dist-packages/pexpect/expect.py", line 181, in expect_loop
    return self.timeout(e)
           ^^^^^^^^^^^^^^^
  File "/usr/lib/python3/dist-packages/pexpect/expect.py", line 144, in timeout
    raise exc
pexpect.exceptions.TIMEOUT: Timeout exceeded.

[jestabro]

I see one issue here: the setting added to the config file during live boot (say, ttyS0) remains after the first boot into the installed image. Consequently, if a user chooses K(VM) during image install, that is correctly written to the grub vars for the reboot into the installed image; however, during that reboot, the system_console config script will re-write the config entry to the grub vars. A subsequent reboot will replace the choice of tty with ttyS.

[github-actions]

CI integration ❌ failed!

Details

CI logs

• CLI Smoketests ❌ failed
• CLI Smoketests (interfaces only) 👍 passed
• Config tests ❌ failed
• RAID1 tests 👍 passed
• CLI Smoketests VPP 👍 passed
• Config tests VPP 👍 passed
• TPM tests ❌ failed

[c-po]

I see one issue here: the setting added to the config file during live boot (say, ttyS0) remains after the first boot into the installed image. Consequently, if a user chooses K(VM) during image install, that is correctly written to the grub vars for the reboot into the installed image; however, during that reboot, the system_console config script will re-write the config entry to the grub vars. A subsequent reboot will replace the choice of tty with ttyS.

The issue has been corrected. Thanks for testing this interesting combination.

[jestabro]

The issue (mentioned above) with overwriting grub vars after installation has been resolved. The necessary tools to define a serial console on live-boot are in place.