docs(readme): update managed setup, remove self-hosted part

maximiliantech · maximiliantech · commit 5b82b47ad04f · 2025-03-12T14:55:34.000+01:00
diff --git a/README.md b/README.md
@@ -3,104 +3,13 @@
 # Control Plane Operator
 
 ## About this project
-The Control Plane Operator is a universal Kubernetes Operator which bundles all necessary functionality to install so called `Components` (like Crossplane, External Secrets Operator, etc.) in a managed fashion into a Kubernetes cluster.
+The Control Plane Operator is a universal Kubernetes Operator which bundles all necessary functionality to automate the lifecycle of so called `Components` (like Crossplane, External Secrets Operator, etc.) in a managed fashion into a Kubernetes cluster.
 
-The Control Plane Operator can be used in different flavors and scenarios:
-- [Self-hosted](#self-hosted): You install the Control Plane Operator into your own Kubernetes cluster.
-  * You can install `Components` like Crossplane, External Secrets Operator, etc. via one central [`ControlPlane` API](./config/crd/bases/core.orchestrate.cloud.sap_controlplanes.yaml). For more information see the [Components](#components) section.
-  * You are responsible running and if necessary upgrading the Control Plane Operator.
-- [Managed](#managed): You are using a Managed Control Plane offering, where you order a `ManagedControlPlane` either via an API or via an Onboarding system.
-  
+The Control Plane Operator is part of the openMCP project. It exposes the [`ControlPlane` API](./config/crd/bases/core.orchestrate.cloud.sap_controlplanes.yaml), where `Components` can be configured that should be reconciled on another Kubernetes cluster. With openMCP, the `ControlPlane` is not directly exposed to an end user. Instead, the `ManagedControlPlane` API is the facade. The [mcp-operator](https://github.com/openmcp-project/mcp-operator) is interacting with the `ControlPlane` API.
 
-## Flavors
+## Using the Control Plane Operator in a Managed Setup
 
-### Self-hosted
-
-**PLEASE EXPECT SOME HICK-UPS WHEN SETTING UP THE OPERATOR IN A SELF-HOSTED SCENARIO. The following instructions might not be up-to-date.**
-
-If you want to use the Control Plane Operator in your own Kubernetes cluster, please follow the instructions below.
-Make sure you are connected to a Kubernetes cluster that should serve as ControlPlane environment.
-
-```shell
-# Add helm repo
-helm repo add control-plane-operator-repo \
-    https://helm.example.com/control-plane-operator-repo \
-    --force-update \
-    --username <d/i-user>
-
-# Create namespace where you install the Operator and Secrets
-kubectl create namespace cloud-orchestration
-
-# Create secret to pull Helm Charts from Artifactory
-kubectl create secret docker-registry orchestrator-registry \
-    --namespace cloud-orchestration \
-    --docker-server="docker-registry.example.com/" \
-    --docker-username=<docker user> \
-    --docker-password=<Your token>
-
-# Install FluxCD
-kubectl apply -f https://github.com/fluxcd/flux2/releases/latest/download/install.yaml
-
-# Create secret to pull Crossplane Providers from Artifactory
-kubectl create secret generic artifactory-readonly-basic --type=kubernetes.io/basic-auth --from-literal=username=<docker user> --from-literal=password=<Your token>
-kubectl label secret artifactory-readonly-basic core.orchestrate.cloud.sap/copy-to-cp-namespaces=true
-kubectl annotate secret artifactory-readonly-basic core.orchestrate.cloud.sap/credentials-for-url='https://helm.example.com/control-plane-operator-repo'
-
-# Install the Control Plane Operator into your cluster
-helm upgrade --install co-control-plane-operator control-plane-operator-repo/co-control-plane-operator --namespace cloud-orchestration --set "imagePullSecrets[0].name=orchestrator-registry" --values test/e2e/testdata/values.yaml
-```
-
-After the installation you will see that a Pod will spin up.
-
-Now, you have to install two `ReleaseChannel` resources.
-A `ReleaseChannel` resource defines which version you define should be latest or stable.
-(FYI: The `ReleaseChannel` feature was implemented with as a requirement in a managed setup. This may not seem suitable for a self-hosted environment. There are currently discussions about it. So this could change in the future. Feedback is much appreciated here.)
-
-In the [`config/samples/releasechannel/`](./config/samples/releasechannel) directory you will find two sample `ReleaseChannel` resources.
-You can safely apply them to your cluster with the following command
-```shell
-kubectl apply -f config/samples/releasechannel/
-```
-
-Make sure to keep the `latest` and `stable` `ReleaseChannel` resources up-to-date to your own needs.
-In the `ControlPlane` CR you can define which `ReleaseChannel` of a Component you want to use.
-
-```yaml
-apiVersion: core.orchestrate.cloud.sap/v1beta1
-kind: ControlPlane
-metadata:
-  name: controlplane-sample
-spec:
-  target:
-    # use local cluster
-    serviceAccount: {}
-    fluxServiceAccount:
-      name: flux-deployer
-      namespace: default
-      overrides:
-        host: https://kubernetes.default.svc
-  crossplane: # Remove to disable Crossplane and Providers
-    version: latest
-    providers:
-      - name: provider-kubernetes # IMPORTANT: this name must match the name in the ReleaseChannel!
-        package: xpkg.upbound.io/crossplane-contrib/provider-kubernetes
-        version: latest # this will install version v0.13.0 (defined in ReleaseChannel "latest") - see above
-  btpServiceOperator: # Remove to disable the BTP Service Operator
-    version: stable
-  certManager: # Remove to disable Cert Manager
-    version: stable
-  externalSecretsOperator: # Remove to disable External Secrets Operator
-    version: stable
-  kyverno: # Remove to disable Kyverno
-    version: stable
-```
-**Note:** Currently, it is only possible to install Crossplane Providers which are Open Source via the ControlPlane resource. We are working on the fix. In the meantime, you can go ahead and install them via the `Provider` CRD from Crossplane itself.
-
-If you apply the `ControlPlane` CR, the Control Plane Operator will start to install the `Components` into your cluster.
-
-### Managed
-
-With the Managed setup, we will use this Operator in our landscape to provide a new API called `ManagedControlPlane`.
+With the Managed setup, we will use this Operator in our OpenMCP landscape to provide a new API called `ManagedControlPlane`.
 
 With the `ManagedControlPlane` you will also have two different cluster setups how the MCP will look like:
 - Dedicated Cluster Setup - A standard Kubernetes cluster
@@ -121,7 +30,6 @@ C4Context
         Node(clusterscoped, "Cluster Scoped Resources", "") {
             SystemDb(controlplane, "ControlPlane Resource", "the ordered Control Plane", "")
             SystemDb(releasechannelStable, "ReleaseChannel Resource", "stable", "")
-            SystemDb(releasechannelLatest, "ReleaseChannel Resource", "latest", "")
         }
     }
 
@@ -137,7 +45,6 @@ C4Context
     UpdateElementStyle(namespace, $borderColor="orange", $fontColor="red")
     UpdateElementStyle(clusterscoped, $borderColor="grey")
     Rel(cpOperator, releasechannelStable, "watches")
-    Rel(cpOperator, releasechannelLatest, "watches")
     UpdateRelStyle(cpOperator, others, $textColor="white", $lineColor="white", $offsetX="5")
     UpdateLayoutConfig($c4ShapeInRow="2", $c4BoundaryInRow="10")
 ```
@@ -155,7 +62,6 @@ C4Context
         Node(clusterscoped, "Cluster Scoped Resources", "") {
             SystemDb(controlplane, "ControlPlane Resource", "the ordered Control Plane", "")
             SystemDb(releasechannelStable, "ReleaseChannel Resource", "stable", "")
-            SystemDb(releasechannelLatest, "ReleaseChannel Resource", "latest", "")
         }
 
         Node(namespace, "Managed ControlPlane Namespace", "") {
@@ -184,26 +90,11 @@ C4Context
     UpdateElementStyle(clusterscoped, $borderColor="grey")
     Rel(cpOperator, controlplane, "watches")
     Rel(cpOperator, releasechannelStable, "watches")
-    Rel(cpOperator, releasechannelLatest, "watches")
     Rel(cpOperator, syncer, "reconciles")
     UpdateRelStyle(cpOperator, others, $textColor="white", $lineColor="white", $offsetX="5")
     UpdateLayoutConfig($c4ShapeInRow="2", $c4BoundaryInRow="10")
 ```
 
-## Components
-
-You can install the following Components via the Control Plane Operator:
-
-| Component                                                                             | Supported in Self-hosted scenario | Supported in Managed scenario  |
-| ------------------------------------------------------------------------------------- | :-------------------------------: | :----------------------------: |
-| [Crossplane](./pkg/controlplane/components/crossplane_component.go)                   |                 ✅                 |               ✅                |
-| [Crossplane Providers](./pkg/controlplane/components/crossplaneprovider_component.go) |  ✅  (just open source providers)  | ✅ (just open source providers) |
-| [External Secrets Operator](./pkg/controlplane/components/eso_component.go)           |                 ✅                 |               ✅                |
-| [BTP Service Operator](./pkg/controlplane/components/btpso_component.go)              |                 ✅                 |               ✅                |
-| [Cert Manager](./pkg/controlplane/components/cert_manager_component.go)               |                 ✅                 |               ✅                |
-| [Kyverno](./pkg/controlplane/components/kyverno_component.go)                         |                 ✅                 |               ✅                |
-| [Flux](./pkg/controlplane/components/flux_component.go)                               |                 ❌                 |               ✅                |
-
 ## Requirements and Setup
 
 You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for
