Skip to content

Commit 51da052

Browse files
authored
docs: polish readme (open-cluster-management-io#58)
Signed-off-by: Mike Ng <ming@redhat.com>
1 parent 89d73f4 commit 51da052

1 file changed

Lines changed: 27 additions & 10 deletions

File tree

README.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,31 @@
11
# Addon-Contrib
22

3-
This repository hosts a collection of Open Cluster Management (OCM) addons for staging and testing Proof of Concept (PoC) purposes.
3+
This repository hosts a collection of Open Cluster Management (OCM) addons for staging and testing purposes.
44

55
## Overview
66

77
OCM is a project that provides a unified way to manage multiple Kubernetes clusters.
88
This repository is intended for the development, staging, and testing of various OCM addons.
99

10-
Addons in this repository are designed to extend the capabilities of the OCM deployment,
11-
allowing for enhanced AI integration, IoT layer, cluster proxy, telemetry, resource usage collection and more.
10+
Addons in this repository are designed to extend the capabilities of OCM deployments,
11+
providing specialized functionality for workload scheduling, application deployment, observability,
12+
device management, data orchestration, and federated learning across multiple clusters.
13+
14+
## Available Addons
15+
16+
This repository contains the following OCM addons:
17+
18+
- **argocd-agent-addon**: Integrates Argo CD Agent for highly scalable application deployment across managed clusters
19+
- **clusternet-addon**: Provides Clusternet integration for enhanced cluster networking capabilities
20+
- **device-addon**: Enables device management functionality within the OCM ecosystem
21+
- **federated-learning-controller**: Implements federated learning capabilities across distributed clusters
22+
- **fluid-addon**: Integrates Fluid for data orchestration and management in multicluster environments
23+
- **hellospoke-addon**: A simple example addon demonstrating basic OCM addon development patterns
24+
- **kueue-addon**: Integrates Kueue for advanced multicluster batch job scheduling and queue management
25+
- **open-telemetry-addon**: Deploys OpenTelemetry collectors for comprehensive observability and metrics collection
26+
- **resource-usage-collect-addon**: Collects and aggregates resource usage metrics across managed clusters
27+
28+
Each addon directory contains its own README with specific installation and usage instructions.
1229

1330
## Onboarding a New Project
1431

@@ -33,7 +50,7 @@ All projects must define the following `make` targets:
3350
- `verify`: Import statement formatting verification using `gci` and static code analysis and linting using `golangci-lint`
3451
- `build`: Compile the Go application into a statically linked binary with debug information stripped for optimal container deployment
3552
- `test-unit`: Invoke unit tests and return an exit code accordingly.
36-
- `test-chart`: Invoke scripts to verify your chart can be installed succefully.
53+
- `test-chart`: Invoke scripts to verify your chart can be installed successfully.
3754
- `test-e2e`: Invoke end-to-end tests and return an exit code accordingly.
3855
- `image`: Build all container image.
3956
- `image-push`: Push all container images.
@@ -76,10 +93,10 @@ See [Release](./.github/workflows/release.yml), [ReleaseImage](./.github/workflo
7693

7794
## Governance
7895

79-
- addon-contrib is a sub-project of the OCM main project, complying with the rules of OCM main projects.
80-
- addon-contrib does not have independent leadership, adopting the same leadership strategy as the OCM main project.
81-
82-
## Repository Structure
83-
84-
The repository is organized into directories, each containing the source code and configuration files for a specific addon.
96+
addon-contrib operates under the governance structure of the Open Cluster Management (OCM) project:
8597

98+
- **Project Status**: addon-contrib is a sub-project of the OCM main project and complies with all OCM project rules and guidelines
99+
- **Leadership**: addon-contrib does not have independent leadership and follows the same leadership strategy as the OCM main project
100+
- **Maintainership**: Each addon has its own maintainers listed in the respective OWNERS files, while overall repository governance follows OCM standards
101+
- **Community Guidelines**: All contributions must adhere to the OCM Code of Conduct and contribution guidelines
102+
- **Decision Making**: Technical decisions follow the same consensus-based approach used across the OCM ecosystem

0 commit comments

Comments
 (0)