Operator SDK basics in Kubernetes - Mini Project: Build & Apply

Operator SDK basics

📖 Scenario: You are starting to build a Kubernetes Operator using the Operator SDK. Operators help automate tasks in Kubernetes clusters by managing custom resources.In this project, you will create a new Operator project, configure it, add a simple API, and then display the project structure.

🎯 Goal: Build a basic Operator SDK project with a simple API and show its structure.

📋 What You'll Learn

Use Operator SDK CLI commands to create and configure the project

Create an API with specific group, version, and kind

Display the project directory structure

💡 Why This Matters

🌍 Real World

Operators automate complex application management tasks in Kubernetes, such as deploying, scaling, and healing applications automatically.

💼 Career

Knowing how to use the Operator SDK is valuable for DevOps engineers and Kubernetes administrators who want to extend Kubernetes capabilities with custom automation.

1

Create a new Operator SDK project

Run the command operator-sdk init --domain=example.com --repo=github.com/example/memcached-operator to create a new Operator SDK project with domain example.com and repository github.com/example/memcached-operator.

Kubernetes

# Run the operator-sdk init command to create the project
# Your code here

Hint

This command initializes a new Operator project with the specified domain and repository path.

2

Create a new API for the Operator

Run the command operator-sdk create api --group cache --version v1 --kind Memcached --resource --controller to add a new API group cache, version v1, and kind Memcached with resource and controller.

Kubernetes

operator-sdk init --domain=example.com --repo=github.com/example/memcached-operator
# Run the operator-sdk create api command to add the Memcached API
# Your code here

Hint

This command creates the API and controller files for the Memcached kind in the cache group.

3

Build the Operator project

Run the command make build to compile the Operator project into a binary.

Kubernetes

operator-sdk init --domain=example.com --repo=github.com/example/memcached-operator
operator-sdk create api --group cache --version v1 --kind Memcached --resource --controller
# Run make build to compile the operator
# Your code here

Hint

This command compiles the operator code into an executable binary.

4

Show the project directory structure

Run the command tree -L 2 to display the directory structure of the Operator project up to two levels deep.

Kubernetes

operator-sdk init --domain=example.com --repo=github.com/example/memcached-operator
operator-sdk create api --group cache --version v1 --kind Memcached --resource --controller
make build
# Run tree -L 2 to show the project structure
# Your code here

Hint

This command shows the folder and file layout of your Operator project.

Practice

1. What is the primary purpose of the Operator SDK in Kubernetes?

easy

A. To monitor network traffic in Kubernetes

B. To replace Kubernetes API server

C. To help automate application management on Kubernetes clusters

D. To create Kubernetes clusters automatically

Solution

1. Step 1: Understand Operator SDK's role

   The Operator SDK is designed to simplify building and managing Kubernetes operators, which automate app lifecycle tasks.

2. Step 2: Compare options

   Options A, B, and C describe unrelated Kubernetes functions, while D correctly states the SDK's purpose.

3. Final Answer:

   To help automate application management on Kubernetes clusters -> Option C

4. Quick Check:

   Operator SDK automates app management = D [OK]

Hint: Remember: Operator SDK automates app tasks on Kubernetes [OK]

Common Mistakes:

• Confusing Operator SDK with Kubernetes cluster creation tools
• Thinking Operator SDK replaces core Kubernetes components
• Assuming it monitors network traffic

2. Which command initializes a new Operator SDK project?

easy

A. operator-sdk create api

B. operator-sdk start

C. kubectl init operator

D. operator-sdk init

Solution

1. Step 1: Identify the command to start a project

   The operator-sdk init command sets up a new operator project structure.

2. Step 2: Eliminate incorrect commands

   create api adds resources, kubectl init operator is invalid, and start is not a recognized init command.

3. Final Answer:

   operator-sdk init -> Option D

4. Quick Check:

   Init command for project setup = B [OK]

Hint: Use 'init' to start your operator project [OK]

Common Mistakes:

• Confusing 'create api' with project initialization
• Using kubectl commands instead of operator-sdk
• Trying 'start' instead of 'init'

3. What will happen if you run operator-sdk create api --group=app --version=v1 --kind=AppService?

medium

A. It creates a new API and resource type named AppService in group app/v1

B. It deletes the existing AppService resource

C. It initializes a new operator project

D. It runs the operator locally

Solution

1. Step 1: Understand the create api command

   The command operator-sdk create api adds a new API resource to the operator project with specified group, version, and kind.

2. Step 2: Analyze the command parameters

   Here, group is 'app', version is 'v1', and kind is 'AppService', so it creates that resource type.

3. Final Answer:

   It creates a new API and resource type named AppService in group app/v1 -> Option A

4. Quick Check:

   Create API command adds resource = A [OK]

Hint: Create API adds resource with group, version, kind [OK]

Common Mistakes:

• Thinking it deletes resources
• Confusing create api with init
• Assuming it runs the operator

4. You ran operator-sdk init --domain=example.com app-operator but got an error. What is a common cause?

medium

A. Missing Go module initialization before running init

B. Using an invalid domain format

C. Not having Kubernetes cluster running

D. Running create api before init

Solution

1. Step 1: Check prerequisites for operator-sdk init

   The Operator SDK requires a Go module initialized (via go mod init) before running init.

2. Step 2: Evaluate other options

   Domain format is usually flexible, Kubernetes cluster is not needed for init, and create api must come after init, not before.

3. Final Answer:

   Missing Go module initialization before running init -> Option A

4. Quick Check:

   Go module must be ready before init = C [OK]

Hint: Always run 'go mod init' before 'operator-sdk init' [OK]

Common Mistakes:

• Ignoring Go module setup
• Assuming cluster must be running for init
• Running create api before init

5. You want to test your operator locally before deploying. Which command should you run?

hard

A. operator-sdk deploy cluster

B. operator-sdk up local

C. kubectl apply -f deploy.yaml

D. operator-sdk create api

Solution

1. Step 1: Identify command for local testing

   The operator-sdk up local command runs the operator locally on your machine for testing.

2. Step 2: Compare other options

   deploy cluster deploys to cluster, kubectl apply applies manifests, and create api adds resources, none run locally.

3. Final Answer:

   operator-sdk up local -> Option B

4. Quick Check:

   Run local command tests operator locally = A [OK]

Hint: Use 'up local' to test operator on your machine [OK]

Common Mistakes:

• Trying to deploy before local testing
• Confusing create api with running operator
• Using kubectl instead of operator-sdk for local run