Skip to content

phvalguima/charm-kubernetes-worker

 
 

Repository files navigation

Kubernetes Worker

Usage

This charm deploys a container runtime, and additionally stands up the Kubernetes worker applications: kubelet, and kube-proxy.

In order for this charm to be useful, it should be deployed with its companion charm kubernetes-master and linked with an SDN-Plugin and a container runtime such as containerd.

This charm has also been bundled up for your convenience so you can skip the above steps, and deploy it with a single command:

juju deploy charmed-kubernetes

For more information about Charmed Kubernetes consult the bundle README.md file.

Scale out

To add additional compute capacity to your Kubernetes workers, you may juju add-unit scale the cluster of applications. They will automatically join any related kubernetes-master, and enlist themselves as ready once the deployment is complete.

Snap Configuration

The kubernetes resources used by this charm are snap packages. When not specified during deployment, these resources come from the public store. By default, the snapd daemon will refresh all snaps installed from the store four (4) times per day. A charm configuration option is provided for operators to control this refresh frequency.

NOTE: this is a global configuration option and will affect the refresh time for all snaps installed on a system.

Examples:

## refresh kubernetes-worker snaps every tuesday
juju config kubernetes-worker snapd_refresh="tue"

## refresh snaps at 11pm on the last (5th) friday of the month
juju config kubernetes-worker snapd_refresh="fri5,23:00"

## delay the refresh as long as possible
juju config kubernetes-worker snapd_refresh="max"

## use the system default refresh timer
juju config kubernetes-worker snapd_refresh=""

For more information on the possible values for snapd_refresh, see the refresh.timer section in the system options documentation.

Operational actions

The kubernetes-worker charm supports the following Operational Actions:

Pause

Pausing the workload enables administrators to both drain and cordon a unit for maintenance.

Resume

Resuming the workload will uncordon a paused unit. Workloads will automatically migrate unless otherwise directed via their application declaration.

Private registry

This charm supports the docker-registry interface, which can automatically configure docker on the kubernetes-worker to communicate with a deployed docker-registry charm.

Example usage

Deploy and relate docker-registry to kubernetes-worker, with optional basic auth and TLS enabled:

juju deploy ~containers/docker-registry
juju config docker-registry auth-basic-user=YOUR_USER auth-basic-password=YOUR_PASSWORD

juju relate docker-registry easyrsa
juju relate kubernetes-worker:docker-registry docker-registry:docker-registry

Configure kubernetes-worker to use images pushed to the docker-registry charm:

juju config kubernetes-worker default-backend-image=YOUR_REGISTRY/defaultbackend-amd64:1.5

Learn more about the docker-registry capabilities at docker-registry.

Known Limitations

Kubernetes workers will try to spread load across any presented IP addresses, but a single worker will only ever try to connect to a single IP. If HA is desired, a solution such as HACluster is recommended. HACluster can be related to the kubeapi-load-balancer or directly to the kubernetes-master if no load balancing is necessary. If you have your own external virtual IP or load balancer, set the IP address in the configuration parameter named loadbalancer-ips on the master charm.

External access to pods can be performed through a Kubernetes Ingress Resource.

When using NodePort type networking, there is no automation in exposing the ports selected by kubernetes or chosen by the user. They will need to be opened manually and can be performed across an entire worker pool.

If your NodePort service port selected is 30510 you can open this across all members of a worker pool named kubernetes-worker like so:

juju run --application kubernetes-worker open-port 30510/tcp

Don't forget to expose the kubernetes-worker application if its not already exposed, as this can cause confusion once the port has been opened and the service is not reachable.

Note: When debugging connection issues with NodePort services, its important to first check the kube-proxy service on the worker units. If kube-proxy is not running, the associated port-mapping will not be configured in the iptables rulechains.

If you need to close the NodePort once a workload has been terminated, you can follow the same steps inversely.

juju run --application kubernetes-worker close-port 30510

Releases

No releases published

Packages

No packages published

Languages

  • Python 94.8%
  • Shell 5.2%