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 node-image.md #1149

Merged
merged 1 commit into from
Feb 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/topics/node-image.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Node Images

To use CAPH in production it needs a node image. In Hetzner Cloud it is not possible to upload own images directly. However, a server can be created, configured and then snapshotted.
For this Packer could be used, which already has support for Hetzner Cloud.
In this repo is also an example packer node-image. To use it do the following:
To use CAPH in production, it needs a node image. In Hetzner Cloud, it is not possible to upload your own images directly. However, a server can be created, configured, and then snapshotted.
For this, Packer could be used, which already has support for Hetzner Cloud.
In this repository, there is also an example `Packer node-image`. To use it, do the following:
```shell
export HCLOUD_TOKEN=<your-token>

Expand All @@ -13,10 +13,10 @@ packer build templates/node-image/1.28.4-ubuntu-22-04-containerd/image.json
packer build --debug --on-error=abort templates/node-image/1.28.4-ubuntu-22-04-containerd/image.json
```

The first command is necessary so that packer is able to create a server in hcloud.
The second one creates the server with packer. If you are developing your own packer image the third command could be helpful to check what's going wrong.
The first command is necessary so that Packer is able to create a server in hcloud.
The second one creates the server with Packer. If you are developing your own packer image, the third command could be helpful to check what's going wrong.

It's very important to know that if you create your own packer image you need to set a label so that CAPH is able to find the specified image name. We use for this label the following key: `caph-image-name`
Please have a look into the image.json of the [example node-image](/templates/node-image/1.28.4-ubuntu-22-04-containerd/image.json).
It is essential to know that if you create your own packer image, you need to set a label so that CAPH can find the specified image name. We use for this label the following key: `caph-image-name`
Please have a look at the image.json of the [example node-image](/templates/node-image/1.28.4-ubuntu-22-04-containerd/image.json).

If you use your own node image, make sure to also use a cluster flavor that has `packer` in its name. The default one use preKubeadm commands to install all necessary things. This is very helpful for testing but is not recommended in a production system.
If you use your own node image, make sure also to use a cluster flavor that has `packer` in its name. The default one uses preKubeadm commands to install all necessary things. This is very helpful for testing but is not recommended in a production system.