{{ partial "head.html" . }}

# OperatorSDK

## The Operator SDK makes it easier to build Kubernetes native applications, a process that can require deep, application-specific operational knowledge.

Build an Operator

## WHAT IS OPERATOR SDK?

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.

## WHAT CAN I DO WITH OPERATOR SDK?

The Operator SDK provides the tools to build, test, and package Operators. Initially, the SDK facilitates the marriage of an application’s business logic (for example, how to scale, upgrade, or backup) with the Kubernetes API to execute those operations. Over time, the SDK can allow engineers to make applications smarter and have the user experience of cloud services. Leading practices and code patterns that are shared across Operators are included in the SDK to help prevent reinventing the wheel.

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

Build an Operator

# Develop in Go, Ansible, or Helm

### Go

1. Create a new operator project using the SDK Command Line Interface (CLI)
2. Define new resource APIs by adding Custom Resource Definitions (CRD)
3. Define Controllers to watch and reconcile resources
4. Write the reconciling logic for your Controller using the SDK and controller-runtime APIs
5. Use the SDK CLI to build and generate the operator deployment manifests

Develop with Go

### Ansible

1. Create a new operator project using the SDK Command Line Interface (CLI)
2. Write the reconciling logic for your object using ansible playbooks and roles
3. Use the SDK CLI to build and generate the operator deployment manifests
4. Optionally add additional CRD's using the SDK CLI and repeat steps 2 and 3

Develop with Ansible

### Helm

1. Create a new operator project using the SDK Command Line Interface (CLI)
2. Create a new (or add your existing) Helm chart for use by the operator’s reconciling logic
3. Use the SDK CLI to build and generate the operator deployment manifests
4. Optionally add additional CRD’s using the SDK CLI and repeat steps 2 and 3

Develop with Helm

## Contribute!

The Operator SDK and its components are open source, so please feel encouraged to jump into each individually and learn what else you can do. If you want to discuss your experience, have questions, or want to get involved, join the Operator SDK forum and visit us on GitHub.

{{ partial "footer.html" . }} {{ partialCached "scripts.html" . }}