implementing-new-platform.md

Implementing a new supported platform

During Development

Create PRs addressing the following:

• Ignition (example PR)
  • Add userdata fetch
  • If the platform supports it (unlikely), add userdata deletion
• Afterburn (example PR)
  • (Cloud Only) Add relevant attributes
  • (Cloud Only) Add SSH key support if available
  • (Cloud Only) Add hostname support if available
  • (Cloud Only) Add check-in if needed (unlikely)
• stream-metadata-go (example PR)
  • Add platform to the Media struct in release/release.go
  • Add supporting code for new platform to toStreamArch func in release/translate.go
  • (Cloud Only) Cloud Images need to have an Images field
• (Cloud Only) stream-metadata-rust (example PR)
• fedora-coreos-tracker (example PR)
  • Update the metadata for the new platform
• coreos-assembler (example PR)
  • Implement required functionality to support new platform
• fedora-coreos-config
  • Add a stanza to platforms.yaml if the system should use a serial console, or both serial and graphical consoles
• fedora-websites-3.0
  • Add friendly name for platform to components/utilities/FpDownloadItem.vue
  • Add artifact to pages/coreos/download.vue
  • Possibly add logo to content/editions/coreos/home.yml
• fedora-coreos-browser (example PR)
  • Add a list element for new platform in browser/index.html
• build pipeline (example PR)
  • Add platform to the list found in config.yaml for building the new artifact
• fedora-coreos-docs (example PR)
  • Add a provisioning-<platform>.adoc that walks through how to setup the new platform
  • Add an entry in the modules/ROOT/nav.adoc that points to new documentation

At Release

1. Merge upstream changes and put out a release:
   • Ignition
   • Afterburn
2. Merge metadata changes:
   • stream-metadata-go
   • stream-metadata-rust
   • fedora-coreos-tracker
   • fedora website
   • fedora-coreos-browser
3. Release updated components
   • Create and follow release checklist for stream-metadata-go
   • Ensure that Dependabot has PRed stream-metadata-go into fedora-coreos-stream-generator and coreos-assembler. Merge the update PRs.
     • This can be triggered manually by navigating to fedora-coreos-stream-generator's Dependabot and coreos-assembler's Dependabot respectively, then clicking "Check for updates".
       • This might need to be done a few times, as Dependabot might not pick up tag changes for a few attempts after initial tagging.
   • Create and follow release checklist for fedora-coreos-stream-generator
4. Merge the following changes:
   • coreos-assembler
5. Wait for updates made to coreos-assembler to be propagated to latest container
   • Download latest version of coreos-assembler container. Verify platform support functionality.
6. Merge changes for:
   • Build pipeline
7. Wait for new images to reach stable then merge documentation.
   • fedora-coreos-docs merged