Why an Operator?
Operators make it easy to manage complex stateful applications on top of Kubernetes. However writing an Operator today can be difficult because of challenges such as using low level APIs, writing boilerplate, and a lack of modularity which leads to duplication.
What is the Operator SDK?
The Operator SDK is a framework that uses the controller-runtime library to make writing Operators easier by providing:
- High level APIs and abstractions to write the operational logic more intuitively.
- Tools for scaffolding and code generation to bootstrap a new project fast.
- Extensions to cover common Operator use cases.
How do I use it?
The following is the workflow for a new Go-based Operator with the Operator SDK:
- Create a new Operator project using the SDK CLI.
- Create a new Custom Resource Definition API Type using the SDK CLI.
- Add your Custom Resource Definition (CRD) to your live Kubernetes cluster.
- Define your Custom Resource Spec and Status.
- Create a new Controller for your Custom Resource Definition API.
- Write the reconciling logic for your Controller.
- Run the Operator locally to test your code against your live Kubernetes cluster.
- Add your Custom Resource (CR) to your live Kubernetes cluster and watch your Operator in action!
- After you are satisifed with your work, use the SDK CLI to build and generate the Operator Deployment manifests.
- Optionally add additional APIs and Controllers using the SDK CLI.
In this tutorial, we will create an Operator called a PodSet. A PodSet is a simple Controller/Operator that manages pods.
A user provides a number of pods specified in
spec.replicas. The PodSet also conveniently outputs the name of all Pods currently controlled by the PodSet in the
Thank you for taking a closer look at the Go Operator. For more Information, check out the links below:
- Operator-Framework: https://github.com/operator-framework
- Operator-SDK: https://github.com/operator-framework/operator-sdk/
- Tutorial: Deep Dive into the Operator Framework: https://www.youtube.com/watch?v=8_DaCcRMp5I&t=1220s
- Sample Operators using Go: https://github.com/operator-framework/operator-sdk-samples/tree/master/go
- Kubernetes Slack Chat (upstream): #kubernetes-operators at https://kubernetes.slack.com/
- Operator-Framework on Google Groups: https://groups.google.com/forum/#!forum/operator-framework
- OpenShift Operators Special Interest Group (SIG): https://commons.openshift.org/sig/OpenshiftOperators.html
Operator SDK with Go
Creating a New Project
Let's begin by creating a new project called
oc new-project myproject
Let's now create a new directory in our
mkdir -p $GOPATH/src/github.com/redhat/
Navigate to the directory:
Create a new Go-based Operator SDK project for the PodSet:
operator-sdk new podset-operator --type=go
Navigate to the project root: