# Operator SDK — Build Kubernetes Operators the Easy Way

> The Operator SDK provides scaffolding, code generation, and lifecycle management tools for building Kubernetes operators in Go, Ansible, or Helm with best-practice patterns built in.

## Install

Save as a script file and run:

# Operator SDK — Build Kubernetes Operators the Easy Way

## Quick Use
```bash
# Install the Operator SDK CLI
brew install operator-sdk
# Or download from GitHub releases

# Scaffold a new Go-based operator
operator-sdk init --domain example.com --repo github.com/myorg/my-operator
operator-sdk create api --group app --version v1alpha1 --kind MyApp --resource --controller

# Build and push the operator image
make docker-build docker-push IMG=myregistry/my-operator:v0.1.0
```

## Introduction
The Operator SDK is part of the Operator Framework, an open-source project by Red Hat that simplifies building Kubernetes operators. Operators extend Kubernetes by encoding domain-specific operational knowledge into custom controllers that manage the lifecycle of complex applications. The SDK provides scaffolding, code generation, testing utilities, and OLM integration so you can focus on your application logic rather than boilerplate reconciliation code.

## What Operator SDK Does
- Scaffolds complete operator projects in Go, Ansible, or Helm with a single CLI command
- Generates Custom Resource Definitions, controllers, and RBAC manifests automatically
- Provides testing harnesses for unit testing, integration testing, and scorecard validation
- Integrates with Operator Lifecycle Manager (OLM) for catalog publishing and upgrades
- Builds and packages operators as container images ready for deployment

## Architecture Overview
An operator built with the SDK follows the controller-runtime pattern: it watches for changes to Custom Resources (CRs) and reconciles the actual cluster state to match the desired state declared in the CR spec. The SDK generates a main.go that wires up the manager, one or more controllers, and webhook servers. Each controller implements a Reconcile function that runs whenever its watched resources change. The SDK leverages kubebuilder under the hood for Go operators, providing markers-based code generation for deep copies, CRD schemas, and RBAC rules.

## Self-Hosting & Configuration
- Install the operator-sdk CLI via Homebrew, Go install, or direct binary download
- Run operator-sdk init to create the project structure with Go modules, Makefile, and Dockerfile
- Use operator-sdk create api to add new Custom Resource types and their controllers
- Configure RBAC permissions via kubebuilder markers in the controller source code
- Deploy locally with make install (CRDs) and make run, or to a cluster with make deploy

## Key Features
- Three operator types: Go for maximum flexibility, Ansible for ops teams, Helm for chart-based apps
- Automatic CRD generation from Go struct tags and OpenAPI validation markers
- Built-in scorecard tool that validates operator best practices and OLM readiness
- Seamless OLM integration for publishing operators to catalogs like OperatorHub.io
- Conversion webhooks and admission webhooks scaffolded with a single command

## Comparison with Similar Tools
- **Kubebuilder** — the underlying framework for Go operators; Operator SDK adds OLM, Ansible, Helm, and scorecard on top
- **KUDO** — declarative operator framework using YAML plans but less flexible than writing Go controllers
- **Metacontroller** — lightweight approach using webhooks and any language, but no scaffolding or lifecycle management
- **Kopf (Python)** — Python-based operator framework, simpler but lacks the ecosystem tooling of Operator SDK
- **Shell-operator** — run shell scripts as operators, great for simple tasks but hard to maintain at scale

## FAQ
**Q: Do I need to know Go to build an operator?**
A: No. The Operator SDK supports Ansible playbooks and Helm charts as operator backends. Go is needed only if you want full programmatic control.

**Q: What is the difference between Operator SDK and Kubebuilder?**
A: Kubebuilder is the core scaffolding and controller-runtime framework for Go. Operator SDK wraps Kubebuilder and adds Ansible/Helm support, OLM packaging, scorecard testing, and the Operator Framework ecosystem.

**Q: How do I publish my operator to OperatorHub?**
A: Use operator-sdk bundle create to generate an OLM bundle, then submit a PR to the community-operators repository on GitHub.

**Q: Can operators manage resources outside the cluster?**
A: Yes. Operators can call external APIs (cloud services, databases, DNS providers) in their reconcile loop. The Custom Resource just needs to declare the desired state for those external systems.

## Sources
- https://github.com/operator-framework/operator-sdk
- https://sdk.operatorframework.io/docs

---
Source: https://tokrepo.com/en/workflows/5d2b207c-3987-11f1-9bc6-00163e2b0d79
Author: Script Depot