tweaked readme
This commit is contained in:
parent
8be07271fd
commit
5c418fb462
24
README.md
24
README.md
@ -32,11 +32,11 @@ _Please note that we are not affiliated to Hetzner, this is just an open source
|
|||||||
### Features
|
### Features
|
||||||
|
|
||||||
- Maintenance free with auto-upgrade to the latest version of MicroOS and k3s.
|
- Maintenance free with auto-upgrade to the latest version of MicroOS and k3s.
|
||||||
- Proper use of the underlying Hetzner private network to remove the need for encryption while minimizing latency.
|
- Proper use of the Hetzner private network to minimize latency and remove the need for encryption.
|
||||||
- Automatic HA with the default setting of three control-plane and two agents nodes.
|
- Automatic HA with the default setting of three control-plane nodes and two agent nodepools.
|
||||||
- Ability to add or remove as many nodes as you want while the cluster stays running.
|
- Ability to add or remove as many nodes as you want while the cluster stays running.
|
||||||
- Automatic Traefik ingress controller attached to a Hetzner load balancer with proxy protocol turned on.
|
- Automatic Traefik ingress controller attached to a Hetzner load balancer with proxy protocol turned on.
|
||||||
- (Optional) Out of the box config of Traefik with SSL certficate auto-generation.
|
- Tons of flexible configuration options to suits all needs.
|
||||||
|
|
||||||
_It uses Terraform to deploy as it's easy to use, and Hetzner provides a great [Hetzner Terraform Provider](https://registry.terraform.io/providers/hetznercloud/hcloud/latest/docs)._
|
_It uses Terraform to deploy as it's easy to use, and Hetzner provides a great [Hetzner Terraform Provider](https://registry.terraform.io/providers/hetznercloud/hcloud/latest/docs)._
|
||||||
|
|
||||||
@ -178,6 +178,24 @@ agent_nodepools = []
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
|
||||||
|
<summary>Use as Terraform module</summary>
|
||||||
|
|
||||||
|
It is easy to use Kube-Hetzner as a Terraform module. To do so:
|
||||||
|
|
||||||
|
1. Clone it on your localhost.
|
||||||
|
2. Declare a module, with the name of your choice, and choose `kube-hetzner` as its source.
|
||||||
|
3. Copy your `terraform.tfvars` file to the module directory.
|
||||||
|
|
||||||
|
``` terraform
|
||||||
|
module "kh" {
|
||||||
|
source = "./kube-hetzner"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
## Debugging
|
## Debugging
|
||||||
|
|
||||||
First and foremost, it depends, but it's always good to have a quick look into Hetzner quickly without having to login to the UI. That is where the `hcloud` cli comes in.
|
First and foremost, it depends, but it's always good to have a quick look into Hetzner quickly without having to login to the UI. That is where the `hcloud` cli comes in.
|
||||||
|
Loading…
Reference in New Issue
Block a user