EPIC: Implement OpenMCP bootstrapper without the usage of OCM K8S Toolkit

[reshnm]

Understand the Task

Since the OCM K8S Toolkit wil not be GA before we need the initial OpenMCP bootstrapper, we need to implement a OpenMCP bootstrapping implementation that is able to create/update OpenMCP landscapes for test setups/public landscape/private cloud deployments.

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

[In-Ko]

This task depends a bit on the currently ongoing evaluation of the OCM k8s toolkit. We will dig it out again if we see that we require to have a first bootstrapper without the OCM k8s toolkit.

[reshnm]

Assumptions

1. There is a OCM component descriptor github.com/open-project/openmcp, called root component.
2. The root component is stored in the OCI registry ghcr.io/openmcp-project/components, called source registry.
3. There is a target OCI registry, called target registry. Any OCI registry can be used.
4. There is a landscape Git repository, called landscape repository.
5. There is a landscape bootstrapping/update tool, called landscape tool. This can be a script or any other compiled tool. (landscape-tool is only used here for simplification, the name can be changed)
6. There is the ocm cli tool available.
7. The platform cluster is available and there is a kubeconfig file for the platform cluster.

The landscape tool has the following commands:

1. transport-root-component: Transport the root component from the source registry to the target registry.
2. update-landscape-repo: Initialize or update the landscape repository with the
3. deploy-flux-controller: Deploy Flux to the platform cluster.

After calling this commands, the root component has been deployed to the platform cluster.

Root Component Transportation

The landscape tool has a command to transport a version of the root component from the source registry to the target registry. The command is called transport-root-component.
The component is transported recursively, including all dependencies and includes all resources.

After the transport, the root component is available in the target registry with the same name and version as in the source registry.

landscape-tool transport-root-component \
  --source-registry <source-registry> \
  --target-registry <target-registry> \
  --version <version>

Initialize/Update the Landscape Repository

The landscape tool has a command to initialize or update the landscape repository with the transported root component. The command is called update-landscape-repo. The command will work with an empty Git repository or with an existing Git repository where the root component is already initialized for updates.
The command will create all resources necessary for a Flux controller to deploy the root component.
This includes the following resources:

• The openmcp-operator deployment
• A Cluster Provider resource (use the Gardener Cluster Provider for the first version)
• The Cluster Provider Configuration
• A list of configurable Service Providers. (Use service provider landscaper for the first version)
• A Flux GitRepository resource to pull the resources from the landscape repository.
• Flux Kustomization resources to deploy the resources from the landscape repository.

The command will also update all the versions of the OCI images and the OCI image locations in the landscape repository to the version of the root component that was transported to the target registry.

landscape-tool update-landscape-repo \
  --target-registry <target-registry> \
  --version <version> \
  --landscape-repo <landscape-repo> \
  --cluster-provider <cluster-provider> \
  --service-providers <service-provider-1>,<service-provider-2> \

Deploy Flux

The landscape tool has a command to deploy Flux to the platform cluster. The command is called deploy-flux-controller. The command will create all resources necessary for a Flux to deploy the root component.

landscape-tool deploy-flux-controller \
  --landscape-repo <landscape-repo> \
  --platform-cluster-kubeconfig <platform-cluster-kubeconfig>

[reshnm]

Additional Task: Add Flux and the ocm cli to the github.com/openmcp-project/openmcp component to have it available in air gapped environments.

If we have the initial setup working, we have to make sure, that we can ship the landscape-tool to air gapped environments. This means it must be contained in a OCI Image that can be transported to air gapped environments.

[robertgraeff]

[In-Ko]

@reshnm : As discussed in the Refinement, please try to split up this Epic into individual tasks (and have this Epic as parent issue please), so then we refine the individual tasks next week.