hetznercloud / hcloud-cloud-controller-manager

Kubernetes cloud-controller-manager for Hetzner Cloud
Apache License 2.0
695 stars 109 forks source link

Better documentation about environment variables #202

Open process0 opened 3 years ago

process0 commented 3 years ago

Took a minute to figure out i needed to specify HCLOUD_NETWORK in the Deployment environment variables. Are these variables socumented somewhere that I missed? Also would it make more sense to store all of them in a Secret along with the token?

const (
    hcloudTokenENVVar                        = "HCLOUD_TOKEN"
    hcloudEndpointENVVar                     = "HCLOUD_ENDPOINT"
    hcloudNetworkENVVar                      = "HCLOUD_NETWORK"
    hcloudDebugENVVar                        = "HCLOUD_DEBUG"
    hcloudLoadBalancersEnabledENVVar         = "HCLOUD_LOAD_BALANCERS_ENABLED"
    hcloudLoadBalancersLocation              = "HCLOUD_LOAD_BALANCERS_LOCATION"
    hcloudLoadBalancersNetworkZone           = "HCLOUD_LOAD_BALANCERS_NETWORK_ZONE"
    hcloudLoadBalancersDisablePrivateIngress = "HCLOUD_LOAD_BALANCERS_DISABLE_PRIVATE_INGRESS"
    hcloudLoadBalancersUsePrivateIP          = "HCLOUD_LOAD_BALANCERS_USE_PRIVATE_IP"
    nodeNameENVVar                           = "NODE_NAME"
    providerName                             = "hcloud"
    providerVersion                          = "v1.9.1"
)
LKaemmerling commented 3 years ago

Hey @process0,

when you use our deployment files those ENV variables are already in there. https://github.com/hetznercloud/hcloud-cloud-controller-manager/blob/master/deploy/ccm-networks.yaml.tmpl#L86 (Used when you follow our docs: https://github.com/hetznercloud/hcloud-cloud-controller-manager/blob/master/docs/deploy_with_networks.md)

But you are right, we will improve the documentation of our Environment variables here.

LKaemmerling commented 3 years ago

Removing the staleness,we still want and need to improve this.

LKaemmerling commented 2 years ago

Removing the staleness,we still want and need to improve this.

github-actions[bot] commented 2 years ago

This issue has been marked as stale because it has not had recent activity. The bot will close the issue if no further action occurs.

mrclrchtr commented 11 months ago

It's still not improved right?