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

Provisioning: Add Hetzner #654

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

travier
Copy link
Member

@travier travier commented Jul 16, 2024

Initial documentation to setup FCOS on Hetzner.

Inspired by: https://www.flatcar.org/docs/latest/installing/cloud/hetzner/
See: coreos/fedora-coreos-tracker#1324

Copy link

@apricote apricote left a comment

Choose a reason for hiding this comment

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

Awesome! I will do another more thorough review and test in the next few days. Just noticed this on the first read through.

modules/ROOT/pages/provisioning-hetzner.adoc Outdated Show resolved Hide resolved
This guide shows how to provision new Fedora CoreOS (FCOS) nodes on Hetzner.
Fedora CoreOS is currently not available as an option in the operating system selection on Hetzner.
Fedora CoreOS images for Hetzner are currently not directly available for download either.
Thus you must first download a Fedora CoreOS RAW disk image, then convert it to an Hetzner image locally and finally create a snapshot from it in your Hetzner account using the https://github.com/apricote/hcloud-upload-image[hcloud-upload-image] tool.
Copy link
Member

Choose a reason for hiding this comment

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

FWIW, as per https://github.com/apricote/hcloud-upload-image?tab=readme-ov-file#support-disclaimer, this isn't an official tool. I feel like our docs should stick with tools available in Fedora or from the cloud provider directly. At the very least, it seems worth calling this out in a WARNING.

Choose a reason for hiding this comment

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

Two official alternatives:

I personally found both of these options annoying and not very user friendly, so I wrote the CLI/Go Lib to improve on this. hcloud-upload-image will be deprecated in favor of an hcloud subcommand if an official endpoint for uploading images is added to the API.

Copy link
Member Author

Choose a reason for hiding this comment

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

I would say this entire page is "best-effort" given that we don't produce images. But I'm also fine adding a warning specifically for this tool.

Copy link
Member Author

Choose a reason for hiding this comment

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

I did not go the packer route because it depends on packer and it's no longer open source.

Choose a reason for hiding this comment

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

It should also be mentioned that all variants ultimately create a temporary server that will be billed at the end of the month (even though it shouldn't be that much money since Hetzner charges by minutes used; however, unknown servers unexpectedly appearing on the bill might confuse users). It should also be mentioned that this will create a snapshot that also costs money depending on the image size (0.0110 € per GB per month plus VAT); permanently if not deleted manually.

Copy link
Member Author

Choose a reason for hiding this comment

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

I added an "important" note about both of those topics at the top.

@travier travier force-pushed the main-prov-hetzner branch 3 times, most recently from 964c6b5 to 36f1c0d Compare July 17, 2024 16:22
@travier
Copy link
Member Author

travier commented Jul 23, 2024

Thanks! Fixed. I'll do another full pass to test it again from scratch.

@travier
Copy link
Member Author

travier commented Jul 24, 2024

I've filed hetznercloud/cli#825 to ask about making the tool more official

@travier
Copy link
Member Author

travier commented Sep 17, 2024

hetznercloud/cli#825 has been closed so this will remain "unofficial" / best effort supported for now. I still think we should document this as this is still using the platform as intended.

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.

4 participants