Addon-Contrib

This repository hosts a collection of Open Cluster Management (OCM) addons for staging and testing purposes.

Overview

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

Addons in this repository are designed to extend the capabilities of OCM deployments, providing specialized functionality for workload scheduling, application deployment, observability, device management, data orchestration, and federated learning across multiple clusters.

Available Addons

This repository contains the following OCM addons:

• argocd-agent-addon: Integrates Argo CD Agent for highly scalable application deployment across managed clusters
• clusternet-addon: Provides Clusternet integration for enhanced cluster networking capabilities
• device-addon: Enables device management functionality within the OCM ecosystem
• federated-learning-controller: Implements federated learning capabilities across distributed clusters
• fluid-addon: Integrates Fluid for data orchestration and management in multicluster environments
• hellospoke-addon: A simple example addon demonstrating basic OCM addon development patterns
• kueue-addon: Integrates Kueue for advanced multicluster batch job scheduling and queue management
• open-telemetry-addon: Deploys OpenTelemetry collectors for comprehensive observability and metrics collection
• resource-usage-collect-addon: Collects and aggregates resource usage metrics across managed clusters

Each addon directory contains its own README with specific installation and usage instructions.

Onboarding a New Project

To onboard a new addon-contrib project:

1. If not already discussed with maintainers, open an issue to propose your idea.
2. Once acknowledged, create a folder named after your project and add your code/docs.
3. Add an OWNERS file listing the new project's maintainers.
4. Create a PR with a brief project overview and confirm the OWNERS file is present.
5. An OCM maintainer will review and merge the PR.

GitHub Actions

All projects must follow certain conventions to ensure compatibility with the addon-contrib repository's Github Actions workflows.

Refer to the Test and E2E workflows for exact details.

make targets

All projects must define the following make targets:

• verify: Import statement formatting verification using gci and static code analysis and linting using golangci-lint
• build: Compile the Go application into a statically linked binary with debug information stripped for optimal container deployment
• test-unit: Invoke unit tests and return an exit code accordingly.
• test-chart: Invoke scripts to verify your chart can be installed successfully.
• test-e2e: Invoke end-to-end tests and return an exit code accordingly.
• image: Build all container image.
• image-push: Push all container images.
• image-manifest: Create annotate and push multi-architecture manifests for all images.

Dockerfiles

All Dockerfiles for the project must reside under <project_name>/ and the default Dockerfile must be named Dockerfile.

Helm Charts

Any projects that require a Helm chart must be structured as follows:

<project_name>
└── charts
    └── <project_name> # chart name must match project directory name
        ├── Chart.yaml
        ├── templates
        └── values.yaml

Furthermore, values.yaml must contain the following top-level values:

image:
  repository: <project_image_repository>
  tag: <project_image_tag>

This is required so that a locally built image can be used consistently for Helm chart testing.

See the test-chart job in the Test workflow for further details.

Release a Sub Project

Release tags must follow the format <sub-project-name>/v*.*.*. For example, to release kueue-addon v0.1.0, use tag kueue-addon/v0.1.0.

See Release, ReleaseImage and ChartUpload workflows for details.

Governance

addon-contrib operates under the governance structure of the Open Cluster Management (OCM) project:

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