HostnameGenerator

Uses: Kong Mesh

Defaults

Kong Mesh ships with default HostnameGenerator resources based on the control plane mode and storage type.

Local MeshService in Universal zone

The following resource is automatically created on a zone control plane running in Universal mode. It creates a hostname for each MeshService created in a zone. For example, for a MeshService named redis, Kong Mesh creates a redis.svc.mesh.local hostname.

apiVersion: kuma.io/v1alpha1
kind: HostnameGenerator
metadata:
  name: local-universal-mesh-service
  namespace: kong-mesh-system
spec:
  selector:
    meshService:
      matchLabels:
        kuma.io/origin: zone
  template: "{{ .DisplayName }}.svc.mesh.local"

Copied!

type: HostnameGenerator
name: local-universal-mesh-service
spec:
  selector:
    meshService:
      matchLabels:
        kuma.io/origin: zone
  template: "{{ .DisplayName }}.svc.mesh.local"

Copied!

Please adjust konnect_mesh_control_plane.my_meshcontrolplane.id and konnect_mesh.my_mesh.name according to your current configuration.

resource "konnect_hostname_generator" "local_universal_mesh_service" {
  provider = konnect-beta
  type = "HostnameGenerator"
  name = "local-universal-mesh-service"
  spec = {
    selector = {
      mesh_service = {
        match_labels = {
          kuma.io/origin = "zone"
        }
      }
    }
    template = "{{ .DisplayName }}.svc.mesh.local"
  }
  labels   = {
  "kuma.io/mesh" = konnect_mesh.my_mesh.name
  }
  cp_id    = konnect_mesh_control_plane.my_meshcontrolplane.id
  mesh     = konnect_mesh.my_mesh.name
}

Copied!

Local MeshExternalService

The following resource is automatically created on a zone control plane. It creates a hostname for each MeshExternalService created in a zone. For example, for a MeshExternalService named aurora, Kong Mesh creates a aurora.extsvc.mesh.local hostname.

apiVersion: kuma.io/v1alpha1
kind: HostnameGenerator
metadata:
  name: local-mesh-external-service
  namespace: kong-mesh-system
spec:
  selector:
    meshExternalService:
      matchLabels:
        kuma.io/origin: zone
  template: "{{ .DisplayName }}.extsvc.mesh.local"

Copied!

type: HostnameGenerator
name: local-mesh-external-service
spec:
  selector:
    meshExternalService:
      matchLabels:
        kuma.io/origin: zone
  template: "{{ .DisplayName }}.extsvc.mesh.local"

Copied!

Please adjust konnect_mesh_control_plane.my_meshcontrolplane.id and konnect_mesh.my_mesh.name according to your current configuration.

resource "konnect_hostname_generator" "local_mesh_external_service" {
  provider = konnect-beta
  type = "HostnameGenerator"
  name = "local-mesh-external-service"
  spec = {
    selector = {
      mesh_external_service = {
        match_labels = {
          kuma.io/origin = "zone"
        }
      }
    }
    template = "{{ .DisplayName }}.extsvc.mesh.local"
  }
  labels   = {
  "kuma.io/mesh" = konnect_mesh.my_mesh.name
  }
  cp_id    = konnect_mesh_control_plane.my_meshcontrolplane.id
  mesh     = konnect_mesh.my_mesh.name
}

Copied!

Synced MeshService from Kubernetes zone

The following resources are automatically created on a global control plane and synced to all zones.

The first creates a hostname for each MeshService synced from another Kubernetes zone. For example, for a MeshService named redis with the namespace redis-system from zone east, Kong Mesh creates a redis.redis-system.svc.east.mesh.local hostname.

apiVersion: kuma.io/v1alpha1
kind: HostnameGenerator
metadata:
  name: synced-kube-mesh-service
  namespace: kong-mesh-system
spec:
  selector:
    meshService:
      matchLabels:
        kuma.io/origin: global
        k8s.kuma.io/is-headless-service: false
        kuma.io/env: kubernetes
  template: "{{ .DisplayName }}.{{ .Namespace }}.svc.{{ .Zone }}.mesh.local"

Copied!

type: HostnameGenerator
name: synced-kube-mesh-service
spec:
  selector:
    meshService:
      matchLabels:
        kuma.io/origin: global
        k8s.kuma.io/is-headless-service: false
        kuma.io/env: kubernetes
  template: "{{ .DisplayName }}.{{ .Namespace }}.svc.{{ .Zone }}.mesh.local"

Copied!

Please adjust konnect_mesh_control_plane.my_meshcontrolplane.id and konnect_mesh.my_mesh.name according to your current configuration.

resource "konnect_hostname_generator" "synced_kube_mesh_service" {
  provider = konnect-beta
  type = "HostnameGenerator"
  name = "synced-kube-mesh-service"
  spec = {
    selector = {
      mesh_service = {
        match_labels = {
          kuma.io/origin = "global"
          k8s.kuma.io/is-headless-service = "false"
          kuma.io/env = "kubernetes"
        }
      }
    }
    template = "{{ .DisplayName }}.{{ .Namespace }}.svc.{{ .Zone }}.mesh.local"
  }
  labels   = {
  "kuma.io/mesh" = konnect_mesh.my_mesh.name
  }
  cp_id    = konnect_mesh_control_plane.my_meshcontrolplane.id
  mesh     = konnect_mesh.my_mesh.name
}

Copied!

The second creates a hostname for each MeshService synced from another Kubernetes zone that were created from a headless Service. For example, for a Pod redis-0 with MeshService named redis, with the namespace redis-system from zone east, Kong Mesh creates a redis-0.redis.redis-system.svc.east.mesh.local hostname.

apiVersion: kuma.io/v1alpha1
kind: HostnameGenerator
metadata:
  name: synced-headless-kube-mesh-service
  namespace: kong-mesh-system
spec:
  selector:
    meshService:
      matchLabels:
        kuma.io/origin: global
        k8s.kuma.io/is-headless-service: true
        kuma.io/env: kubernetes
  template: "{{ label 'statefulset.kubernetes.io/pod-name' }}.{{ label 'k8s.kuma.io/service-name'
    }}.{{ .Namespace }}.svc.{{ .Zone }}.mesh.local"

Copied!

type: HostnameGenerator
name: synced-headless-kube-mesh-service
spec:
  selector:
    meshService:
      matchLabels:
        kuma.io/origin: global
        k8s.kuma.io/is-headless-service: true
        kuma.io/env: kubernetes
  template: "{{ label 'statefulset.kubernetes.io/pod-name' }}.{{ label 'k8s.kuma.io/service-name'
    }}.{{ .Namespace }}.svc.{{ .Zone }}.mesh.local"

Copied!

Please adjust konnect_mesh_control_plane.my_meshcontrolplane.id and konnect_mesh.my_mesh.name according to your current configuration.

resource "konnect_hostname_generator" "synced_headless_kube_mesh_service" {
  provider = konnect-beta
  type = "HostnameGenerator"
  name = "synced-headless-kube-mesh-service"
  spec = {
    selector = {
      mesh_service = {
        match_labels = {
          kuma.io/origin = "global"
          k8s.kuma.io/is-headless-service = "true"
          kuma.io/env = "kubernetes"
        }
      }
    }
    template = "{{ label 'statefulset.kubernetes.io/pod-name' }}.{{ label 'k8s.kuma.io/service-name' }}.{{ .Namespace }}.svc.{{ .Zone }}.mesh.local"
  }
  labels   = {
  "kuma.io/mesh" = konnect_mesh.my_mesh.name
  }
  cp_id    = konnect_mesh_control_plane.my_meshcontrolplane.id
  mesh     = konnect_mesh.my_mesh.name
}

Copied!

Synced MeshService from Universal zone

The following policy is automatically created on a global control plane and synced to all zones. It creates a hostname for each MeshService synced from another Universal zone. For example, for a MeshService named redis from zone west, Kong Mesh creates a redis.svc.west.mesh.local hostname.

apiVersion: kuma.io/v1alpha1
kind: HostnameGenerator
metadata:
  name: synced-universal-mesh-service
  namespace: kong-mesh-system
spec:
  selector:
    meshService:
      matchLabels:
        kuma.io/origin: global
        kuma.io/env: universal
  template: "{{ .DisplayName }}.svc.{{ .Zone }}.mesh.local"

Copied!

type: HostnameGenerator
name: synced-universal-mesh-service
spec:
  selector:
    meshService:
      matchLabels:
        kuma.io/origin: global
        kuma.io/env: universal
  template: "{{ .DisplayName }}.svc.{{ .Zone }}.mesh.local"

Copied!

Please adjust konnect_mesh_control_plane.my_meshcontrolplane.id and konnect_mesh.my_mesh.name according to your current configuration.

resource "konnect_hostname_generator" "synced_universal_mesh_service" {
  provider = konnect-beta
  type = "HostnameGenerator"
  name = "synced-universal-mesh-service"
  spec = {
    selector = {
      mesh_service = {
        match_labels = {
          kuma.io/origin = "global"
          kuma.io/env = "universal"
        }
      }
    }
    template = "{{ .DisplayName }}.svc.{{ .Zone }}.mesh.local"
  }
  labels   = {
  "kuma.io/mesh" = konnect_mesh.my_mesh.name
  }
  cp_id    = konnect_mesh_control_plane.my_meshcontrolplane.id
  mesh     = konnect_mesh.my_mesh.name
}

Copied!

Synced MeshMultiZoneService from a global control plane

The following policy is automatically created on a global control plane and synced to all zones. It creates a hostname for each MeshMultiZoneService synced from a global control plane. For example, for a MeshMultiZoneService named redis, Kong Mesh creates a redis.mzsvc.mesh.local hostname:

apiVersion: kuma.io/v1alpha1
kind: HostnameGenerator
metadata:
  name: synced-mesh-multi-zone-service
  namespace: kong-mesh-system
spec:
  selector:
    meshMultiZoneService:
      matchLabels:
        kuma.io/origin: global
  template: "{{ .DisplayName }}.mzsvc.mesh.local"

Copied!

type: HostnameGenerator
name: synced-mesh-multi-zone-service
spec:
  selector:
    meshMultiZoneService:
      matchLabels:
        kuma.io/origin: global
  template: "{{ .DisplayName }}.mzsvc.mesh.local"

Copied!

Please adjust konnect_mesh_control_plane.my_meshcontrolplane.id and konnect_mesh.my_mesh.name according to your current configuration.

resource "konnect_hostname_generator" "synced_mesh_multi_zone_service" {
  provider = konnect-beta
  type = "HostnameGenerator"
  name = "synced-mesh-multi-zone-service"
  spec = {
    selector = {
      mesh_multi_zone_service = {
        match_labels = {
          kuma.io/origin = "global"
        }
      }
    }
    template = "{{ .DisplayName }}.mzsvc.mesh.local"
  }
  labels   = {
  "kuma.io/mesh" = konnect_mesh.my_mesh.name
  }
  cp_id    = konnect_mesh_control_plane.my_meshcontrolplane.id
  mesh     = konnect_mesh.my_mesh.name
}

Copied!

Synced MeshExternalService from a global control plane

The following policy is automatically created on a global control plane and synced to all zones. It creates a hostname for each MeshExternalService synced from a global control plane. For example, for a MeshExternalService named aurora, Kong Mesh creates a aurora.extsvc.mesh.local hostname.

apiVersion: kuma.io/v1alpha1
kind: HostnameGenerator
metadata:
  name: synced-mesh-external-service
  namespace: kong-mesh-system
spec:
  selector:
    meshExternalService:
      matchLabels:
        kuma.io/origin: global
  template: "{{ .DisplayName }}.extsvc.mesh.local"

Copied!

type: HostnameGenerator
name: synced-mesh-external-service
spec:
  selector:
    meshExternalService:
      matchLabels:
        kuma.io/origin: global
  template: "{{ .DisplayName }}.extsvc.mesh.local"

Copied!

Please adjust konnect_mesh_control_plane.my_meshcontrolplane.id and konnect_mesh.my_mesh.name according to your current configuration.

resource "konnect_hostname_generator" "synced_mesh_external_service" {
  provider = konnect-beta
  type = "HostnameGenerator"
  name = "synced-mesh-external-service"
  spec = {
    selector = {
      mesh_external_service = {
        match_labels = {
          kuma.io/origin = "global"
        }
      }
    }
    template = "{{ .DisplayName }}.extsvc.mesh.local"
  }
  labels   = {
  "kuma.io/mesh" = konnect_mesh.my_mesh.name
  }
  cp_id    = konnect_mesh_control_plane.my_meshcontrolplane.id
  mesh     = konnect_mesh.my_mesh.name
}

Copied!

Template

A template is a Golang text template. It runs with the function label to retrieve labels from the MeshService, MeshMultiZoneService, or MeshExternalService resources, as well as the following attributes:

.DisplayName: The name of the resource in its original zone.
.Namespace: The namespace of the resource in its original zone on Kubernetes
.Zone: The zone of the resource.
.Mesh: The mesh of the resource.

For example, with the following MeshService:

kind: MeshService
metadata:
  name: redis
  namespace: kuma-demo
  labels:
    kuma.io/mesh: products
    team: backend
    k8s.kuma.io/service-name: redis
    k8s.kuma.io/namespace: kuma-demo

Copied!

If you use the template "{{ .DisplayName }}.{{ .Namespace }}.{{ .Mesh }}.{{ label "team" }}.mesh.local", you would get the hostname redis.kuma-demo.products.backend.mesh.local.

The generated hostname points to the first VIP known for the MeshService.

Status

Every generated hostname is recorded under the MeshService resource’s status, in the addresses field:

status:
  addresses:
    - hostname: redis.kuma-demo.svc.east.mesh.local
      origin: HostnameGenerator
      hostnameGeneratorRef:
        coreName: synced-kube-mesh-service

Copied!

HostnameGenerator

Defaults

Local MeshService in Universal zone

Local MeshExternalService

Synced MeshService from Kubernetes zone

Synced MeshService from Universal zone

Synced MeshMultiZoneService from a global control plane

Synced MeshExternalService from a global control plane

Template

Status

Help us make these docs great!

Still need help