LFX V2 Committee Service

This repository contains the source code for the LFX v2 platform committee service.

Overview

The LFX v2 Committee Service is a RESTful API service that manages committees within the Linux Foundation's LFX platform. It provides endpoints for creating, reading, updating, and deleting committees with built-in authorization and audit capabilities. Committees are associated with projects and can have hierarchical structures with parent-child relationships.

File Structure

├── .github/                        # Github files
│   └── workflows/                  # Github Action workflow files
├── charts/                         # Helm charts for running the service in kubernetes
├── cmd/                            # Services (main packages)
│   └── committee-api/              # Committee service code
│       ├── design/                 # API design specifications (Goa)
│       ├── service/                # Service implementation
│       ├── main.go                 # Application entry point
│       └── http.go                 # HTTP server setup
├── gen/                            # Generated code from Goa design
├── internal/                       # Internal service packages
│   ├── domain/                     # Domain logic layer (business logic)
│   │   ├── model/                  # Domain models and entities
│   │   └── port/                   # Repository and service interfaces
│   ├── service/                    # Service logic layer (use cases)
│   ├── infrastructure/             # Infrastructure layer
│   │   ├── auth/                   # Authentication implementations
│   │   ├── nats/                   # NATS storage implementation
│   │   └── mock/                   # Mock implementations for testing
│   └── middleware/                 # HTTP middleware components
└── pkg/                            # Shared packages

Key Features

• RESTful API: Full CRUD operations for committee management
• Committee Hierarchies: Support for parent-child committee relationships
• Project Integration: Committees are associated with projects for organizational structure
• Clean Architecture: Follows clean architecture principles with clear separation of domain, service, and infrastructure layers
• NATS Storage: Uses NATS key-value buckets for persistent committee data storage
• Authorization: JWT-based authentication with Heimdall middleware integration
• OpenFGA Support: Fine-grained authorization control for committee access (configurable)
• Health Checks: Built-in /livez and /readyz endpoints
• Request Tracking: Automatic request ID generation and propagation
• Structured Logging: JSON-formatted logs with contextual information
• Committee Settings: Configurable voting, membership, and access control settings

Releases

Creating a Release

To create a new release of the committee service:

1. Update the chart version in charts/lfx-v2-committee-service/Chart.yaml prior to any project releases, or if any change is made to the chart manifests or configuration:

   version: 0.2.0  # Increment this version
   appVersion: "latest"  # Keep this as "latest"

2. After the pull request is merged, create a GitHub release and choose the option for GitHub to also tag the repository. The tag must follow the format v{version} (e.g., v0.2.0). This tag does not have to match the chart version: it is the version for the project release, which will dynamically update the appVersion in the released chart.

3. The GitHub Actions workflow will automatically:

   • Build and publish the container images (committee-api)
   • Package and publish the Helm chart to GitHub Pages
   • Publish the chart to GitHub Container Registry (GHCR)
   • Sign the chart with Cosign
   • Generate SLSA provenance

Important Notes

• The appVersion in Chart.yaml should always remain "latest" in the committed code.
• During the release process, the ko-build-tag.yaml workflow automatically overrides the appVersion with the actual tag version (e.g., v0.2.0 becomes 0.2.0).
• Only update the chart version field when making releases - this represents the Helm chart version.
• The container image tags are automatically managed by the consolidated CI/CD pipeline using the git tag.
• Both container images (committee-api) and the Helm chart are published together in a single workflow.

Development

To contribute to this repository:

1. Fork the repository
2. Commit your changes to a feature branch in your fork. Ensure your commits are signed with the Developer Certificate of Origin (DCO). You can use the git commit -s command to sign your commits.
3. Ensure the chart version in charts/lfx-v2-committee-service/Chart.yaml has been updated following semantic version conventions if you are making changes to the chart.
4. Submit your pull request

For detailed development instructions, including local setup, testing, and API development guidelines, see the Committee API README.

License

Copyright The Linux Foundation and each contributor to LFX.

This project’s source code is licensed under the MIT License. A copy of the license is available in LICENSE.

This project’s documentation is licensed under the Creative Commons Attribution 4.0 International License (CC-BY-4.0). A copy of the license is available in LICENSE-docs.