Update README.md (#1)

Add links to requirements.
Fix minor typos and wording issues.

Signed-off-by: Lenz Grimmer <lenz@grimmer.com>
This commit is contained in:
Lenz Grimmer 2024-04-03 18:27:45 +02:00 committed by GitHub
parent 274e4192f4
commit e5b84e72be
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -2,19 +2,19 @@
## Requirements ## Requirements
- Hetzner Cloud API Token - [Hetzner Cloud API Token](https://docs.hetzner.com/cloud/api/getting-started/generating-api-token/)
- Packer - [Packer](https://developer.hashicorp.com/packer)
- Butane - [Butane](https://coreos.github.io/butane/)
- Hetzner Cloud CLI (`hcloud`) - [Hetzner Cloud CLI](https://github.com/hetznercloud/cli) (`hcloud`)
This only works on Flatcar > `3913.0.0`, as this version has the appropriate versions of `ignition` and `afterburn` that This only works on Flatcar version `3913.0.0` (or later), as this version has the appropriate versions of
add support for the Hetzner Cloud metadata service. `ignition` and `afterburn` that include support for the Hetzner Cloud metadata service.
## Building Snapshots ## Building Snapshots
```shell ```shell
$ git clone ... # TODO $ git clone ... # TODO
$ export HCLOUD_TOKEN=... $ export HCLOUD_TOKEN=<Your Hetzner Cloud API Token>
$ packer init flatcar.pkr.hcl $ packer init flatcar.pkr.hcl
$ butane butane-oem.yaml --pretty --strict --output=ignition-oem.json $ butane butane-oem.yaml --pretty --strict --output=ignition-oem.json
@ -32,7 +32,7 @@ ID TYPE NAME DESCRIPTION ARCHITECTURE IMAGE SIZE DI
157132252 snapshot - flatcar-alpha-arm arm 0.42 GB 40 GB Sat Mar 30 16:48:24 CET 2024 - 157132252 snapshot - flatcar-alpha-arm arm 0.42 GB 40 GB Sat Mar 30 16:48:24 CET 2024 -
``` ```
## Create a Sever ## Create a Server
You can now create a new server from the snapshot. Not every feature might automatically work, as the snapshot is You can now create a new server from the snapshot. Not every feature might automatically work, as the snapshot is
missing the functionality from [`hc-utils`](https://github.com/hetznercloud/hc-utils). Configuring SSH Keys and User missing the functionality from [`hc-utils`](https://github.com/hetznercloud/hc-utils). Configuring SSH Keys and User
@ -45,7 +45,7 @@ $ SNAPSHOT_ID=$(hcloud image list --type=snapshot --selector=os=flatcar --archit
# Create a new server # Create a new server
# If you have, you can specify an Ignition config with `--user-data-from-file ignition-user.json` # If you have, you can specify an Ignition config with `--user-data-from-file ignition-user.json`
$ hcloud server create --name flatcar-test --image $SNAPSHOT_ID --type cx11 --ssh-key <your-key> $ hcloud server create --name flatcar-test --image $SNAPSHOT_ID --type cx11 --ssh-key <your-key>
# Takes a minute or two # Wait about a minute or two for the server to be started
# Now you can login, the following is a helper that calls `ssh` with the public ipv4 address of the server # Now you can login, the following is a helper that calls `ssh` with the public ipv4 address of the server
$ hcloud server ssh flatcar-test $ hcloud server ssh flatcar-test