ExternalName service type in Kubernetes - Commands & Configuration

Introduction

Sometimes you want to access an external service using a Kubernetes service name. ExternalName service type lets you create a service inside Kubernetes that points to an external DNS name. This way, your apps can use the service name as if it was inside the cluster.

When you want to access a database hosted outside your Kubernetes cluster using a simple service name.

When you have a legacy service running outside Kubernetes but want to unify access through Kubernetes service names.

When you want to avoid changing application code that expects a service name, but the actual service is external.

When you want to route traffic to an external API or service using Kubernetes DNS.

When you want to simplify service discovery for external services in your cluster.

Config File - externalname-service.yaml

externalname-service.yaml

apiVersion: v1
kind: Service
metadata:
  name: external-db
  namespace: default
spec:
  type: ExternalName
  externalName: db.example.com

This file creates a Kubernetes Service named external-db in the default namespace.

The type: ExternalName tells Kubernetes this service points to an external DNS name.

The externalName: db.example.com is the external DNS address this service will resolve to.

Commands

This command creates the ExternalName service in Kubernetes so your cluster can resolve 'external-db' to 'db.example.com'.

Terminal

kubectl apply -f externalname-service.yaml

Expected Output

service/external-db created

This command verifies that the ExternalName service was created and shows its details.

Terminal

kubectl get service external-db

Expected Output

NAME          TYPE           CLUSTER-IP   EXTERNAL-IP     PORT(S)   AGE

external-db   ExternalName   <none>      db.example.com   <none>    10s

This command shows detailed information about the ExternalName service, including the external DNS it points to.

Terminal

kubectl describe service external-db

Expected Output

Name:                     external-db

Namespace:                default

Labels:                   <none>

Annotations:              <none>

Selector:                 <none>

Type:                     ExternalName

IP:                       <none>

ExternalName:             db.example.com

Session Affinity:         None

Events:                   <none>

Key Concept

If you remember nothing else from this pattern, remember: ExternalName services let you map a Kubernetes service name to an external DNS name for easy access inside the cluster.

Common Mistakes

Using ExternalName service type but specifying ports or selectors.

ExternalName services do not support ports or selectors because they only map to an external DNS name.

Do not include ports or selectors in the ExternalName service spec; only specify 'type: ExternalName' and 'externalName'.

Trying to use ExternalName service to route traffic to an IP address instead of a DNS name.

ExternalName requires a DNS name, not an IP address, because it works via DNS resolution.

Use a valid DNS name for 'externalName', not a raw IP address.

Summary

Create an ExternalName service YAML file specifying the external DNS name.

Apply the YAML file with kubectl to create the service in the cluster.

Verify the service exists and points to the external DNS using kubectl get and describe.

Practice

1. What is the main purpose of a Kubernetes ExternalName service?

easy

A. To map a service to an external DNS name outside the cluster

B. To expose a pod's IP address inside the cluster

C. To load balance traffic between pods

D. To create a persistent volume claim

Solution

1. Step 1: Understand ExternalName service role

   An ExternalName service maps a Kubernetes service to an external DNS name, allowing pods to access external services by a simple name.

2. Step 2: Compare with other service types

   Other service types like ClusterIP or LoadBalancer expose pods or balance traffic, but ExternalName specifically maps to external DNS.

3. Final Answer:

   To map a service to an external DNS name outside the cluster -> Option A

4. Quick Check:

   ExternalName = external DNS mapping [OK]

Hint: ExternalName points to DNS, not IP or pods [OK]

Common Mistakes:

• Confusing ExternalName with ClusterIP or LoadBalancer
• Thinking it manages pod IPs
• Assuming it handles ports inside the cluster

2. Which of the following is the correct minimal YAML snippet to create an ExternalName service named my-external pointing to example.com?

easy

A. apiVersion: v1\nkind: Service\nmetadata:\n name: my-external\nspec:\n type: LoadBalancer\n externalName: example.com

B. apiVersion: v1\nkind: Service\nmetadata:\n name: my-external\nspec:\n type: ExternalName\n externalName: example.com

C. apiVersion: v1\nkind: Service\nmetadata:\n name: my-external\nspec:\n type: ExternalName\n clusterIP: example.com

D. apiVersion: v1\nkind: Service\nmetadata:\n name: my-external\nspec:\n type: ClusterIP\n externalName: example.com

Solution

1. Step 1: Identify correct service type and field

   ExternalName service requires type: ExternalName and externalName field with the DNS name.

2. Step 2: Check YAML correctness

   apiVersion: v1\nkind: Service\nmetadata:\n name: my-external\nspec:\n type: ExternalName\n externalName: example.com correctly sets type: ExternalName and externalName: example.com. Other options use wrong types or fields.

3. Final Answer:

   YAML with type ExternalName and externalName: example.com -> Option B

4. Quick Check:

   ExternalName YAML = type ExternalName + externalName field [OK]

Hint: ExternalName needs type and externalName fields exactly [OK]

Common Mistakes:

• Using ClusterIP or LoadBalancer instead of ExternalName
• Setting clusterIP instead of externalName
• Omitting the externalName field

3. Given this ExternalName service YAML:

apiVersion: v1
kind: Service
metadata:
  name: ext-service
spec:
  type: ExternalName
  externalName: api.example.com

What happens when a pod inside the cluster runs nslookup ext-service?

medium

A. It returns the cluster IP of ext-service

B. It returns the IP address of the pod running the service

C. It returns an error because ExternalName services have no IP

D. It returns the IP address of api.example.com

Solution

1. Step 1: Understand DNS resolution for ExternalName

   ExternalName services create a DNS CNAME record pointing to the externalName value, so queries resolve to that external DNS.

2. Step 2: Analyze nslookup behavior

   Running nslookup ext-service returns the IP address of api.example.com by resolving the CNAME.

3. Final Answer:

   It returns the IP address of api.example.com -> Option D

4. Quick Check:

   ExternalName DNS = external DNS IP [OK]

Hint: ExternalName returns external DNS IP on lookup [OK]

Common Mistakes:

• Expecting pod or cluster IP for ExternalName
• Thinking ExternalName has its own IP
• Assuming nslookup fails for ExternalName

4. You created this ExternalName service YAML:

apiVersion: v1
kind: Service
metadata:
  name: ext-svc
spec:
  type: ExternalName
  externalName: 123.45.67.89

Why does this configuration fail?

medium

A. externalName field is missing

B. type ExternalName cannot be used with metadata

C. externalName must be a DNS name, not an IP address

D. Service type must be ClusterIP for IP addresses

Solution

1. Step 1: Check externalName field requirements

   The externalName must be a valid DNS name, not an IP address.

2. Step 2: Identify error cause

   Using an IP address like 123.45.67.89 in externalName is invalid and causes failure.

3. Final Answer:

   externalName must be a DNS name, not an IP address -> Option C

4. Quick Check:

   externalName = DNS name only [OK]

Hint: externalName must be a DNS name, not IP [OK]

Common Mistakes:

• Using IP instead of DNS in externalName
• Confusing service type rules
• Omitting externalName field

5. You want pods in your cluster to access an external database at db.external.com using the service name external-db. You also want to ensure no IP or port is configured inside the cluster. Which is the best way to configure this?

hard

A. Create an ExternalName service named external-db with externalName: db.external.com

B. Create a ClusterIP service named external-db with selector matching database pods

C. Create a LoadBalancer service named external-db pointing to db.external.com IP

D. Create a NodePort service named external-db with targetPort set to database port

Solution

1. Step 1: Understand requirement for no IP or port inside cluster

   ExternalName service maps a service name to an external DNS without IP or port configuration inside the cluster.

2. Step 2: Match requirement with service types

   ClusterIP, LoadBalancer, and NodePort require IPs or ports inside the cluster, so they don't fit the requirement.

3. Final Answer:

   Create an ExternalName service named external-db with externalName: db.external.com -> Option A

4. Quick Check:

   ExternalName = external DNS, no IP/port config [OK]

Hint: Use ExternalName for external DNS without cluster IP/port [OK]

Common Mistakes:

• Using ClusterIP or LoadBalancer for external DNS
• Configuring ports inside the cluster unnecessarily
• Not using ExternalName for external services