SDK for building Kubernetes applications. Provides high level APIs, useful abstractions, and project scaffolding.
Branch: master
Clone or download
AlexNPavel commands/.../scorecard: improve crd resources check (#1027)
**Description of the change:** Changes the crd resources check so that the command
actually verifies what resources the operator touches. It also makes a separate function to get the proxy logs so that multiple tests can more easily use proxy logs.


**Motivation for the change:** This makes the test more accurate and can tell the user if they missed a resource that the operator interacts with.
Latest commit e9b48df Feb 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github .github/ISSUE_TEMPLATE/bug-report.md: add Helm (#840) Dec 13, 2018
commands/operator-sdk commands/.../scorecard: improve crd resources check (#1027) Feb 15, 2019
doc pkg/scaffold: Adjust log msg create -> created (#1076) Feb 13, 2019
example/memcached-operator Consistent logging and error message style (#892) Jan 11, 2019
hack commands/.../scorecard: improve crd resources check (#1027) Feb 15, 2019
images/scorecard-proxy pkg/log/zap: adding helpers for zap logger configuration (#873) Jan 31, 2019
internal/util internal/.../manifest.go: manifest generators take directory arguments ( Feb 13, 2019
pkg Remove hyphen from controller generated code (#998) Feb 13, 2019
test commands/.../scorecard: improve crd resources check (#1027) Feb 15, 2019
vendor vendor: Prune non-go from vendor (#1098) Feb 13, 2019
version Post Release Clean-Up (#1080) Feb 8, 2019
.gitignore vendor: add vendor (#1065) Feb 6, 2019
.travis.yml .travis.yml: cache $HOME/.cache/go-build (#1068) Feb 6, 2019
CHANGELOG.md pkg/test/main_entry.go: build local binary instead of `go run` (#1089) Feb 11, 2019
CONTRIBUTING.MD contributing.md: require documentation for new features Jun 25, 2018
Gopkg.lock vendor: Prune non-go from vendor (#1098) Feb 13, 2019
Gopkg.toml vendor: Prune non-go from vendor (#1098) Feb 13, 2019
LICENSE Initial commit Feb 7, 2018
MAINTAINERS MAINTAINERS: add @theishshah (#1079) Feb 8, 2019
Makefile Makefile: trim gopath from panic logs (#1042) Feb 1, 2019
README.md README.md: remove alpha label (#1011) Jan 28, 2019
bill-of-materials.json *: update import paths from coreos to operator-framework Apr 27, 2018
bill-of-materials.override.json pom: add bill-of-materials.override.json Mar 16, 2018
code-of-conduct.md operator-sdk: add code-of-conduct.md Apr 26, 2018
release.sh commands,pkg/scaffold,hack,pkg/helm: run and migrate command support … Jan 15, 2019

README.md

Build Status

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

Workflow

The SDK provides workflows to develop operators in Go, Ansible, or Helm.

The following workflow is for a new Go operator:

  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

The following workflow is for a new Ansible operator:

  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

The following workflow is for a new Helm operator:

  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

Prerequisites

  • dep version v0.5.0+.
  • git
  • go version v1.10+.
  • docker version 17.03+.
  • kubectl version v1.11.0+.
  • Access to a kubernetes v.1.11.0+ cluster.

Quick Start

First, checkout and install the operator-sdk CLI:

$ mkdir -p $GOPATH/src/github.com/operator-framework
$ cd $GOPATH/src/github.com/operator-framework
$ git clone https://github.com/operator-framework/operator-sdk
$ cd operator-sdk
$ git checkout master
$ make dep
$ make install

Create and deploy an app-operator using the SDK CLI:

# Create an app-operator project that defines the App CR.
$ mkdir -p $GOPATH/src/github.com/example-inc/
# Create a new app-operator project
$ cd $GOPATH/src/github.com/example-inc/
$ operator-sdk new app-operator
$ cd app-operator

# Add a new API for the custom resource AppService
$ operator-sdk add api --api-version=app.example.com/v1alpha1 --kind=AppService

# Add a new controller that watches for AppService
$ operator-sdk add controller --api-version=app.example.com/v1alpha1 --kind=AppService

# Build and push the app-operator image to a public registry such as quay.io
$ operator-sdk build quay.io/example/app-operator
$ docker push quay.io/example/app-operator

# Update the operator manifest to use the built image name (if you are performing these steps on OSX, see note below)
$ sed -i 's|REPLACE_IMAGE|quay.io/example/app-operator|g' deploy/operator.yaml
# On OSX use:
$ sed -i "" 's|REPLACE_IMAGE|quay.io/example/app-operator|g' deploy/operator.yaml

# Setup Service Account
$ kubectl create -f deploy/service_account.yaml
# Setup RBAC
$ kubectl create -f deploy/role.yaml
$ kubectl create -f deploy/role_binding.yaml
# Setup the CRD
$ kubectl create -f deploy/crds/app_v1alpha1_appservice_crd.yaml
# Deploy the app-operator
$ kubectl create -f deploy/operator.yaml

# Create an AppService CR
# The default controller will watch for AppService objects and create a pod for each CR
$ kubectl create -f deploy/crds/app_v1alpha1_appservice_cr.yaml

# Verify that a pod is created
$ kubectl get pod -l app=example-appservice
NAME                     READY     STATUS    RESTARTS   AGE
example-appservice-pod   1/1       Running   0          1m

# Test the new Resource Type
$ kubectl describe appservice example-appservice
Name:         example-appservice
Namespace:    myproject
Labels:       <none>
Annotations:  <none>
API Version:  app.example.com/v1alpha1
Kind:         AppService
Metadata:
  Cluster Name:        
  Creation Timestamp:  2018-12-17T21:18:43Z
  Generation:          1
  Resource Version:    248412
  Self Link:           /apis/app.example.com/v1alpha1/namespaces/myproject/appservices/example-appservice
  UID:                 554f301f-0241-11e9-b551-080027c7d133
Spec:
  Size:  3

# Cleanup
$ kubectl delete -f deploy/crds/app_v1alpha1_appservice_cr.yaml
$ kubectl delete -f deploy/operator.yaml
$ kubectl delete -f deploy/role.yaml
$ kubectl delete -f deploy/role_binding.yaml
$ kubectl delete -f deploy/service_account.yaml
$ kubectl delete -f deploy/crds/app_v1alpha1_appservice_crd.yaml

Command Line Interface

To learn more about the SDK CLI, see the SDK CLI Reference, or run operator-sdk [command] -h.

User Guides

To learn more about the writing an operator in Go, see the user guide.

The SDK also supports developing an operator using Ansible or Helm. See the Ansible and Helm operator user guides.

Samples

To explore any operator samples built using the operator-sdk, see the operator-sdk-samples.

Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

See the proposal docs and issues for ongoing or planned work.

Reporting bugs

See reporting bugs for details about reporting any issues.

License

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