https://github.com/open-cluster-management-io/addon-framework

addon apis
https://github.com/open-cluster-management-io/addon-framework

Last synced: 2 days ago
JSON representation

addon apis

• Host: GitHub
• URL: https://github.com/open-cluster-management-io/addon-framework
• Owner: open-cluster-management-io
• License: apache-2.0
• Created: 2020-08-24T15:35:11.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-12-10T07:01:40.000Z (18 days ago)
• Last Synced: 2024-12-10T08:17:58.338Z (18 days ago)
• Language: Go
• Size: 54 MB
• Stars: 24
• Watchers: 6
• Forks: 39
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG/CHANGELOG-v0.1.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# AddOn Framework

This is to define an AddOn framework library.

## Community, discussion, contribution, and support

Check the [CONTRIBUTING Doc](CONTRIBUTING.md) for how to contribute to the repo.

------

## Purpose

This library is used to implement AddOn management like installation, registration etc.

So developers could be able to develop their own addon functions more easily.

## Concepts

* [ManagedClusterAddon](https://github.com/open-cluster-management-io/api/blob/main/addon/v1alpha1/types_managedclusteraddon.go)

* [ClusterManagementAddOn](https://github.com/open-cluster-management-io/api/blob/main/addon/v1alpha1/types_clustermanagementaddon.go)

## Design Doc

* [AddOn Framework](https://github.com/open-cluster-management-io/enhancements/tree/main/enhancements/sig-architecture/8-addon-framework)

## AddOn Consumers

* [cluster-proxy](https://github.com/open-cluster-management-io/cluster-proxy) 

* [managed-serviceaccount](https://github.com/open-cluster-management-io/managed-serviceaccount)

## AddOn Contributions

A [collection of OCM addons](https://github.com/open-cluster-management-io/addon-contrib)

for staging and testing PoC purposes:

AI integration, IoT layer, cluster proxy, telemetry, resource usage collection and more.

## AddOn Examples 

We have examples to implement AddOn using Helm Chart or Go Template. You can find more details in [examples](examples/README.md).