Kubermatic Addons

Addons are specific services and tools extending the functionality of Kubernetes.

Default Addons

Default addons are installed in each user-cluster in Kubermatic. The default addons are:

  • Canal: policy based networking for cloud native applications
  • Dashboard: General-purpose web UI for Kubernetes clusters
  • DNS: Kubernetes DNS service
  • kube-proxy: Kubernetes network proxy
  • rbac: Kubernetes Role-Based Access Control, needed for TLS node bootstrapping
  • OpenVPN client: virtual private network (VPN). Lets the control plan access the Pod & Service network. Required for functionality like kubectl proxy & kubectl port-forward.
  • default-storage-class: A cloud provider specific StorageClass
  • kubelet-configmap: A set of ConfigMaps used by kubeadm

Installation and configuration of these addons is done by 2 controllers which are part of the Kubermatic controller-manager:

  • addon-installer-controller: Ensures a given set of addons will be installed in all clusters
  • addon-controller: Templates the addons & applies the manifests in the user clusters

Configuration

To configure which addons shall be installed in all user clusters, set the following settings in the values.yaml for the kubermatic chart:

kubermatic:
  controller:
    addons:
      kubernetes:
        defaultAddons:
        - canal
        - dashboard
        - dns
        - kube-proxy
        - openvpn
        - rbac
        - kubelet-configmap
        - default-storage-class
        image:
          repository: "quay.io/kubermatic/addons"
          tag: "v0.2.9"
          pullPolicy: "IfNotPresent"

To deploy the changes:

helm upgrade --install --wait --timeout 300 --values values.yaml --namespace kubermatic kubermatic charts/kubermatic
Setting a Custom Docker Registry

In case you want to set a custom registry for all addons, you can specify the -overwrideRegistry flag on the kubermatic-controller-manager or via the helm setting kubermatic.controller.overwriteRegistry. It will set the specified registry on all control plane components & addons.

Accessible Addons

Accessible addons can be installed in each user-cluster in Kubermatic on user demand. If an addon is both default and accessible, then it will be installed in the user-cluster, but also be visible to the user, who can manage it from the UI like the other accessible addons. The accessible addons are:

Accessible addons can be managed in the UI from the cluster details view:

View

Configuration

To configure which addons shall be accessible, set the following settings in the values.yaml for the Kubermatic chart:

kubermatic:
  api:
    # List of optional addons that can be installed into every user-cluster. All need to exist in the addons image.
    accessibleAddons:
    - node-exporter

Accessible addons are configured by the AddonConfig custom resources with the same names as the addons that are configured. The configuration is not required, but it is recommended. Each config should contain logo and description. Form specification of addon variables is optional. Here is an example of node-exporter config:

apiVersion: kubermatic.k8s.io/v1
kind: AddonConfig
metadata:
  name: node-exporter
spec:
  description: "The Prometheus Node Exporter exposes a wide variety of hardware- and kernel-related metrics."
  logoFormat: "svg+xml"
  logo: "<svg width="166" height="40" viewBox="0 0 166 40" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M19.9124 5.17554C11.6768 5.17554 5 11.8516 5 20.0874C5 28.3229 11.6768 34.9995 19.9124 34.9995C28.1479 34.9995 34.8245 28.3229 34.8245 20.0874C34.8245 11.8516 28.1476 5.17554 19.9124 5.17554V5.17554ZM19.9124 33.0847C17.5692 33.0847 15.6695 31.5195 15.6695 29.5892H24.1553C24.1553 31.5192 22.2555 33.0847 19.9124 33.0847ZM26.9203 28.4316H12.9037V25.89H26.9205V28.4316H26.9203ZM26.87 24.5819H12.9437C12.8974 24.5284 12.85 24.4758 12.8053 24.4216C11.3705 22.6795 11.0326 21.77 10.7045 20.8432C10.6989 20.8126 12.4442 21.1997 13.6818 21.4782C13.6818 21.4782 14.3187 21.6255 15.2497 21.7953C14.3558 20.7474 13.825 19.4153 13.825 18.0537C13.825 15.0645 16.1176 12.4524 15.2905 10.3411C16.0955 10.4066 16.9566 12.04 17.0147 14.594C17.8705 13.4113 18.2287 11.2516 18.2287 9.92738C18.2287 8.55633 19.1321 6.9637 20.0358 6.90922C19.2303 8.23685 20.2445 9.37501 21.1461 12.1984C21.4842 13.259 21.4411 15.0437 21.7021 16.1755C21.7887 13.8247 22.1929 10.3947 23.6842 9.21054C23.0263 10.7019 23.7816 12.5679 24.2982 13.465C25.1316 14.9124 25.6368 16.009 25.6368 18.0829C25.6368 19.4734 25.1234 20.7826 24.2574 21.8061C25.2421 21.6213 25.9221 21.4547 25.9221 21.4547L29.12 20.8308C29.1203 20.8305 28.6555 22.7416 26.87 24.5819Z" fill="#E6522C"/>
<path d="M57.3203 27H55.624L49.1816 17.1387V27H47.4854V14.2031H49.1816L55.6416 24.1084V14.2031H57.3203V27Z" fill="black"/>
<path d="M59.6318 22.1572C59.6318 21.2256 59.8135 20.3877 60.1768 19.6436C60.5459 18.8994 61.0557 18.3252 61.7061 17.9209C62.3623 17.5166 63.1094 17.3145 63.9473 17.3145C65.2422 17.3145 66.2881 17.7627 67.085 18.6592C67.8877 19.5557 68.2891 20.748 68.2891 22.2363V22.3506C68.2891 23.2764 68.1104 24.1084 67.7529 24.8467C67.4014 25.5791 66.8945 26.1504 66.2324 26.5605C65.5762 26.9707 64.8203 27.1758 63.9648 27.1758C62.6758 27.1758 61.6299 26.7275 60.8271 25.8311C60.0303 24.9346 59.6318 23.748 59.6318 22.2715V22.1572ZM61.2666 22.3506C61.2666 23.4053 61.5098 24.252 61.9961 24.8906C62.4883 25.5293 63.1445 25.8486 63.9648 25.8486C64.791 25.8486 65.4473 25.5264 65.9336 24.8818C66.4199 24.2314 66.6631 23.3232 66.6631 22.1572C66.6631 21.1143 66.4141 20.2705 65.916 19.626C65.4238 18.9756 64.7676 18.6504 63.9473 18.6504C63.1445 18.6504 62.4971 18.9697 62.0049 19.6084C61.5127 20.2471 61.2666 21.1611 61.2666 22.3506Z" fill="black"/>
<path d="M69.9326 22.166C69.9326 20.707 70.2783 19.5352 70.9697 18.6504C71.6611 17.7598 72.5664 17.3145 73.6855 17.3145C74.7988 17.3145 75.6807 17.6953 76.3311 18.457V13.5H77.957V27H76.4629L76.3838 25.9805C75.7334 26.7773 74.8281 27.1758 73.668 27.1758C72.5664 27.1758 71.667 26.7246 70.9697 25.8223C70.2783 24.9199 69.9326 23.7422 69.9326 22.2891V22.166ZM71.5586 22.3506C71.5586 23.4287 71.7812 24.2725 72.2266 24.8818C72.6719 25.4912 73.2871 25.7959 74.0723 25.7959C75.1035 25.7959 75.8564 25.333 76.3311 24.4072V20.0391C75.8447 19.1426 75.0977 18.6943 74.0898 18.6943C73.293 18.6943 72.6719 19.002 72.2266 19.6172C71.7812 20.2324 71.5586 21.1436 71.5586 22.3506Z" fill="black"/>
<path d="M84.4346 27.1758C83.1455 27.1758 82.0967 26.7539 81.2881 25.9102C80.4795 25.0605 80.0752 23.9268 80.0752 22.5088V22.21C80.0752 21.2666 80.2539 20.4258 80.6113 19.6875C80.9746 18.9434 81.4785 18.3633 82.123 17.9473C82.7734 17.5254 83.4766 17.3145 84.2324 17.3145C85.4688 17.3145 86.4297 17.7217 87.1152 18.5361C87.8008 19.3506 88.1436 20.5166 88.1436 22.0342V22.7109H81.7012C81.7246 23.6484 81.9971 24.4072 82.5186 24.9873C83.0459 25.5615 83.7139 25.8486 84.5225 25.8486C85.0967 25.8486 85.583 25.7314 85.9814 25.4971C86.3799 25.2627 86.7285 24.9521 87.0273 24.5654L88.0205 25.3389C87.2236 26.5635 86.0283 27.1758 84.4346 27.1758ZM84.2324 18.6504C83.5762 18.6504 83.0254 18.8906 82.5801 19.3711C82.1348 19.8457 81.8594 20.5137 81.7539 21.375H86.5176V21.252C86.4707 20.4258 86.248 19.7871 85.8496 19.3359C85.4512 18.8789 84.9121 18.6504 84.2324 18.6504Z" fill="black"/>
<path d="M101.986 21.085H96.4404V25.6201H102.883V27H94.7529V14.2031H102.795V15.5918H96.4404V19.7051H101.986V21.085Z" fill="black"/>
<path d="M107.919 20.9619L110.028 17.4902H111.927L108.815 22.1924L112.023 27H110.143L107.945 23.4404L105.748 27H103.858L107.066 22.1924L103.955 17.4902H105.836L107.919 20.9619Z" fill="black"/>
<path d="M121.691 22.3506C121.691 23.7979 121.36 24.9639 120.698 25.8486C120.036 26.7334 119.14 27.1758 118.009 27.1758C116.854 27.1758 115.946 26.8096 115.284 26.0771V30.6562H113.658V17.4902H115.144L115.223 18.5449C115.885 17.7246 116.805 17.3145 117.982 17.3145C119.125 17.3145 120.027 17.7451 120.689 18.6064C121.357 19.4678 121.691 20.666 121.691 22.2012V22.3506ZM120.065 22.166C120.065 21.0938 119.837 20.2471 119.38 19.626C118.923 19.0049 118.296 18.6943 117.499 18.6943C116.515 18.6943 115.776 19.1309 115.284 20.0039V24.5479C115.771 25.415 116.515 25.8486 117.517 25.8486C118.296 25.8486 118.914 25.541 119.371 24.9258C119.834 24.3047 120.065 23.3848 120.065 22.166Z" fill="black"/>
<path d="M123.335 22.1572C123.335 21.2256 123.517 20.3877 123.88 19.6436C124.249 18.8994 124.759 18.3252 125.409 17.9209C126.065 17.5166 126.812 17.3145 127.65 17.3145C128.945 17.3145 129.991 17.7627 130.788 18.6592C131.591 19.5557 131.992 20.748 131.992 22.2363V22.3506C131.992 23.2764 131.813 24.1084 131.456 24.8467C131.104 25.5791 130.598 26.1504 129.936 26.5605C129.279 26.9707 128.523 27.1758 127.668 27.1758C126.379 27.1758 125.333 26.7275 124.53 25.8311C123.733 24.9346 123.335 23.748 123.335 22.2715V22.1572ZM124.97 22.3506C124.97 23.4053 125.213 24.252 125.699 24.8906C126.191 25.5293 126.848 25.8486 127.668 25.8486C128.494 25.8486 129.15 25.5264 129.637 24.8818C130.123 24.2314 130.366 23.3232 130.366 22.1572C130.366 21.1143 130.117 20.2705 129.619 19.626C129.127 18.9756 128.471 18.6504 127.65 18.6504C126.848 18.6504 126.2 18.9697 125.708 19.6084C125.216 20.2471 124.97 21.1611 124.97 22.3506Z" fill="black"/>
<path d="M138.628 18.9492C138.382 18.9082 138.115 18.8877 137.828 18.8877C136.762 18.8877 136.038 19.3418 135.657 20.25V27H134.031V17.4902H135.613L135.64 18.5889C136.173 17.7393 136.929 17.3145 137.907 17.3145C138.224 17.3145 138.464 17.3555 138.628 17.4375V18.9492Z" fill="black"/>
<path d="M142.776 15.1875V17.4902H144.552V18.7471H142.776V24.6445C142.776 25.0254 142.855 25.3125 143.014 25.5059C143.172 25.6934 143.441 25.7871 143.822 25.7871C144.01 25.7871 144.268 25.752 144.596 25.6816V27C144.168 27.1172 143.752 27.1758 143.348 27.1758C142.621 27.1758 142.073 26.9561 141.704 26.5166C141.335 26.0771 141.15 25.4531 141.15 24.6445V18.7471H139.419V17.4902H141.15V15.1875H142.776Z" fill="black"/>
<path d="M150.405 27.1758C149.116 27.1758 148.067 26.7539 147.259 25.9102C146.45 25.0605 146.046 23.9268 146.046 22.5088V22.21C146.046 21.2666 146.225 20.4258 146.582 19.6875C146.945 18.9434 147.449 18.3633 148.094 17.9473C148.744 17.5254 149.447 17.3145 150.203 17.3145C151.439 17.3145 152.4 17.7217 153.086 18.5361C153.771 19.3506 154.114 20.5166 154.114 22.0342V22.7109H147.672C147.695 23.6484 147.968 24.4072 148.489 24.9873C149.017 25.5615 149.685 25.8486 150.493 25.8486C151.067 25.8486 151.554 25.7314 151.952 25.4971C152.351 25.2627 152.699 24.9521 152.998 24.5654L153.991 25.3389C153.194 26.5635 151.999 27.1758 150.405 27.1758ZM150.203 18.6504C149.547 18.6504 148.996 18.8906 148.551 19.3711C148.105 19.8457 147.83 20.5137 147.725 21.375H152.488V21.252C152.441 20.4258 152.219 19.7871 151.82 19.3359C151.422 18.8789 150.883 18.6504 150.203 18.6504Z" fill="black"/>
<path d="M160.601 18.9492C160.354 18.9082 160.088 18.8877 159.801 18.8877C158.734 18.8877 158.011 19.3418 157.63 20.25V27H156.004V17.4902H157.586L157.612 18.5889C158.146 17.7393 158.901 17.3145 159.88 17.3145C160.196 17.3145 160.437 17.3555 160.601 17.4375V18.9492Z" fill="black"/>
</svg>
"
  formSpec:
    - displayName: Replicas
      internalName: replicas
      required: true
      type: number
    - displayName: Description
      internalName: desc
      required: false
      type: text
    - displayName: Debug
      internalName: debug
      required: false
      type: boolean
    - displayName: Spec
      internalName: spec
      required: false
      type: text-area

After applying above config the UI should look like below:

Form

How to Add a Custom Addon?

  1. All manifests and config files for the default addons are stored in the quay.io/kubermatic/addons image. Use this image as a base image and copy configs and manifests for all custom addons to /addons folder.

    Custom addon with manifest

    .
    ├── Dockerfile
    └── foo
        └── deployment.yaml
    

    Dockerfile for custom addons:

    FROM quay.io/kubermatic/addons:v0.0.1
    
    ADD ./ /addons/
    

    Release the image with custom addon

    export TAG=v1.0
    docker build -t customer/addons:${TAG} .
    docker push customer/addons:${TAG}
    
  2. Edit values.yaml you are using for the installation of Kubermatic. Change the path to the addons repository

    kubermatic:
      controller:
        addons:
          kubernetes:
            image:
              repository: "quay.io/customer/addons" # <-- add your repo here
    
  3. Add your addon to the list of default addons in values.yaml:

    kubermatic:
      controller:
        addons:
          kubernetes:
            # list of addons to install into every user-cluster. All need to exist in the addons image
            defaultAddons:
            - foo # <-- add your addon here
            - canal
            - dashboard
            - dns
            - kube-proxy
            - openvpn
            - rbac
    
  4. Update the installation of Kubermatic

    helm upgrade --install --wait --timeout 300 --values values.yaml --namespace kubermatic kubermatic charts/kubermatic
    

Template Variables

All cluster object variables can be used in all addon manifests. Specific template variables and functions used in default templates:

  • {{first .Cluster.Spec.ClusterNetwork.Pods.CIDRBlocks}}: will render an IP block of the cluster
  • {{.DNSClusterIP}}: will render the IP address of the DNS server
  • image: {{ Registry quay.io }}/some-org/some-app:v1.0: Will use quay.io as registry or the overwrite registry if specified