Skip to content

Commit c8a31f4

Browse files
authored
docs(bootstrapping): service provider crossplane oci package requirement (#20)
On-behalf-of: @SAP christopher.junk@sap.com Signed-off-by: Christopher Junk <christopher.junk@sap.com>
1 parent 58c27ba commit c8a31f4

File tree

1 file changed

+45
-22
lines changed

1 file changed

+45
-22
lines changed

docs/operators/01-boostrapping.md

Lines changed: 45 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,7 @@ openmcpOperator:
178178
179179
For GitHub use a personal access token with `repo` write permissions.
180180
It is also possible to use a fine-grained token. In this case, it requires read and write permissions for `Contents`.
181+
181182
```yaml title="config/git-config.yaml"
182183
auth:
183184
basic:
@@ -422,6 +423,7 @@ You should see output similar to the following:
422423
NAMESPACE NAME URL AGE READY STATUS
423424
flux-system environments https://github.com/<your-ourg>/<your-repo> 9m6s True stored artifact for revision 'docs@sha1:...'
424425
```
426+
425427
So we have now successfully configured FluxCD to watch for changes in the specified GitHub repository, using the `environments` custom resource of kind `GitRepository`.
426428
Now let's get the status of the Kustomization in the Kind cluster.
427429

@@ -671,23 +673,33 @@ openmcpOperator:
671673

672674
Create a new folder named `extra-manifests` in the configuration folder. Then create a file named `crossplane-provider.yaml` with the following content, and save it in the new `extra-manifests` folder.
673675

676+
:::info
677+
Note that service provider crossplane only supports the installation of crossplane from an OCI registry. Replace the chart locations in the `ProviderConfig` with the OCI registry where you mirror your crossplane chart versions. OpenMCP will provide this as part of an open source [Releasechannel](https://github.com/openmcp-project/backlog/issues/323) in an upcoming update.
678+
:::
679+
674680
```yaml title="config/extra-manifests/crossplane-provider.yaml"
675681
apiVersion: crossplane.services.openmcp.cloud/v1alpha1
676682
kind: ProviderConfig
677683
metadata:
678684
name: default
679685
spec:
680-
chart:
681-
repository: "https://charts.crossplane.io/stable"
682-
name: crossplane
683-
availableVersions:
684-
- v1.20.0
685-
- v1.19.0
686-
availableProviders:
687-
- name: provider-kubernetes
688-
package: xpkg.upbound.io/upbound/provider-kubernetes
689-
versions:
690-
- v0.16.0
686+
versions:
687+
- version: v2.0.2
688+
chart:
689+
url: ghcr.io/openmcp-project/charts/crossplane:2.0.2
690+
image:
691+
url: xpkg.crossplane.io/crossplane/crossplane:v2.0.2
692+
- version: v1.20.1
693+
chart:
694+
url: ghcr.io/openmcp-project/charts/crossplane:1.20.1
695+
image:
696+
url: xpkg.crossplane.io/crossplane/crossplane:v1.20.1
697+
providers:
698+
availableProviders:
699+
- name: provider-kubernetes
700+
package: xpkg.upbound.io/upbound/provider-kubernetes
701+
versions:
702+
- v0.16.0
691703
```
692704

693705
Run the `openmcp-bootstrapper` CLI tool to update the Git repository and deploy the crossplane service provider to the Kind cluster.
@@ -1455,6 +1467,7 @@ You should see output similar to the following:
14551467
NAMESPACE NAME URL AGE READY STATUS
14561468
flux-system environments https://github.com/<your-ourg>/<your-repo> 9m6s True stored artifact for revision 'docs@sha1:...'
14571469
```
1470+
14581471
So we have now successfully configured FluxCD to watch for changes in the specified GitHub repository, using the `environments` custom resource of kind `GitRepository`.
14591472
Now let's get the status of the Kustomization in the Kind cluster.
14601473

@@ -1905,23 +1918,33 @@ openmcpOperator:
19051918

19061919
Then create a file named `crossplane-provider.yaml` with the following content, and save it in the new `extra-manifests` folder.
19071920

1921+
:::info
1922+
Note that service provider crossplane only supports the installation of crossplane from an OCI registry. Replace the chart locations in the `ProviderConfig` with the OCI registry where you mirror your crossplane chart versions. OpenMCP will provide this as part of an open source [Releasechannel](https://github.com/openmcp-project/backlog/issues/323) in an upcoming update.
1923+
:::
1924+
19081925
```yaml title="config/extra-manifests/crossplane-provider.yaml"
19091926
apiVersion: crossplane.services.openmcp.cloud/v1alpha1
19101927
kind: ProviderConfig
19111928
metadata:
19121929
name: default
19131930
spec:
1914-
chart:
1915-
repository: "https://charts.crossplane.io/stable"
1916-
name: crossplane
1917-
availableVersions:
1918-
- v1.20.0
1919-
- v1.19.0
1920-
availableProviders:
1921-
- name: provider-kubernetes
1922-
package: xpkg.upbound.io/upbound/provider-kubernetes
1923-
versions:
1924-
- v0.16.0
1931+
versions:
1932+
- version: v2.0.2
1933+
chart:
1934+
url: ghcr.io/openmcp-project/charts/crossplane:2.0.2
1935+
image:
1936+
url: xpkg.crossplane.io/crossplane/crossplane:v2.0.2
1937+
- version: v1.20.1
1938+
chart:
1939+
url: ghcr.io/openmcp-project/charts/crossplane:1.20.1
1940+
image:
1941+
url: xpkg.crossplane.io/crossplane/crossplane:v1.20.1
1942+
providers:
1943+
availableProviders:
1944+
- name: provider-kubernetes
1945+
package: xpkg.upbound.io/upbound/provider-kubernetes
1946+
versions:
1947+
- v0.16.0
19251948
```
19261949

19271950
Run the `openmcp-bootstrapper` CLI tool to update the Git repository and deploy the crossplane service provider to the Shoot cluster.

0 commit comments

Comments
 (0)