https://github.com/operator-framework/helm-app-operator-kit

Tool for creating a Kubernetes Operator from a Helm Chart
https://github.com/operator-framework/helm-app-operator-kit

chart helm kubernetes operator operator-framework operator-kit

Last synced: about 1 month ago
JSON representation

Tool for creating a Kubernetes Operator from a Helm Chart

• Host: GitHub
• URL: https://github.com/operator-framework/helm-app-operator-kit
• Owner: operator-framework
• License: apache-2.0
• Archived: true
• Created: 2018-02-07T16:15:38.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-01-24T15:40:48.000Z (almost 6 years ago)
• Last Synced: 2024-06-18T21:50:46.121Z (7 months ago)
• Topics: chart, helm, kubernetes, operator, operator-framework, operator-kit
• Language: Shell
• Homepage:
• Size: 212 KB
• Stars: 132
• Watchers: 22
• Forks: 44
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: code-of-conduct.md

Awesome Lists containing this project

README

        
# [DEPRECATED] Helm App Operator Kit

**This project is deprecated. Its functionality has been integrated into the [Operator SDK][operator-sdk] as of v0.3.0. To get started developing a Helm operator with the SDK, see the [Helm operator user guide][helm-user-guide].**

## Overview

This project is a component of the [Operator Framework](https://github.com/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](https://coreos.com/blog/introducing-operator-framework).

This repository serves as a template for easily creating managed stateless applications that run Helm charts. It was inspired by the [Lostromos project](https://github.com/wpengine/lostromos). The underlying Operator was created using the `operator-sdk new` command.

While the [Operator Lifecycle Manager][olm-repo] can only manage Operators, not all applications require developers to write a custom Operator.

The [Helm App Operator Kit][helm-sdk] makes it possible to leverage a pre-existing Helm chart to deploy Kubernetes resources as a unified application.

## Clone the project

```sh

mkdir -p $GOPATH/src/github.com/operator-framework

cd $GOPATH/src/github.com/operator-framework

git clone https://github.com/operator-framework/helm-app-operator-kit

cd helm-app-operator-kit

```

## Getting Started

See the [helm-app-operator](./helm-app-operator) subdirectory for more details about how to build and deploy a custom operator with Helm App Operator Kit or follow along with a simple [tomcat-operator](./examples/tomcat-operator) example.

[operator-sdk]: https://github.com/operator-framework/operator-sdk

[helm-user-guide]:https://github.com/operator-framework/operator-sdk/blob/master/doc/helm/user-guide.md

[helm-sdk]: ./

[olm-repo]: https://github.com/operator-framework/operator-lifecycle-manager