Task: Implement deploy-flux command for openmcp-bootstrapper

[reshnm]

Understand the Task

Description

The deploy-flux command has the following arguments:

• componentLocation: This is the location from the openmcp-root-component can be consumed. This is configurable so that it is possible to deploy different variants or even add-ons that are not part of the github.com/openmcp-project/openmcp component. The componentLocation also contains the version of the component.
• deploymentTemplates: This argument specifies the resource name within the the openmcp-root-component that contains the deployment templates that are being used to create the deployment specification in the target git repository
• deploymentRepository: This argument represents a git repository url where the deployment specification will be stored. This will be used in the fluxcd GitSource for .spec.url.
• deploymentRepositoryBranch: The branch in the deploymentRepository where deployment specification is stored. This will be used in the fluxcd GitSource for .spec.ref.branch.

and the following flags:

• --ocm-config: The OCM configuration to use
• --git-credentials: A git credentials configuration file that configure basic auth, personal access token, ssh private key. This will be used in the fluxcd GitSource for spec.secretRef to authenticate against the deploymentRepository. If not set, no authentication will be configured.
• --kubeconfig: The kubeconfig of the Kubernetes cluster on which the flux deployment will be created/updated. If not set, the current context will be used.
• --fluxcd-namespace: The namespace on the Kubernetes cluster in which the namespaced fluxcd resources will be deployed. Default flux-system.

The general flow of this command is:

1. download the openmcp-root-component via the OCM cli
2. extract the deployment templates resource out of the openmcp-root-component
3. find the deployment template for fluxcd in the template resource
4. execute the fluxcd deployment template. The deployment template execution will receive input values like the OCI image locations of the individual deployments (helm controller, kustomize controller, source controller)
5. apply the templated resources to the target Kubernetes cluster in the specified namespace
6. create a fluxcd GitSource for the given deploymentRepository and deploymentRepositoryBranch (and --git-credentials if set) in the fluxcd namespace.

Any further valuable resources.

No response

What is required to accept the Task as done.

Done Criteria

• Code has been reviewed by other team members
• Internal technical Documentation created/updated
• New / changed code is documented
• Unit Tests created for new code or existing Unit Tests updated
• Integration Test Suite updated
• Enduser Documentation updated (if applicable)
• Successful demonstration in Review

[robertgraeff]

August 25

• Command is created (with args and flags), basis implementation is working.
• Pull request feat: deploy-flux command
• Requires further coordination with the tasks about OCM component github.com/openmcp-project/gitops-templates, which contains the templates for the flux deployment.

[robertgraeff]

Pull request feat: flux controller images:

• Adjust the deploy-flux command so that it has the same arguments as the manage-deployment-repo command:
  • the path to a config file which contains most of the settings (same config file as for the manage-deployment-repo command)
  • path to a git config file
  • path to a ocm config file
  • path to the kubeconfig of the platform cluster
• Adjust the deploy logic of the command so that:
  • it downloads the templates from the gitops-templates component
  • builds the values for the templating - this involves determining the images of the fluxcd deployments
  • executes the templating
  • executes the kustomization
  • and applies the result to the platform cluster (manifests of the fluxcd controllers, and resources to establish the flux sync)
• Deploy more fluxcd controllers: not only source controller, kustomize controller, helm controller, but additionally notification controller, image-reflector controller, and image-automation controller.
• Unit tests

[reshnm]

The openmcp bootstrapper is now available here: github.com/openmcp-project/bootstrapper
Documentation PR: openmcp-project/docs#17

[In-Ko]

Doc PR merged, closing this task