https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern

A toolkit for building declarative operators with kubebuilder
https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern

k8s-sig-api-machinery

Last synced: 4 days ago
JSON representation

A toolkit for building declarative operators with kubebuilder

• Host: GitHub
• URL: https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern
• Owner: kubernetes-sigs
• License: apache-2.0
• Created: 2019-02-19T22:30:51.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-26T14:12:02.000Z (about 1 month ago)
• Last Synced: 2024-10-06T02:04:56.079Z (29 days ago)
• Topics: k8s-sig-api-machinery
• Language: Go
• Size: 28.5 MB
• Stars: 256
• Watchers: 18
• Forks: 85
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: code-of-conduct.md
  • Security: SECURITY_CONTACTS

Awesome Lists containing this project

README

        
# kubebuilder-declarative-pattern

kubebuilder-declarative-pattern provides a set of tools for building declarative cluster operators with kubebuilder. Declarative operators provide a fast path to orchestrating Kubernetes deployments to enable domain experts to focus on their component instead of re-answering questions like 'How do I get this YAML into the cluster?' or 'How do I update it?'.

## Development

### Running Smoke Tests

Smoke tests are provided to ensure basic functionality of the framework against example operators. They should be run as part of significant code changes. The tests require a running Kubernetes cluster to be targeted from the local machine and write access to a GCR bucket.

```bash

cd hack

IMG= go run smoketest.go

```


## Documentation

- [Building an Operator (walkthrough)](./docs/addon/walkthrough/README.md)

- [Pattern Documentation](https://godoc.org/sigs.k8s.io/kubebuilder-declarative-pattern/pkg/patterns)

- [Managing Addons with Operators (Video, KubeCon'18)](https://www.youtube.com/watch?v=LPejvfBR5_w)

## Community, discussion, contribution, and support

Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).

You can reach the maintainers of this project at:

- [Slack](http://slack.k8s.io/)

- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-dev)

### Code of conduct

Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).

[owners]: https://git.k8s.io/community/contributors/guide/owners.md

[Creative Commons 4.0]: https://git.k8s.io/website/LICENSE