Your submission was sent successfully! Close

You have successfully unsubscribed! Close

kubeapi-load-balancer charm

Simple NGINX reverse proxy to lend a hand in HA kubernetes-master deployments.


name type Default Description
extra_packages string Space separated list of extra deb packages to install.
extra_sans string Space-separated list of extra SAN entries to add to the x509 certificate created for the load balancers.
ha-cluster-dns string DNS entry to use with the HA Cluster subordinate charm. Mutually exclusive with ha-cluster-vip.
ha-cluster-vip string Virtual IP for the charm to use with the HA Cluster subordinate charm Mutually exclusive with ha-cluster-dns. Multiple virtual IPs are separated by spaces.
host string listen address
install_keys string See notes
install_sources string See notes
loadbalancer-ips string See notes
nagios_context string juju See notes
nagios_servicegroups string A comma-separated list of nagios servicegroups. If left empty, the nagios_context will be used as the servicegroup
package_status string install The status of service-affecting packages will be set to this value in the dpkg database. Valid values are "install" and "hold".
port int 443 The port to run the loadbalancer
proxy_read_timeout int 600 Timeout in seconds for reading a response from proxy server.



List of signing keys for install_sources package sources, per charmhelpers standard format (a yaml list of strings encoded as a string). The keys should be the full ASCII armoured GPG public keys. While GPG key ids are also supported and looked up on a keyserver, operators should be aware that this mechanism is insecure. null can be used if a standard package signing key is used that will already be installed on the machine, and for PPA sources where the package signing key is securely retrieved from Launchpad.

Back to table



List of extra apt sources, per charm-helpers standard format (a yaml list of strings encoded as a string). Each source may be either a line that can be added directly to sources.list(5), or in the form ppa:/ for adding Personal Package Archives, or a distribution component to enable.

Back to table



Space seperated list of IP addresses of loadbalancers in front of control plane. A common case for this is virtual IP addresses that are floated in front of the kubeapi-load-balancer charm. The workers will alternate IP addresses from this list to distribute load. If you have 2 IPs and 4 workers, each IP will be used by 2 workers.

Back to table



Used by the nrpe subordinate charms. A string that will be prepended to instance name to set the host name in nagios. So for instance the hostname would be something like:


If you're running multiple environments with the same services in them this allows you to differentiate between them.

Back to table

Certificates and extra SANs

See the Certificates and trust documentation for an overview of certificate handling in Charmed Kubernetes.

For adding extra SANs and regenerating certificates, refer to the related documentation of the kubernetes-master charm

You can run an action with the following

juju run-action kubeapi-load-balancer ACTION [parameters] [--wait]


Collect debug data