This fork is used by the
qdrant-cloud-agent. The main
reason behind forking the upstream project is to be able to distribute the CRDs of this
project without risk of collision in case the customer is using Flux CD in their
K8s cluster. The main change between the fork and upstream consist of renaming the
API group names, replacing the ones from fluxcd (ex: helm.toolkit.fluxcd.io
)
by our custom ones.
- Configure and fetch upstream/main.
- Create your development branch from origin/main and merge upstream/main into
it. You can run the merge with
-X theirs
option. - Solve the git conflicts if any.
- As there might be new files or content added in upstream, we might need to
rename groups again. You can do that executing
./scripts/rename-api-groups.sh
. - You are probably updating source-controller as well. If that's the case, you
need to update the dependency in this project.
- Update the
SOURCE_BRANCH
var in the Makefile with the new commit - Update go.mod:
go mod edit -replace github.com/fluxcd/source-controller/api=github.com/qdrant/fluxcd-source-controller/api@PLACE_HERE_THE_NEW_COMMIT_SHA
- Update the
- Run
go mod tidy
to clean up the dependencies and execute the tests of the project withmake test
. - Ideally, they are passing. Otherwise, you need to work on fixing any possible issue.
- Push your development branch. After that, you would need to test it using it in the cloud-agent to confirm everything works as expected.
- Once you confirm it works fine, create a PR for review.
- Note for the reviewer: The merge commit from upstream/main doesn't make sense to review it. Focus on the commits with the changes relevant for the project.
The helm-controller is a Kubernetes operator, allowing one to declaratively manage Helm chart releases. It is part of a composable GitOps toolkit and depends on source-controller to acquire the Helm charts from Helm repositories.
The desired state of a Helm release is described through a Kubernetes Custom
Resource named HelmRelease
. Based on the creation, mutation or removal of a
HelmRelease
resource in the cluster, Helm actions are performed by the
operator.
- Watches for
HelmRelease
objects and generatesHelmChart
objects - Supports
HelmChart
artifacts produced fromHelmRepository
,GitRepository
andBucket
sources - Fetches artifacts produced by source-controller from
HelmChart
andOCIRepository
objects - Watches
HelmChart
objects for revision changes (including semver ranges for charts fromHelmRepository
sources) - Performs automated Helm actions, including Helm tests, rollbacks and uninstalls
- Offers extensive configuration options for automated remediation (rollback, uninstall, retry) on failed Helm install, upgrade or test actions
- Runs Helm install/upgrade in a specific order, taking into account the
depends-on relationship defined in a set of
HelmRelease
objects - Reports Helm release statuses (alerting provided by notification-controller)
- Built-in Kustomize compatible Helm post renderer, providing support for strategic merge, JSON 6902 and images patches
- Supports detecting and correcting in-cluster changes compared to the desired state of the Helm release