Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update config.ign example to 3.3.0 #376

Merged
merged 3 commits into from
Jan 3, 2025
Merged

Conversation

cringdahl
Copy link
Contributor

Update config.ign example from 2.3.0 to 3.3.0

2.3.0 is a deprecated version, and butane doesn't output anything but 3.x. The existing 2.3.0 example is not a 1-to-1 translation, and will get newbies (like me) confused as to why a 1-to-1 translation doesn't work. (reason: defining OEM in 3.x appears to overwrite it)

How to use

  1. Add changed text to config.ign, plus valid SSH key
  2. sudo flatcar-install -d ${DISK} -i config.ign -f flatcar_production_image.bin.bz2 -C stable -B arm64-usr -o ''

Testing done

Verified this config.ign resulted in a basic working RPi4 installation.

  • Changelog entries added in the respective changelog/ directory (user-facing change, bug fix, security fix, update)
  • Inspected CI output for image differences: /boot and /usr size, packages, list files for any missing binaries, kernel modules, config files, kernel modules, etc.

Copy link
Collaborator

@tormath1 tormath1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for keeping this up-to-date!

I think we can even more simplify things, with Butane/Ignition v3 we can directly use kernelArguments.

Butane looks like this:

variant: flatcar
version: 1.1.0
kernel_arguments:
  should_exist:
    - console=ttyAMA0,115200n8
    - console=tty1
    - flatcar.autologin
    - usbcore.autosuspend=-1

and Ignition:

{
  "ignition": {
    "version": "3.4.0"
  },
  "kernelArguments": {
    "shouldExist": [
      "console=ttyAMA0,115200n8",
      "console=tty1",
      "flatcar.autologin",
      "usbcore.autosuspend=-1"
    ]
  }

What do you think?

@cringdahl
Copy link
Contributor Author

Thanks a lot for keeping this up-to-date!

I think we can even more simplify things, with Butane/Ignition v3 we can directly use kernelArguments.

Butane looks like this:

variant: flatcar
version: 1.1.0
kernel_arguments:
  should_exist:
    - console=ttyAMA0,115200n8
    - console=tty1
    - flatcar.autologin
    - usbcore.autosuspend=-1

and Ignition:

{
  "ignition": {
    "version": "3.4.0"
  },
  "kernelArguments": {
    "shouldExist": [
      "console=ttyAMA0,115200n8",
      "console=tty1",
      "flatcar.autologin",
      "usbcore.autosuspend=-1"
    ]
  }

What do you think?

That's much nicer, thank you! The old method doesn't include the kernel arguments in first sessioned boot; this is a much cleaner experience.

I've updated the commit with the ignition json; I didn't want to do a doc scope creep by adding in the separate butane step. However, if you think it's a good idea to add it, I certainly can.

@tormath1 tormath1 merged commit 0a0a17a into flatcar:master Jan 3, 2025
@tormath1
Copy link
Collaborator

tormath1 commented Jan 3, 2025

@cringdahl thanks for the ping and for this contribution. Feel free to propose more documentation for RPi4 if you want to!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants