Custom resources concept in Kubernetes - Commands & Configuration

Introduction

Sometimes Kubernetes does not have the exact resource type you need. Custom resources let you add your own resource types to extend Kubernetes with new features.

When you want to manage a new kind of application or service that Kubernetes does not support by default

When you need to store configuration or state specific to your application inside Kubernetes

When you want to build operators that automate tasks for your custom resource

When you want to create reusable APIs inside your Kubernetes cluster

When you want to integrate external systems with Kubernetes using custom resource definitions

Config File - my-crd.yaml

my-crd.yaml

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: widgets.example.com
spec:
  group: example.com
  versions:
    - name: v1
      served: true
      storage: true
      schema:
        openAPIV3Schema:
          type: object
          properties:
            spec:
              type: object
              properties:
                size:
                  type: string
                color:
                  type: string
  scope: Namespaced
  names:
    plural: widgets
    singular: widget
    kind: Widget
    shortNames:
      - wdgt

This file defines a new custom resource type called Widget in the example.com group.

apiVersion and kind specify this is a CustomResourceDefinition.

metadata.name is the full name of the resource type.

spec.group is the API group for the resource.

spec.versions lists the versions of this resource, with schema validation.

spec.scope means the resource is namespaced.

spec.names defines how to refer to this resource in commands and manifests.

Commands

This command creates the CustomResourceDefinition in the cluster, registering the new resource type.

Terminal

kubectl apply -f my-crd.yaml

Expected Output

customresourcedefinition.apiextensions.k8s.io/widgets.example.com created

This command verifies that the custom resource definition was created and is available.

Terminal

kubectl get crd widgets.example.com

Expected Output

NAME                    CREATED AT

widgets.example.com      2024-06-01T12:00:00Z

This command creates an instance of the custom resource Widget named my-widget with specified size and color.

Terminal

kubectl apply -f - <<EOF
apiVersion: example.com/v1
kind: Widget
metadata:
  name: my-widget
spec:
  size: large
  color: blue
EOF

Expected Output

widget.example.com/my-widget created

This command lists all Widget custom resources in the current namespace.

Terminal

kubectl get widgets

Expected Output

NAME        AGE

my-widget   10s

Key Concept

If you remember nothing else from this pattern, remember: Custom resources let you add new resource types to Kubernetes to manage your own application data.

Common Mistakes

Not applying the CustomResourceDefinition before creating custom resource instances

Kubernetes does not know about the new resource type yet, so it rejects the instance creation

Always apply the CRD manifest first and confirm it is created before creating custom resources

Using incorrect apiVersion or kind when creating custom resource instances

The API server will reject the resource because it does not match the registered CRD

Use the exact apiVersion and kind defined in the CRD for your custom resources

Summary

Create a CustomResourceDefinition YAML file to define your new resource type.

Apply the CRD to register the new resource type in Kubernetes.

Create instances of your custom resource using the new apiVersion and kind.

Use kubectl commands to verify the CRD and list your custom resources.

Practice

1. What is the main purpose of a Custom Resource in Kubernetes?

easy

A. To delete all existing Kubernetes resources

B. To replace built-in Kubernetes objects like Pods

C. To automatically update Kubernetes itself

D. To add new object types to Kubernetes for custom app needs

Solution

1. Step 1: Understand Kubernetes object types

   Kubernetes has built-in objects like Pods and Services, but sometimes you need new types for your apps.

2. Step 2: Role of Custom Resources

   Custom Resources let you define new object types to extend Kubernetes capabilities without changing its core.

3. Final Answer:

   To add new object types to Kubernetes for custom app needs -> Option D

4. Quick Check:

   Custom Resources extend Kubernetes = A [OK]

Hint: Custom Resources add new types, not replace or delete [OK]

Common Mistakes:

• Thinking Custom Resources replace built-in objects
• Believing Custom Resources update Kubernetes itself
• Confusing Custom Resources with deleting resources

2. Which YAML kind is used to define a Custom Resource type in Kubernetes?

easy

A. CustomResourceDefinition

B. Pod

C. Deployment

D. Service

Solution

1. Step 1: Identify the YAML kind for custom types

   Custom Resource types are defined by a special Kubernetes object called CustomResourceDefinition.

2. Step 2: Differentiate from common kinds

   Pod, Deployment, and Service are built-in kinds, not for defining new types.

3. Final Answer:

   CustomResourceDefinition -> Option A

4. Quick Check:

   CustomResourceDefinition defines new types [OK]

Hint: CustomResourceDefinition is the special kind for custom types [OK]

Common Mistakes:

• Choosing Pod or Deployment as custom type definition
• Confusing Service with CustomResourceDefinition
• Using incorrect kind names in YAML

3. Given this CustomResourceDefinition snippet, what is the spec.names.kind used for?

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: widgets.example.com
spec:
  group: example.com
  versions:
    - name: v1
      served: true
      storage: true
  scope: Namespaced
  names:
    plural: widgets
    singular: widget
    kind: Widget
    shortNames:
    - wdg

medium

A. It controls the storage backend for the resource

B. It defines the kind name used when creating custom resource objects

C. It sets the namespace where the resource lives

D. It specifies the API version of the custom resource

Solution

1. Step 1: Understand spec.names.kind role

   This field sets the kind name you use in YAML when creating instances of this custom resource.

2. Step 2: Differentiate from other fields

   API version is under versions.name, scope is separate, storage backend is not set here.

3. Final Answer:

   It defines the kind name used when creating custom resource objects -> Option B

4. Quick Check:

   spec.names.kind = kind name for objects [OK]

Hint: spec.names.kind is the object kind name in YAML [OK]

Common Mistakes:

• Confusing kind with API version
• Thinking it sets namespace or storage
• Mixing plural and kind meanings

4. You applied a CustomResourceDefinition YAML but get an error: error: unable to recognize "crd.yaml": no matches for kind "CustomResourceDefinition" in version "v1beta1". What is the likely cause?

medium

A. Missing metadata.name field in the YAML

B. Trying to create a Pod instead of a CustomResourceDefinition

C. Using deprecated API version v1beta1 instead of apiextensions.k8s.io/v1

D. Incorrect indentation in the YAML file

Solution

1. Step 1: Analyze the error message

   The error says no matches for kind "CustomResourceDefinition" in version "v1beta1" which means the API version is not supported.

2. Step 2: Check Kubernetes API version support

   Since Kubernetes 1.22+, the v1beta1 version for CustomResourceDefinition is removed; use apiextensions.k8s.io/v1 instead.

3. Final Answer:

   Using deprecated API version v1beta1 instead of apiextensions.k8s.io/v1 -> Option C

4. Quick Check:

   Deprecated API version causes no match error [OK]

Hint: Use apiextensions.k8s.io/v1 for CRD, not v1beta1 [OK]

Common Mistakes:

• Ignoring API version deprecation
• Assuming missing metadata causes this error
• Blaming YAML indentation without checking version

5. You want to create a custom resource named Gadget with group devices.example.com and version v1. Which is the correct minimal spec section of the CustomResourceDefinition YAML?

hard

A. group: devices.example.com
versions:
- name: v1
served: true
storage: true
scope: Namespaced
names:
plural: gadgets
singular: gadget
kind: Gadget

B. group: devices.example.com
version: v1
scope: Cluster
names:
plural: gadgets
kind: Gadget

C. apiVersion: v1
group: devices.example.com
versions:
- name: v1
served: false
storage: true
scope: Namespaced
names:
plural: gadgets
kind: Gadget

D. group: devices.example.com
versions:
- name: v2
served: true
storage: true
scope: Namespaced
names:
plural: gadgets
singular: gadget
kind: Gadget

Solution

1. Step 1: Check group and version correctness

   The group must be devices.example.com and version v1 served and storage true.

2. Step 2: Validate scope and names

   Scope should be Namespaced (common default), and names must include plural, singular, and kind Gadget.

3. Step 3: Eliminate wrong options

   group: devices.example.com version: v1 scope: Cluster names: plural: gadgets kind: Gadget uses singular version field and Cluster scope, apiVersion: v1 group: devices.example.com versions: - name: v1 served: false storage: true scope: Namespaced names: plural: gadgets kind: Gadget has served false, group: devices.example.com versions: - name: v2 served: true storage: true scope: Namespaced names: plural: gadgets singular: gadget kind: Gadget uses version v2 instead of v1.

4. Final Answer:

   group: devices.example.com versions: - name: v1 served: true storage: true scope: Namespaced names: plural: gadgets singular: gadget kind: Gadget -> Option A

5. Quick Check:

   Correct group, version, scope, and names = A [OK]

Hint: Use served: true and storage: true for active versions [OK]

Common Mistakes:

• Using version instead of versions list
• Setting served: false disables API
• Mismatching version name or group
• Omitting singular name