You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+61-17Lines changed: 61 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,42 +4,70 @@
4
4
5
5
## About this project
6
6
7
-
Service provider Crossplane manages the lifecycle of Crossplane instances.
7
+
Service provider Crossplane manages the lifecycle of Crossplane instances and Crossplane providers in a `ManagedControlPlane`.
8
8
9
-
## Installation of the Service Provider Crossplane
9
+
## 🏗️ Installation of the Service Provider Crossplane
10
10
11
11
### Local Development
12
+
To run the service-provider-crossplane locally, you need to first bootstrap an openMCP environment by using [openmcp-operator](https://github.com/openmcp-project/openmcp-operator) and [cluster-provider-kind](https://github.com/openmcp-project/cluster-provider-kind). A comprehensive guide will follow soon.
12
13
13
-
To install the serviceprovider Crossplane locally, you can use the following command:
14
+
For current testing reasons, the service-provider-crossplane needs to run in the cluster. To run the latest version of your changes in your local environment, you need to run:
14
15
15
16
```bash
16
-
TODO
17
+
task build:img:build
18
+
```
19
+
20
+
This will build the image of the service-provider-crossplane locally and puts it into your local Docker registry.
To build the image locally, you can use the following command:
92
+
To build the binary locally, you can use the following command:
65
93
66
94
```bash
67
95
task build
68
96
```
69
97
98
+
### Build the image locally
99
+
100
+
To build the image locally, you can use the following command:
101
+
102
+
```bash
103
+
task build:img:build
104
+
```
105
+
106
+
### Run unit tests locally
107
+
108
+
To run the unit tests locally, you can use the following command:
109
+
110
+
```bash
111
+
task test
112
+
```
113
+
70
114
### Generating the CRDs, DeepCopy functions etc.
71
115
To generate the CRDs, DeepCopy functions, and other boilerplate code, you can use the following command:
72
116
73
117
```bash
74
118
task generate
75
119
```
76
120
77
-
## Support, Feedback, Contributing
121
+
## ❤️ Support, Feedback, Contributing
78
122
79
123
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/openmcp-project/service-provider-crossplane/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
80
124
81
-
## Security / Disclosure
125
+
## 🔐 Security / Disclosure
82
126
If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/openmcp-project/service-provider-crossplane/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
83
127
84
-
## Code of Conduct
128
+
## 🤝 Code of Conduct
85
129
86
130
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/openmcp-project/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
87
131
88
-
## Licensing
132
+
## 📋 Licensing
89
133
90
134
Copyright 2025 SAP SE or an SAP affiliate company and service-provider-crossplane contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/openmcp-project/service-provider-crossplane).
0 commit comments