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

docs(hetzner): update for new OEM images #336

Merged
merged 1 commit into from
Jun 13, 2024
Merged

Conversation

apricote
Copy link
Contributor

@apricote apricote commented May 30, 2024

Update Hetzner docs for new OEM images, explaining the Snapshot process

Now that the beta and alpha releases include Hetzner OEM images we can update the docs to utilize these images.

The current terraform process is okay for a single server, but if you want to create a fleet of servers you want to re-use the snapshots to create new servers quicker.

I was not sure which option is actually easier, Packer or hcloud-upload-image, so I documented both for now.

In comparison to https://github.com/apricote/flatcar-packer-hcloud/ I tried to remove any bells and whistles from the Packer template, to keep it as short as possible for the docs and easy to understand.

Related to flatcar/Flatcar#1412.

Disclaimer: I am the author of hcloud-upload-image and the mentioned "extended packer templates". I also work at Hetzner, but this was done in my private time.

How to use

If you have a Hetzner account, you can just follow along with the instructions.

Testing done

I have followed these steps myself while writing the docs to verify that they work.

  • 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.

content/docs/latest/installing/cloud/hetzner.md Outdated Show resolved Hide resolved
content/docs/latest/installing/cloud/hetzner.md Outdated Show resolved Hide resolved
content/docs/latest/installing/cloud/hetzner.md Outdated Show resolved Hide resolved
content/docs/latest/installing/cloud/hetzner.md Outdated Show resolved Hide resolved
content/docs/latest/installing/cloud/hetzner.md Outdated Show resolved Hide resolved
content/docs/latest/installing/cloud/hetzner.md Outdated Show resolved Hide resolved
content/docs/latest/installing/cloud/hetzner.md Outdated Show resolved Hide resolved
content/docs/latest/installing/cloud/hetzner.md Outdated Show resolved Hide resolved
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.

LGTM. There are two small comments to address and I think we can add a note regarding the Afterburn issue you found directly under the Butane example.

EDIT: we can squash everything in one commit.

flatcar.pkr.hcl Outdated Show resolved Hide resolved
Describe the process to upload the image using Packer or hcloud-upload-image.
@apricote
Copy link
Contributor Author

Cleaned everything up, fixed the Afterburn issue and squashed it all into a single commit :)

@apricote apricote requested a review from tormath1 June 12, 2024 18:59
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.

Many thanks for all your efforts and your contributions regarding Hetzner and Flatcar support. 🙏

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.

3 participants