Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 22 additions & 11 deletions docs/reference/00-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,20 +56,12 @@ Resources that end users interact with to consume platform capabilities.
<a href="/reference/core/project" className="reference-link">View CRD →</a>
</div>

<div className="reference-card">
<div className="reference-icon-container reference-icon-container-standard">
<img src="/img/platform/tower.png" alt="ServiceProvider" className="reference-icon-large" />
</div>
<h3>ServiceProvider</h3>
<p>Delivers consumable services to customers via ControlPlanes.</p>
<a href="/reference/operator/providers/serviceprovider" className="reference-link">View CRD →</a>
</div>

</div>

## Service Providers
## Services

Available service providers that can be deployed within control planes.
Available services that can be deployed within control planes.

<div className="reference-grid">

Expand All @@ -91,6 +83,15 @@ Available service providers that can be deployed within control planes.
<a href="/reference/services/landscaper" className="reference-link">View CRD →</a>
</div>

<div className="reference-card">
<div className="reference-icon-container reference-icon-container-standard">
<img src="/img/platform/tower.png" alt="External Secrets Operator" className="reference-icon-large" />
</div>
<h3>External Secrets Operator</h3>
<p>Secrets synchronisation service using the External Secrets Operator.</p>
<a href="/reference/services/external-secrets" className="reference-link">View CRD →</a>
</div>

<div className="reference-card">
<div className="reference-icon-container reference-icon-container-standard">
<img src="/img/platform/tower_velero.png" alt="Velero" className="reference-icon-large" />
Expand Down Expand Up @@ -128,6 +129,15 @@ Resources that platform operators use to configure and manage the platform infra

<div className="reference-grid">

<div className="reference-card">
<div className="reference-icon-container reference-icon-container-standard">
<img src="/img/platform/tower.png" alt="ServiceProvider" className="reference-icon-large" />
</div>
<h3>ServiceProvider</h3>
<p>Delivers consumable services to end users via ControlPlanes.</p>
<a href="/reference/operator/providers/serviceprovider" className="reference-link">View CRD →</a>
</div>

<div className="reference-card">
<div className="reference-icon-container reference-icon-container-standard">
<img src="/img/platform/hangar_gardener.png" alt="ClusterProvider" className="reference-icon-large" />
Expand Down Expand Up @@ -188,9 +198,10 @@ CRD definitions are maintained across multiple repositories:

- **Core & Operator CRDs**: [openmcp-operator](https://github.com/openmcp-project/openmcp-operator/tree/main/api/crds/manifests)
- **Project & Workspace CRDs**: [project-workspace-operator](https://github.com/openmcp-project/project-workspace-operator/tree/main/api/crds/manifests)
- **Service Providers**:
- **Services**:
- Crossplane: [service-provider-crossplane](https://github.com/openmcp-project/service-provider-crossplane/tree/main/api/crds/manifests)
- Landscaper: [service-provider-landscaper](https://github.com/openmcp-project/service-provider-landscaper/tree/main/api/crds/manifests)
- Velero: [service-provider-velero](https://github.com/openmcp-project/service-provider-velero/tree/main/api/crds/manifests)
- OCM: [service-provider-ocm](https://github.com/open-component-model/service-provider-ocm/tree/main/api/crds/manifests)
- kro: [service-provider-kro](https://github.com/openmcp-project/service-provider-kro/tree/main/api/crds/manifests)
- External Secrets Operator: [service-provider-external-secrets](https://github.com/openmcp-project/service-provider-external-secrets/tree/main/api/crds/manifests)
2 changes: 1 addition & 1 deletion docs/reference/services/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Service Providers",
"label": "Services",
"position": 4
}
13 changes: 8 additions & 5 deletions docs/reference/services/crossplane.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,14 @@ apiVersion: crossplane.services.open-control-plane.io/v1alpha1
kind: Crossplane
metadata:
name: my-crossplane
namespace: my-workspace
spec:
crossplaneVersion: "1.14.0"
providerConfigs:
- name: default
version: "1.19.0"
providers:
- name: provider-aws
version: "1.0.0"
functions:
- name: function-patch-and-transform
version: "0.8.0"
```

The Crossplane service provider manages the installation and lifecycle of Crossplane and its providers within your control plane.
The Crossplane service provider manages the installation and lifecycle of Crossplane, its providers, and functions within your control plane.
42 changes: 42 additions & 0 deletions docs/reference/services/external-secrets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
sidebar_position: 3
id: external-secrets
---

import CRDViewerCompact from '@site/src/components/CRDViewerCompact';

# External Secrets Operator

<div className="crd-header-container">
<img src="/img/platform/tower.png" alt="External Secrets Operator" className="crd-header-icon" />
<div className="crd-header-text">
<p>Delivers the External Secrets Operator as a service within ControlPlanes, enabling secrets synchronisation from external vaults.</p>
</div>
</div>

**API Group:** `external-secrets.services.open-control-plane.io`
**API Version:** `v1alpha1`
**Kind:** `ExternalSecretsOperator`

<CRDViewerCompact
crdUrl="https://raw.githubusercontent.com/openmcp-project/service-provider-external-secrets/main/api/crds/manifests/external-secrets.services.open-control-plane.io_externalsecretsoperators.yaml"
name="ExternalSecretsOperator"
description="External Secrets Operator service provider resource"
exampleUrl="https://raw.githubusercontent.com/openmcp-project/service-provider-external-secrets/main/test/e2e/onboarding/eso-mcp-a.yaml"
/>

## Usage

Deploy the External Secrets Operator within a control plane:

```yaml
apiVersion: external-secrets.services.open-control-plane.io/v1alpha1
kind: ExternalSecretsOperator
metadata:
name: my-eso
namespace: my-workspace
spec:
version: "v2.1.0"
```

The External Secrets Operator service provider manages the installation and lifecycle of ESO within your control plane, enabling workloads to synchronise secrets from external providers such as AWS Secrets Manager, HashiCorp Vault, and Azure Key Vault.
2 changes: 1 addition & 1 deletion docs/reference/services/kro.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 6
id: kro
---

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/services/ocm.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 5
id: ocm
---

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/services/velero.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 3
sidebar_position: 4
id: velero
---

Expand Down