Version v1.3 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.
Quickstart for Go-based Operators
This guide walks through an example of building a simple memcached-operator using tools and libraries provided by the Operator SDK.
- Install operator-sdk and its prequisites.
- Access to a Kubernetes v1.11.3+ cluster (v1.16.0+ if using
- User authorized with
Create a project
Create and change into a directory for your project. Then call
with the Go plugin to initialize the project.
mkdir memcached-operator cd memcached-operator operator-sdk init --domain=example.com --repo=github.com/example/memcached-operator
Create an API
Create a simple Memcached API:
operator-sdk create api --group cache --version v1 --kind Memcached --resource=true --controller=true
Build and push the operator image
Use the built-in Makefile targets to build and push your operator. Make
sure to define
IMG when you call
make docker-build docker-push IMG=<some-registry>/<project-name>:<tag>
NOTE: To allow the cluster pull the image the repository needs to be set as public or you must configure an image pull secret.
Run the operator
Install the CRD and deploy the project to the cluster. Set
make deploy to use the image you just pushed:
make install make deploy IMG=<some-registry>/<project-name>:<tag>
Create a sample custom resource
Create a sample CR:
kubectl apply -f config/samples/cache_v1_memcached.yaml
Watch for the CR be reconciled by the operator:
kubectl logs deployment.apps/memcached-operator-controller-manager -n memcached-operator-system -c manager
Delete the CR to uninstall memcached:
kubectl delete -f config/samples/cache_v1_memcached.yaml
Uninstall the operator and its CRDs:
kustomize build config/default | kubectl delete -f -
Read the tutorial for an in-depth walkthough of building a Go operator.