feat: Add Flux CD provider for service topology and alert integration #4721

Kunal-Darekar · 2025-05-07T04:13:32Z

This PR adds a new provider for Flux CD, similar to the existing ArgoCD provider. Flux CD is a GitOps tool for Kubernetes that provides continuous delivery through automated deployment, monitoring, and management of applications.

Features Implemented

Topology Integration

Pull topology data from Flux CD resources (GitRepositories, HelmRepositories, Kustomizations, HelmReleases)
Create a graph of services with proper dependencies
Categorize resources as "source" or "deployment"

Alert Integration

Pull alerts from Kubernetes events related to Flux CD controllers
Pull alerts from resource status conditions (non-ready resources)
Determine alert severity based on event reason
Provide detailed alert information

Authentication Options

Support for kubeconfig file content
Support for API server URL and token
Support for in-cluster configuration
Support for default kubeconfig file

Provider Metadata

Get Flux CD version
Get installed controllers
Get resource counts

Implementation Details

Created a new provider class FluxcdProvider that extends BaseTopologyProvider
Implemented authentication with Kubernetes API
Implemented methods to get Flux CD resources (GitRepositories, Kustomizations, HelmReleases)
Implemented the pull_topology method to create a topology map
Implemented the get_alerts method to pull alerts from Flux CD
Added comprehensive error handling and logging
Added unit tests for all functionality
Added documentation

Documentation

Added a README.md file with comprehensive documentation
Added a documentation file for the Keep documentation site

Testing

Added unit tests for all functionality
Tested with a local Kubernetes cluster running Flux CD

/fixes #4632
/claim #4632

vercel · 2025-05-07T04:13:36Z

@Kunal-Darekar is attempting to deploy a commit to the KeepHQ Team on Vercel.

A member of the Team first needs to authorize it.

CLAassistant · 2025-05-07T04:13:39Z

All committers have signed the CLA.

Kunal-Darekar · 2025-05-07T04:20:02Z

@talboren Could you please review this Flux CD provider implementation when you have a moment? Thanks!

talboren · 2025-05-07T11:49:33Z

@talboren Could you please review this Flux CD provider implementation when you have a moment? Thanks!

The implementation looks good! but there are still failing tests, could you please fix them? I think @Kiryous and @Matvey-Kuk can help you with the test-workflow-examples and test-docs, respectively, if you need help.

…xCD workflow example

Kunal-Darekar · 2025-05-07T14:03:03Z

Hey @talboren , Thanks for the feedback! I've fixed the failing tests — please have a look when you get a chance. Let me know if anything else needs adjusting.

vercel · 2025-05-08T11:18:40Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
keep	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 15, 2025 7:58am

talboren · 2025-05-08T11:24:47Z

Hey @talboren , Thanks for the feedback! I've fixed the failing tests — please have a look when you get a chance. Let me know if anything else needs adjusting.

@Kunal-Darekar looks like it is still failing..

…able

keep-ui/entities/workflows/model/yaml.schema.ts

keep/providers/fluxcd_provider/requirements.txt

tests/e2e_tests/incidents_alerts_tests/incidents_alerts_setup.py

Matvey-Kuk

May I ask you to exclude fixes for docs tests and general tests to the separate PR?

scripts/docs_render_provider_snippets.py

tests/e2e_tests/incidents_alerts_tests/incidents_alerts_setup.py

Kiryous · 2025-05-15T07:54:02Z

hey @Kunal-Darekar! Thank you so much for the thoughtful contribution! Left a few comments, let's address them and merge 🧡

Co-authored-by: Kirill Chernakov <[email protected]> Signed-off-by: Kunal Darekar <[email protected]>

1. Add UTF-8 encoding to file operations in docs_render_provider_snippets.py 2. Normalize path separators for cross-platform compatibility 3. Improve test reliability by increasing sleep time and max attempts 4. Add detailed comments explaining the changes These changes address the feedback from PR keephq#4721 review.

Add Flux CD provider with icon naming fix

fe1f41d

algora-pbc bot added the 🙋 Bounty claim label May 7, 2025

dosubot bot added the size:XXL This PR changes 1000+ lines, ignoring generated files. label May 7, 2025

algora-pbc bot mentioned this pull request May 7, 2025

[🔌 Provider]: Flux CD #4632

Open

dosubot bot added Documentation Improvements or additions to documentation Feature A new feature hacktoberfest-accepted Provider Providers related issues labels May 7, 2025

Fix Flux CD icon filename

7a58015

talboren and others added 6 commits May 7, 2025 14:49

Merge branch 'main' into feature/fluxcd-provider

a164b77

Add .ruff.toml to exclude YAML and MDX files from linting and add Flu…

a2e7333

…xCD workflow example

Fix FluxCD provider code and documentation

bcb122e

Fix exception handling in FluxCD provider

27badcf

Update FluxCD workflow example to match new schema format

939a46d

Fix .ruff.toml configuration format

c06fc43

Merge branch 'main' into feature/fluxcd-provider

24fd643

Kunal-Darekar and others added 6 commits May 8, 2025 17:03

Merge branch 'main' into feature/fluxcd-provider

34358e7

fix: Make Flux CD provider robust when no Kubernetes cluster is avail…

1f7de37

…able

Merge remote changes and fix Flux CD provider

51aa918

Fix FluxCD provider test name mangling issues

9bc38c9

Fix FluxCD provider test name mangling issues

92dea39

Fix FluxCD provider documentation and ruff configuration

80b6252

Kunal-Darekar force-pushed the feature/fluxcd-provider branch from 981e17f to 80b6252 Compare May 8, 2025 19:41

Kunal-Darekar and others added 6 commits May 10, 2025 13:58

Merge branch 'main' into feature/fluxcd-provider

de7be9d

Merge branch 'main' into feature/fluxcd-provider

54a42f2

fix: Fix FluxCD provider tests and improve e2e test reliability

7fa10db

Merge remote changes into local branch

80c9ad1

Fix FluxCD provider documentation

64a571c

Fix FluxCD provider authentication configuration

940c53d

Kunal-Darekar force-pushed the feature/fluxcd-provider branch from a4b2672 to 940c53d Compare May 10, 2025 22:41

Kunal-Darekar added 3 commits May 11, 2025 04:42

Fix FluxCD provider initialization and documentation snippets

1b50a1c

Fix path separators in documentation snippets

9ee7d76

Resolve merge conflict in yaml.schema.ts

74fed44

Kiryous reviewed May 15, 2025

View reviewed changes

keep-ui/entities/workflows/model/yaml.schema.ts Outdated Show resolved Hide resolved

Kiryous reviewed May 15, 2025

View reviewed changes

keep-ui/entities/workflows/model/yaml.schema.ts Outdated Show resolved Hide resolved

Kiryous reviewed May 15, 2025

View reviewed changes

keep/providers/fluxcd_provider/requirements.txt Show resolved Hide resolved

Kiryous reviewed May 15, 2025

View reviewed changes

tests/e2e_tests/incidents_alerts_tests/incidents_alerts_setup.py Show resolved Hide resolved

Matvey-Kuk requested changes May 15, 2025

View reviewed changes

scripts/docs_render_provider_snippets.py Show resolved Hide resolved

scripts/docs_render_provider_snippets.py Show resolved Hide resolved

tests/e2e_tests/incidents_alerts_tests/incidents_alerts_setup.py Show resolved Hide resolved

vercel bot deployed to Preview May 15, 2025 07:58 View deployment

Kunal-Darekar force-pushed the feature/fluxcd-provider branch 2 times, most recently from e882703 to 74fed44 Compare May 15, 2025 12:01

Kunal-Darekar and others added 3 commits May 15, 2025 17:37

Update keep-ui/entities/workflows/model/yaml.schema.ts

47b150f

Co-authored-by: Kirill Chernakov <[email protected]> Signed-off-by: Kunal Darekar <[email protected]>

Update keep-ui/entities/workflows/model/yaml.schema.ts

c881e89

Co-authored-by: Kirill Chernakov <[email protected]> Signed-off-by: Kunal Darekar <[email protected]>

Merge branch 'main' into feature/fluxcd-provider

bdb8dfc

Kunal-Darekar requested a review from Kiryous May 15, 2025 15:39

Kunal-Darekar mentioned this pull request May 15, 2025

Fix test issues: Improve UTF-8 encoding and test reliability #4813

Open

Kunal-Darekar requested a review from Matvey-Kuk May 15, 2025 19:51

Kunal-Darekar added 4 commits May 16, 2025 01:40

Merge branch 'main' into feature/fluxcd-provider

9bfbaa5

Merge branch 'main' into feature/fluxcd-provider

7914506

Merge branch 'main' into feature/fluxcd-provider

4ad6cfe

Merge branch 'main' into feature/fluxcd-provider

581ff4f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add Flux CD provider for service topology and alert integration #4721

feat: Add Flux CD provider for service topology and alert integration #4721

Kunal-Darekar commented May 7, 2025

vercel bot commented May 7, 2025

CLAassistant commented May 7, 2025 •

edited

Loading

Kunal-Darekar commented May 7, 2025

talboren commented May 7, 2025

Kunal-Darekar commented May 7, 2025

vercel bot commented May 8, 2025 •

edited

Loading

talboren commented May 8, 2025

Matvey-Kuk left a comment •

edited

Loading

Kiryous commented May 15, 2025

feat: Add Flux CD provider for service topology and alert integration #4721

Are you sure you want to change the base?

feat: Add Flux CD provider for service topology and alert integration #4721

Conversation

Kunal-Darekar commented May 7, 2025

Features Implemented

Topology Integration

Alert Integration

Authentication Options

Provider Metadata

Implementation Details

Documentation

Testing

vercel bot commented May 7, 2025

CLAassistant commented May 7, 2025 • edited Loading

Kunal-Darekar commented May 7, 2025

talboren commented May 7, 2025

Kunal-Darekar commented May 7, 2025

vercel bot commented May 8, 2025 • edited Loading

talboren commented May 8, 2025

Matvey-Kuk left a comment • edited Loading

Choose a reason for hiding this comment

Kiryous commented May 15, 2025

CLAassistant commented May 7, 2025 •

edited

Loading

vercel bot commented May 8, 2025 •

edited

Loading

Matvey-Kuk left a comment •

edited

Loading