Skip to content

SDK for building Kubernetes applications. Provides high level APIs, useful abstractions, and project scaffolding.

License

Notifications You must be signed in to change notification settings

operator-framework/operator-sdk

Folders and files

NameName
Last commit message
Last commit date
Nov 9, 2022
Oct 30, 2024
Jan 14, 2025
Sep 27, 2023
Jan 19, 2022
Jan 3, 2025
Jan 3, 2025
Feb 11, 2025
Apr 26, 2022
Dec 18, 2023
Nov 7, 2024
Jan 16, 2025
May 19, 2022
Feb 11, 2025
May 7, 2024
Dec 18, 2020
Jun 24, 2022
May 18, 2023
Sep 27, 2023
Jul 28, 2021
Feb 7, 2018
Jan 14, 2025
Sep 28, 2020
Apr 29, 2024
Nov 22, 2024
Mar 17, 2020
Feb 10, 2021
Jan 10, 2025
Jan 10, 2025
Dec 14, 2020

⚠️ IMPORTANT NOTICE: Images under gcr.io/kubebuilder/ Will Be Unavailable Soon

If your project uses gcr.io/kubebuilder/kube-rbac-proxy it will be affected. Your project may fail to work if the image cannot be pulled. You must move as soon as possible, sometime from early 2025, the GCR will go away.

The usage of the project kube-rbac-proxy was discontinued from Kubebuilder and Operator-SDK. It was replaced for similar protection using authn/authz via Controller-Runtime's feature WithAuthenticationAndAuthorization.

For more information and guidance see the discussion kubernetes-sigs/kubebuilder#3907

Build Status License

Documentation

Docs can be found on the Operator SDK website.

Overview

This project is a component of the Operator Framework, an open source toolkit to manage Kubernetes native applications, called Operators, in an effective, automated, and scalable way. Read more in the introduction blog post.

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.

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

Dependency and platform support

Go version

Release binaries will be built with the Go compiler version specified in the developer guide. A Go Operator project's Go version can be found in its go.mod file.

Kubernetes versions

Supported Kubernetes versions for your Operator project or relevant binary can be determined by following this compatibility guide.

Platforms

The set of supported platforms for all binaries and images can be found in these tables.

Community and how to get involved

How to contribute

Check out the contributor documentation.

License

Operator SDK is under Apache 2.0 license. See the LICENSE file for details.