ExternalName service type in Kubernetes - Mini Project: Build & Apply

Using ExternalName Service Type in Kubernetes

📖 Scenario: You are managing a Kubernetes cluster that needs to access an external database hosted outside the cluster. Instead of hardcoding the external database address in your application, you want to create a Kubernetes Service of type ExternalName to map a service name inside the cluster to the external database's DNS name.

🎯 Goal: Create a Kubernetes Service of type ExternalName that points to the external database's DNS name db.example.com. This will allow pods inside the cluster to access the external database using the service name external-db.

📋 What You'll Learn

Create a YAML manifest for a Kubernetes Service named external-db.

Set the Service type to ExternalName.

Set the externalName field to db.example.com.

Verify the Service is created correctly and points to the external DNS.

💡 Why This Matters

🌍 Real World

ExternalName Services are used to connect Kubernetes workloads to external systems like databases, APIs, or legacy services without exposing IP addresses directly.

💼 Career

Understanding ExternalName Services helps DevOps engineers integrate Kubernetes clusters with external infrastructure securely and cleanly.

1

Create the basic Service manifest skeleton

Create a YAML manifest with apiVersion set to v1, kind set to Service, and metadata.name set to external-db.

Kubernetes

apiVersion: v1
kind: Service
metadata:
  name: external-db
# Your code here

Hint

Start by defining the API version, kind, and metadata name for the Service.

2

Add the Service type as ExternalName

Add a spec section with type set to ExternalName in the YAML manifest.

Kubernetes

apiVersion: v1
kind: Service
metadata:
  name: external-db
spec:
  # Set the service type here
  # Your code here

Hint

The spec section defines the behavior of the Service. Set type to ExternalName to map to an external DNS.

3

Set the externalName to the external DNS

Under spec, add the externalName field and set it to db.example.com.

Kubernetes

apiVersion: v1
kind: Service
metadata:
  name: external-db
spec:
  type: ExternalName
  # Set the externalName here
  # Your code here

Hint

The externalName field tells Kubernetes which external DNS name this Service should point to.

4

Verify the ExternalName Service

Run kubectl get service external-db -o yaml to display the Service details and verify the externalName is set to db.example.com.

Kubernetes

apiVersion: v1
kind: Service
metadata:
  name: external-db
spec:
  type: ExternalName
  externalName: db.example.com
# Run the verification command below
# Your code here

Hint

Use kubectl get service external-db -o yaml to check the Service configuration.

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