Hetzner Cloud Development Kit

Unofficial Cloud Development Kit for Hetzner Cloud

Getting Started

.env

HETZNER_AUTH_TOKEN=xxx

index.js

const cdk = await CDK.init({
    namespace: "space",
    datacenter: DATACENTER.FALKENSTEIN,
});

const server = new Server({
    name: "spaceserver",
    image: "ubuntu-20.04",
    serverType: "cx11",
    dockerImage: "docker.io/library/httpd",
    healthCheck: {
      intervalInSeconds: 5,
      statusCode: 200,
    },
});
cdk.add(server);

cdk.run();

• Show Diff index.js diff
• Deploy to Hetzner Cloud index.js deploy
• Destroy on Hetzner Cloud index.js destroy

Add SSH key to server

By default the server will create a root password that is send to you via email. It is recommended to set an SSH key to access the server.

const publicKey = PublicKey.fromFile("id_ed25519.pub");
const sshKey = new SSHKey({
    name: "spacekey",
    publicKey,
});
server.addSSHKey(sshKey);

Add IP to server

By default a server will automatically create an IPv4 address, but you will be able to attach an existing Primary IP as well.

const ipv4 = new PrimaryIP({
    name: "spaceip",
    type: "ipv4"
})
server.addPrimaryIP(ipv4)

Add Floating IP to server

By default a server will automatically create an IPv4 address, but you will be able to attach an existing Floating IP as well.

❗️ NOTE: Currently not implemented properly!

const ipv4 = new FloatingIP({
    name: "spaceip",
    type: "ipv4"
})
server.addFloatingIP(ipv4)

Options

In some cases you might want to deploy your stack to hetzner without getting the users confirmation. In that case you can append the --force option to the deploy command.

Server Configuration

By default every server will run in addition to the given docker image, an nginx proxy and the nginx proxy acme companion to issue a LetsEncrypt SSL certificate. After you deploy your server, the CDK will give you the public IP which you will need to add as an A record entry in the DNS settings of your server. The acme companion will check for that record every hour and issue the SSL certificate as soon as it is available.

Export Cloud Template

You can export the cloud configuration into a yaml template and then import it later without recreating the cloud resources. Simply define your cloud resources and then call const template = await cdk.export() instead of cdk.run(). The function will return the yaml template that you can import later with await CDK.import(template).

Private Docker Repositories

Set the following two environment variables to allow Docker pull private repositories:

HETZNER_DOCKER_USERNAME=xxx
HETZNER_DOCKER_TOKEN=xxx
HETZNER_DOCKER_REGISTRY=xxx

Examples

CDK examples can be found in the examples folder.