Ingress annotations for customization in Kubernetes - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to add an annotation that sets the ingress class to nginx.

Kubernetes

metadata:
  annotations:
    kubernetes.io/ingress.class: [1]

Drag options to blanks, or click blank then click option'

Anginx

Bapache

Cistio

Dhaproxy

Attempts:

3 left

💡 Hint

Common Mistakes

Using the wrong ingress class name like 'apache' or 'istio'.

Forgetting to add the annotation under metadata.

The annotation kubernetes.io/ingress.class with value nginx tells Kubernetes to use the NGINX ingress controller for this ingress resource.

2fill in blank

medium

Complete the code to add an annotation that enables SSL redirect for the ingress.

Kubernetes

metadata:
  annotations:
    nginx.ingress.kubernetes.io/[1]: "true"

Drag options to blanks, or click blank then click option'

Assl-passthrough

Bforce-ssl

Cssl-redirect

Denable-ssl

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'ssl-passthrough' which is different and disables redirect.

Misspelling the annotation key.

The annotation nginx.ingress.kubernetes.io/ssl-redirect set to true tells the NGINX ingress controller to redirect HTTP traffic to HTTPS.

3fill in blank

hard

Fix the error in the annotation key to correctly set the rewrite target.

Kubernetes

metadata:
  annotations:
    nginx.ingress.kubernetes.io/[1]: "/"

Drag options to blanks, or click blank then click option'

Arewrite_target

Brewrite-target

CrewriteTarget

Drewrite-targets

Attempts:

3 left

💡 Hint

Common Mistakes

Using underscores instead of hyphens.

Using camelCase instead of hyphenated lowercase.

The correct annotation key to set the rewrite target is nginx.ingress.kubernetes.io/rewrite-target. It uses hyphens, not underscores or camelCase.

4fill in blank

hard

Fill both blanks to add annotations that enable gzip compression and set a custom proxy body size limit.

Kubernetes

metadata:
  annotations:
    nginx.ingress.kubernetes.io/[1]: "true"
    nginx.ingress.kubernetes.io/[2]: "10m"

Drag options to blanks, or click blank then click option'

Aenable-gzip

Bproxy-body-size

Cproxy-body-size-limit

Dgzip

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'enable-gzip' instead of 'gzip'.

Using 'proxy-body-size-limit' which is not a valid annotation.

The annotation nginx.ingress.kubernetes.io/gzip enables gzip compression. The annotation nginx.ingress.kubernetes.io/proxy-body-size sets the maximum allowed size of the client request body.

5fill in blank

hard

Fill all three blanks to add annotations that set a custom client max body size, enable rewrite, and disable SSL redirect.

Kubernetes

metadata:
  annotations:
    nginx.ingress.kubernetes.io/[1]: "5m"
    nginx.ingress.kubernetes.io/[2]: "/newpath"
    nginx.ingress.kubernetes.io/[3]: "false"

Drag options to blanks, or click blank then click option'

Aclient-max-body-size

Brewrite-target

Cssl-redirect

Dproxy-body-size

Attempts:

3 left

💡 Hint

Common Mistakes

Confusing 'client-max-body-size' with 'proxy-body-size'.

Setting 'ssl-redirect' to true instead of false.

Using wrong annotation keys or misspelling.

The annotation proxy-body-size sets the max client body size. rewrite-target sets the path to rewrite to. ssl-redirect set to false disables automatic HTTP to HTTPS redirect.

Practice

1. What is the main purpose of using annotations in a Kubernetes Ingress resource?

easy

A. To specify the IP address of the Ingress controller

B. To define the backend services for routing traffic

C. To customize the behavior of the Ingress controller without changing the main spec

D. To set resource limits for the Ingress pod

Solution

1. Step 1: Understand the role of annotations in Kubernetes

   Annotations are key-value pairs used to add metadata or customize behavior without changing the main resource spec.

2. Step 2: Apply this to Ingress resources

   In Ingress, annotations allow customization of controller behavior like SSL settings or rewrite rules without modifying the core routing rules.

3. Final Answer:

   To customize the behavior of the Ingress controller without changing the main spec -> Option C

4. Quick Check:

   Ingress annotations = customization without spec change [OK]

Hint: Annotations customize Ingress behavior without touching main config [OK]

Common Mistakes:

• Confusing annotations with service definitions
• Thinking annotations set IP addresses
• Assuming annotations control pod resources

2. Which of the following is the correct syntax to add an annotation for enabling SSL redirect in a Kubernetes Ingress YAML?

easy

A. metadata:
annotations:
nginx.ingress.kubernetes.io/ssl-redirect: "true"

B. spec:
annotations:
ssl-redirect: true

C. metadata:
labels:
nginx.ingress.kubernetes.io/ssl-redirect: true

D. annotations:
ssl-redirect: "true"

Solution

1. Step 1: Locate where annotations belong in Ingress YAML

   Annotations must be under metadata.annotations as key-value pairs.

2. Step 2: Check correct key and value format

   The key for SSL redirect in nginx ingress is nginx.ingress.kubernetes.io/ssl-redirect and the value should be a string "true".

3. Final Answer:

   metadata: annotations: nginx.ingress.kubernetes.io/ssl-redirect: "true" -> Option A

4. Quick Check:

   Annotations under metadata.annotations with string values [OK]

Hint: Annotations go under metadata.annotations as string key-values [OK]

Common Mistakes:

• Placing annotations under spec instead of metadata
• Using labels instead of annotations
• Using boolean true instead of string "true"

3. Given this Ingress snippet with annotations:

metadata:
  annotations:
    nginx.ingress.kubernetes.io/rewrite-target: "/"
    nginx.ingress.kubernetes.io/ssl-redirect: "false"

What will be the effect on incoming HTTP requests?

medium

A. Requests will be redirected to HTTPS and paths rewritten to root

B. Requests will not redirect to HTTPS and paths will be rewritten to root

C. Requests will redirect to HTTPS but paths will not be rewritten

D. Requests will neither redirect to HTTPS nor rewrite paths

Solution

1. Step 1: Analyze the ssl-redirect annotation

   The annotation nginx.ingress.kubernetes.io/ssl-redirect: "false" disables automatic HTTP to HTTPS redirection.

2. Step 2: Analyze the rewrite-target annotation

   The annotation nginx.ingress.kubernetes.io/rewrite-target: "/" rewrites the path of incoming requests to root (/).

3. Final Answer:

   Requests will not redirect to HTTPS and paths will be rewritten to root -> Option B

4. Quick Check:

   ssl-redirect false disables HTTPS redirect; rewrite-target "/" rewrites paths [OK]

Hint: ssl-redirect false disables HTTPS redirect; rewrite-target changes path [OK]

Common Mistakes:

• Assuming ssl-redirect false still redirects
• Ignoring rewrite-target effect
• Confusing rewrite-target with redirect

4. You added this annotation to your Ingress:

nginx.ingress.kubernetes.io/ssl-redirect: true

But HTTPS redirection is not working. What is the most likely cause?

medium

A. The annotation value should be a string "true", not boolean true

B. The annotation must be under spec.annotations, not metadata.annotations

C. The Ingress controller does not support this annotation

D. You need to restart the Ingress controller pod

Solution

1. Step 1: Check annotation value type

   Annotations require string values, so boolean true is invalid and ignored.

2. Step 2: Confirm correct placement and support

   The annotation must be under metadata.annotations and nginx ingress supports this annotation.

3. Final Answer:

   The annotation value should be a string "true", not boolean true -> Option A

4. Quick Check:

   Annotation values must be strings, not booleans [OK]

Hint: Annotation values must be strings, not booleans [OK]

Common Mistakes:

• Placing annotations under spec instead of metadata
• Assuming controller restart fixes annotation issues
• Ignoring controller support for annotation

5. You want to customize your Ingress to add a custom header X-Frame-Options: DENY for security. Which annotation and value should you add to achieve this with nginx ingress controller?

hard

A. nginx.ingress.kubernetes.io/custom-header: "X-Frame-Options=DENY"

B. nginx.ingress.kubernetes.io/add-headers: "X-Frame-Options: DENY"

C. nginx.ingress.kubernetes.io/headers: "X-Frame-Options: DENY"

D. nginx.ingress.kubernetes.io/configuration-snippet: "more_set_headers \"X-Frame-Options: DENY\";"

Solution

1. Step 1: Identify how to add custom headers in nginx ingress

   The nginx ingress controller supports adding custom headers via the configuration-snippet annotation using nginx directives.

2. Step 2: Use the correct syntax for setting headers

   The directive more_set_headers "X-Frame-Options: DENY"; correctly adds the header.

3. Final Answer:

   nginx.ingress.kubernetes.io/configuration-snippet: "more_set_headers \"X-Frame-Options: DENY\";" -> Option D

4. Quick Check:

   Use configuration-snippet with more_set_headers for custom headers [OK]

Hint: Use configuration-snippet with nginx directive for custom headers [OK]

Common Mistakes:

• Using non-existent annotation keys
• Incorrect syntax for header setting
• Confusing add-headers with configuration-snippet